Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Stg::Pose Class Reference

#include <stage.hh>

Inheritance diagram for Stg::Pose:
Inheritance graph
[legend]

Public Member Functions

meters_t Distance (const Pose &other) const
 
bool IsZero () const
 
PoseLoad (Worldfile *wf, int section, const char *keyword)
 
bool operator!= (const Pose &other) const
 
Pose operator+ (const Pose &p) const
 
bool operator< (const Pose &p) const
 a < b iff a is closer to the origin than b More...
 
bool operator== (const Pose &other) const
 
 Pose (meters_t x, meters_t y, meters_t z, radians_t a)
 
 Pose ()
 
virtual void Print (const char *prefix) const
 
void Save (Worldfile *wf, int section, const char *keyword)
 
std::string String () const
 
void Zero ()
 
virtual ~Pose ()
 

Static Public Member Functions

static Pose Random (meters_t xmin, meters_t xmax, meters_t ymin, meters_t ymax)
 

Public Attributes

radians_t a
 rotation about the z axis. More...
 
meters_t x
 
meters_t y
 
meters_t z
 location in 3 axes More...
 

Detailed Description

Specify a 3 axis position, in x, y and heading.

Definition at line 257 of file stage.hh.

Constructor & Destructor Documentation

◆ Pose() [1/2]

Stg::Pose::Pose ( meters_t  x,
meters_t  y,
meters_t  z,
radians_t  a 
)
inline

Definition at line 262 of file stage.hh.

◆ Pose() [2/2]

Stg::Pose::Pose ( )
inline

Definition at line 264 of file stage.hh.

◆ ~Pose()

virtual Stg::Pose::~Pose ( )
inlinevirtual

Definition at line 266 of file stage.hh.

Member Function Documentation

◆ Distance()

meters_t Stg::Pose::Distance ( const Pose other) const
inline

Definition at line 324 of file stage.hh.

◆ IsZero()

bool Stg::Pose::IsZero ( ) const
inline

Returns true iff all components of the velocity are zero.

Definition at line 291 of file stage.hh.

◆ Load()

Pose & Pose::Load ( Worldfile wf,
int  section,
const char *  keyword 
)

Definition at line 175 of file model.cc.

◆ operator!=()

bool Stg::Pose::operator!= ( const Pose other) const
inline

Definition at line 319 of file stage.hh.

◆ operator+()

Pose Stg::Pose::operator+ ( const Pose p) const
inline

Definition at line 297 of file stage.hh.

◆ operator<()

bool Stg::Pose::operator< ( const Pose p) const
inline

a < b iff a is closer to the origin than b

Definition at line 307 of file stage.hh.

◆ operator==()

bool Stg::Pose::operator== ( const Pose other) const
inline

Definition at line 314 of file stage.hh.

◆ Print()

virtual void Stg::Pose::Print ( const char *  prefix) const
inlinevirtual

Print pose in human-readable format on stdout

Parameters
prefixCharacter string to prepend to pose output

Reimplemented in Stg::Velocity.

Definition at line 278 of file stage.hh.

◆ Random()

static Pose Stg::Pose::Random ( meters_t  xmin,
meters_t  xmax,
meters_t  ymin,
meters_t  ymax 
)
inlinestatic

return a random pose within the bounding rectangle, with z=0 and angle random

Definition at line 269 of file stage.hh.

◆ Save()

void Pose::Save ( Worldfile wf,
int  section,
const char *  keyword 
)

Definition at line 182 of file model.cc.

◆ String()

std::string Stg::Pose::String ( ) const
inline

Definition at line 283 of file stage.hh.

◆ Zero()

void Stg::Pose::Zero ( )
inline

Set the pose to zero [0,0,0,0]

Definition at line 293 of file stage.hh.

Member Data Documentation

◆ a

radians_t Stg::Pose::a

rotation about the z axis.

Definition at line 260 of file stage.hh.

◆ x

meters_t Stg::Pose::x

Definition at line 259 of file stage.hh.

◆ y

meters_t Stg::Pose::y

Definition at line 259 of file stage.hh.

◆ z

meters_t Stg::Pose::z

location in 3 axes

Definition at line 259 of file stage.hh.


The documentation for this class was generated from the following files:


stage
Author(s): Richard Vaughan , Brian Gerkey , Reed Hedges , Andrew Howard , Toby Collett , Pooya Karimian , Jeremy Asher , Alex Couture-Beil , Geoff Biggs , Rich Mattes , Abbas Sadat
autogenerated on Mon Feb 28 2022 23:48:56