API Documentation

TransformDescriptor

This class describes a PolySync transformation.

TransformDescriptor::TransformDescriptor ( )

A default constructor.

TransformDescriptor::TransformDescriptor ( … )

A copy constructor.

Parameters
in/out type description
in const TransformDescriptor & Instance being copied.

TransformDescriptor::TransformDescriptor ( … )

A convenience constructor from a related type.

Parameters
in/out type description
in const ps_transform_descriptor & Instance of related type.

TransformDescriptor::~TransformDescriptor ( )

A default destructor.

TransformDescriptor::print ( … )

This will print internal values.

Parameters
in/out type description
in std::ostream & Output stream that defaults to std::cout.
Returns
  • void

TransformDescriptor::get_ps_transform_descriptor ( ) const

This will provide convenient access a related type.

Returns

TransformDescriptor::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const TransformDescriptor & Instance to copy.
Returns

TransformDescriptor::getId ( ) const

This will get the coordinate frame identifier.

Returns

TransformDescriptor::getTimestamp ( ) const

This will get the last updated timestamp.

Returns

TransformDescriptor::getOrigin ( ) const

This will get the origin position vector [xyz meters].

Returns
  • std::array< double, 3 >
Returns

TransformDescriptor::getOrientation ( ) const

This will get the orientation quaternion [xyzw quaternion].

Returns
  • std::array< double, 4 >

TransformDescriptor::setId ( … )

This will set the coordinate frame identifier.

Parameters
in/out type description
in ps_identifier Coordinate frame identifier.
Returns
  • void

TransformDescriptor::setTimestamp ( … )

This will set the last updated timestamp.

Parameters
in/out type description
in ps_timestamp Last update timestamp.
Returns
  • void

TransformDescriptor::setOrigin ( … )

This will set the origin position vector [xyz meters].

Parameters
in/out type description
in const std::array< double, 3 > & The set position vector.
Returns
  • void

TransformDescriptor::setOrientation ( … )

This will set the orientation quaternion [xyzw quaternion].

Parameters
in/out type description
in const std::array< double, 4 > & The set orientation quaternion.
Returns
  • void