Package com.viam.common.v1

Class Common

java.lang.Object

com.viam.common.v1.Common

public final class Common
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Common.ActuatorStatus	ActuatorStatus is a generic status for resources that only need to return actuator status.
static interface	Common.ActuatorStatusOrBuilder
static final class	Common.Capsule	Protobuf type viam.common.v1.Capsule
static interface	Common.CapsuleOrBuilder
static final class	Common.DoCommandRequest	DoCommandRequest represents a generic DoCommand input
static interface	Common.DoCommandRequestOrBuilder
static final class	Common.DoCommandResponse	DoCommandResponse represents a generic DoCommand output
static interface	Common.DoCommandResponseOrBuilder
static final class	Common.GeoGeometry	GeoGeometry contains information describing Geometry(s) that is located at a GeoPoint
static interface	Common.GeoGeometryOrBuilder
static final class	Common.GeometriesInFrame	GeometriesinFrame contains the dimensions of a given geometry, pose of its center point, and the reference frame by which it was observed.
static interface	Common.GeometriesInFrameOrBuilder
static final class	Common.Geometry	Geometry contains the dimensions of a given geometry and the pose of its center.
static interface	Common.GeometryOrBuilder
static final class	Common.GeoPoint	Protobuf type viam.common.v1.GeoPoint
static interface	Common.GeoPointOrBuilder
static final class	Common.GetGeometriesRequest	Protobuf type viam.common.v1.GetGeometriesRequest
static interface	Common.GetGeometriesRequestOrBuilder
static final class	Common.GetGeometriesResponse	Protobuf type viam.common.v1.GetGeometriesResponse
static interface	Common.GetGeometriesResponseOrBuilder
static final class	Common.GetKinematicsRequest	Protobuf type viam.common.v1.GetKinematicsRequest
static interface	Common.GetKinematicsRequestOrBuilder
static final class	Common.GetKinematicsResponse	Protobuf type viam.common.v1.GetKinematicsResponse
static interface	Common.GetKinematicsResponseOrBuilder
static final class	Common.GetReadingsRequest	Protobuf type viam.common.v1.GetReadingsRequest
static interface	Common.GetReadingsRequestOrBuilder
static final class	Common.GetReadingsResponse	Protobuf type viam.common.v1.GetReadingsResponse
static interface	Common.GetReadingsResponseOrBuilder
static enum	Common.KinematicsFileFormat	Protobuf enum viam.common.v1.KinematicsFileFormat
static final class	Common.LogEntry	Protobuf type viam.common.v1.LogEntry
static interface	Common.LogEntryOrBuilder
static final class	Common.Orientation	Protobuf type viam.common.v1.Orientation
static interface	Common.OrientationOrBuilder
static final class	Common.PointCloudObject	PointCloudObject contains an image in bytes with point cloud data of all of the objects captured by a given observer as well as a repeated list of geometries which respresents the center point and geometry of each of the objects within the point cloud
static interface	Common.PointCloudObjectOrBuilder
static final class	Common.Pose	Pose is a combination of location and orientation.
static final class	Common.PoseInFrame	PoseInFrame contains a pose and the and the reference frame in which it was observed
static interface	Common.PoseInFrameOrBuilder
static interface	Common.PoseOrBuilder
static final class	Common.RectangularPrism	RectangularPrism contains a Vector3 field corresponding to the X, Y, Z dimensions of the prism in mms These dimensions are with respect to the referenceframe in which the RectangularPrism is defined
static interface	Common.RectangularPrismOrBuilder
static final class	Common.ResourceName	Protobuf type viam.common.v1.ResourceName
static interface	Common.ResourceNameOrBuilder
static final class	Common.ResponseMetadata	Protobuf type viam.common.v1.ResponseMetadata
static interface	Common.ResponseMetadataOrBuilder
static final class	Common.Sphere	Protobuf type viam.common.v1.Sphere
static interface	Common.SphereOrBuilder
static final class	Common.Transform	Transform contains a pose and two reference frames.
static interface	Common.TransformOrBuilder
static final class	Common.Vector3	Protobuf type viam.common.v1.Vector3
static interface	Common.Vector3OrBuilder
static final class	Common.WorldState	WorldState contains information about the physical environment around a given robot.
static interface	Common.WorldStateOrBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SAFETY_HEARTBEAT_MONITORED_FIELD_NUMBER
static final com.google.protobuf.GeneratedMessageLite.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,Boolean>	safetyHeartbeatMonitored	safety_heartbeat_monitored is used on methods to signify that if a session is in use and the session was the last to call this method, the resource associated with the method will be stopped.

Method Summary

Modifier and Type	Method	Description
static void	registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SAFETY_HEARTBEAT_MONITORED_FIELD_NUMBER

public static final int SAFETY_HEARTBEAT_MONITORED_FIELD_NUMBER

See Also:

• Constant Field Values

safetyHeartbeatMonitored

public static final com.google.protobuf.GeneratedMessageLite.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,Boolean> safetyHeartbeatMonitored

 safety_heartbeat_monitored is used on methods to signify that if a session is in use
 and the session was the last to call this method, the resource associated with the
 method will be stopped.
 

extend .google.protobuf.MethodOptions { ... }

Method Details

registerAllExtensions

public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)