gams::pose::Stamped< Base > Class Template Reference

Internal class implementing coordinates stamped with timestamp. More...

#include <Stamped.h>

Inheritance diagram for gams::pose::Stamped< Base >:

Public Types
using	derived_type = typename Base::derived_type

Public Member Functions
	Stamped ()=default
	Default Constructor. More...
template<typename... Args>
	Stamped (Args &&...args)
	Construct without a TimeStamp object. More...
	Stamped (TimeValue time)
	Construct using a TimeValue object. More...
template<typename... Args>
	Stamped (TimeValue time, Args &&...args)
	Construct with a timestamp. More...
uint64_t	nanos () const
	Get time as nanos since std::steady_clock epoch. More...
uint64_t	nanos (uint64_t v)
	Set time as nanos since std::steady_clock epoch. More...
double	secs () const
	Get time as seconds since std::steady_clock epoch. More...
double	secs (double v)
	Set time as seconds since std::steady_clock epoch. More...
TimeValue	time () const
	Get time as std::chrono based TimeValue. More...
TimeValue	time (TimeValue v)
	Set time from std::chrono based TimeValue. More...

Private Attributes
TimeValue	time_

Detailed Description

template<typename Base>
class gams::pose::Stamped< Base >

Internal class implementing coordinates stamped with timestamp.

Do not use directly.

Definition at line 102 of file Stamped.h.

Member Typedef Documentation

template<typename Base>

using gams::pose::Stamped< Base >::derived_type = typename Base::derived_type

Definition at line 107 of file Stamped.h.

Constructor & Destructor Documentation

template<typename Base>

gams::pose::Stamped< Base >::Stamped ( )

default

Default Constructor.

Initializes timestamp to zero

template<typename Base>

template<typename... Args>

gams::pose::Stamped< Base >::Stamped

(

Args &&...

args

)

Construct without a TimeStamp object.

Initializes time as zero, unless at least one argument is a type which includes a timestamp, in which case that time will become the stamp of this pose. If multiple do, the first such argument will be used.

This overload only participates if the first argument isn't TimeValue

Parameters

args	arguments to pass through to base type

template<typename Base>

gams::pose::Stamped< Base >::Stamped ( TimeValue  time )

inlineexplicit

Construct using a TimeValue object.

Parameters

time	the time to stamp with

Definition at line 147 of file Stamped.h.

template<typename Base>

template<typename... Args>

gams::pose::Stamped< Base >::Stamped	(	TimeValue	time,
		Args &&...	args
	)

Construct with a timestamp.

Parameters

time	the timestamp to use
args	arguments to pass through to base constructor

Member Function Documentation

template<typename Base>

uint64_t gams::pose::Stamped< Base >::nanos ( ) const

inline

Get time as nanos since std::steady_clock epoch.

Definition at line 174 of file Stamped.h.

template<typename Base>

uint64_t gams::pose::Stamped< Base >::nanos ( uint64_t  v )

inline

Set time as nanos since std::steady_clock epoch.

Definition at line 181 of file Stamped.h.

template<typename Base>

double gams::pose::Stamped< Base >::secs ( ) const

inline

Get time as seconds since std::steady_clock epoch.

Definition at line 188 of file Stamped.h.

template<typename Base>

double gams::pose::Stamped< Base >::secs ( double  v )

inline

Set time as seconds since std::steady_clock epoch.

Definition at line 195 of file Stamped.h.

template<typename Base>

TimeValue gams::pose::Stamped< Base >::time ( ) const

inline

Get time as std::chrono based TimeValue.

Definition at line 167 of file Stamped.h.

template<typename Base>

TimeValue gams::pose::Stamped< Base >::time ( TimeValue  v )

inline

Set time from std::chrono based TimeValue.

Returns

the new time

Definition at line 171 of file Stamped.h.

Member Data Documentation

template<typename Base>

TimeValue gams::pose::Stamped< Base >::time_

private

Definition at line 204 of file Stamped.h.

---

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

• src/gams/pose/Stamped.h