TransformResult Struct Reference

#include <RobotAPI/libraries/armem_robot_state/common/localization/types.h>

Public Types

enum class  Status {
  Success , Error , ErrorExtrapolationTooLarge , ErrorFrameNotAvailable ,
  ErrorTimeSpreadTooLarge , ErrorPoseGapTooLarge , ErrorLookupIntoFuture
}
 

Public Member Functions

 operator bool () const
 

Public Attributes

std::string errorMessage = ""
 
TransformLinkTimes linkTimes = {}
 Times the links of the chain were evaluated at. Set on success; invalid otherwise.
 
enum armarx::armem::robot_state::localization::TransformResult::Status status
 
::armarx::armem::robot_state::localization::Transform transform
 On success, transform.header.timestamp is the time the result is valid for (TransformLinkTimes::newest).
 

Member Enumeration Documentation

◆ Status

enum class Status
strong
Enumerator
Success 
Error 
ErrorExtrapolationTooLarge 

A link would be evaluated further past its newest pose than allowed (TransformLimits::maxExtrapolation).

ErrorFrameNotAvailable 
ErrorTimeSpreadTooLarge 
ErrorPoseGapTooLarge 
ErrorLookupIntoFuture 

Old name of ErrorExtrapolationTooLarge, with the same value.

Replace it rather than handling both: a switch with a case for each does not compile (duplicate case value).

Member Function Documentation

◆ operator bool()

operator bool ( ) const
inlineexplicit

Member Data Documentation

◆ errorMessage

std::string errorMessage = ""

◆ linkTimes

TransformLinkTimes linkTimes = {}

Times the links of the chain were evaluated at. Set on success; invalid otherwise.

◆ status

◆ transform

On success, transform.header.timestamp is the time the result is valid for (TransformLinkTimes::newest).


The documentation for this struct was generated from the following file: