framesystem

package
v0.23.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2024 License: AGPL-3.0 Imports: 12 Imported by: 1

Documentation

Overview

Package framesystem defines the frame system service which is responsible for managing a stateful frame system

Index

Constants

View Source
const LocalFrameSystemName = "robot"

LocalFrameSystemName is the default name of the frame system created by the service.

View Source
const SubtypeName = "frame_system"

SubtypeName is a constant that identifies the internal frame system resource subtype string.

Variables

API is the fully qualified API for the internal frame system service.

View Source
var InternalServiceName = resource.NewName(API, "builtin")

InternalServiceName is used to refer to/depend on this service internally.

Functions

func DependencyNotFoundError added in v0.2.47

func DependencyNotFoundError(name string) error

DependencyNotFoundError returns an error if the given dependency name could not be found when building the framesystem.

func DuplicateResourceShortNameError added in v0.2.47

func DuplicateResourceShortNameError(name string) error

DuplicateResourceShortNameError returns an error if mutiple components are attempted to be registered in the frame system which share a short name.

func NotInputEnabledError added in v0.2.47

func NotInputEnabledError(component resource.Resource) error

NotInputEnabledError is returned when the given component is not InputEnabled but should be.

func PrefixRemoteParts added in v0.2.47

func PrefixRemoteParts(parts []*referenceframe.FrameSystemPart, remoteName, remoteParent string)

PrefixRemoteParts applies prefixes to a list of FrameSystemParts appropriate to the remote they originate from.

Types

type Config added in v0.2.47

type Config struct {
	resource.TriviallyValidateConfig
	Parts                []*referenceframe.FrameSystemPart
	AdditionalTransforms []*referenceframe.LinkInFrame
}

Config is a slice of *config.FrameSystemPart.

func (Config) String added in v0.2.47

func (cfg Config) String() string

String prints out a table of each frame in the system, with columns of name, parent, translation and orientation.

type Service

type Service interface {
	resource.Resource
	TransformPose(
		ctx context.Context,
		pose *referenceframe.PoseInFrame,
		dst string,
		additionalTransforms []*referenceframe.LinkInFrame,
	) (*referenceframe.PoseInFrame, error)
	TransformPointCloud(ctx context.Context, srcpc pointcloud.PointCloud, srcName, dstName string) (pointcloud.PointCloud, error)
	CurrentInputs(ctx context.Context) (map[string][]referenceframe.Input, map[string]referenceframe.InputEnabled, error)
	FrameSystem(ctx context.Context, additionalTransforms []*referenceframe.LinkInFrame) (referenceframe.FrameSystem, error)
}

A Service that returns the frame system for a robot.

func FromDependencies added in v0.2.47

func FromDependencies(deps resource.Dependencies) (Service, error)

FromDependencies is a helper for getting the framesystem from a collection of dependencies.

func New

func New(ctx context.Context, deps resource.Dependencies, logger logging.Logger) (Service, error)

New returns a new frame system service for the given robot.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL