framesystemparts

Documentation

Overview

Package framesystemparts provides functionality around a list of framesystem parts

Index

• func Names(parts Parts) []string
• func NewMissingParentError(partName, parentName string) error
• type Parts
  • func PartMapToPartSlice(partsMap map[string]*config.FrameSystemPart) Parts
  • func RenameRemoteParts(remoteParts Parts, remoteName string, remotePrefix bool, connectionName string) Parts
  • func TopologicallySort(parts Parts) (Parts, error)
  • func (fsp Parts) String() string

Functions

func Names

func Names(parts Parts) []string

Names returns the names of input parts.

func NewMissingParentError

func NewMissingParentError(partName, parentName string) error

NewMissingParentError returns an error for when a part has named a parent whose part is missing from the collection of FrameSystemParts that are undergoing topological sorting.

Types

type Parts

type Parts []*config.FrameSystemPart

Parts is a slice of *config.FrameSystemPart.

func PartMapToPartSlice

func PartMapToPartSlice(partsMap map[string]*config.FrameSystemPart) Parts

PartMapToPartSlice returns a Parts constructed of the FrameSystemParts values of a string map.

func RenameRemoteParts

func RenameRemoteParts(
	remoteParts Parts,
	remoteName string,
	remotePrefix bool,
	connectionName string,
) Parts

RenameRemoteParts applies prefixes to frame information if necessary.

func TopologicallySort

func TopologicallySort(parts Parts) (Parts, error)

TopologicallySort takes a potentially un-ordered slice of frame system parts and sorts them, beginning at the world node.

func (Parts) String

func (fsp Parts) String() string

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