Track< ValueT > Class Template Reference

A track represents the timeline of a single value, identified by a track ID. More...

#include <RobotAPI/libraries/SimpleTrajectory/Track.h>

Classes
struct	KeyframeProxy
	A proxy allowing for adding keyframes by: track[time] = value; More...

Public Types
using	UpdateFunc = std::function<void(ValueT)>
	The update function type.

Public Member Functions
void	addKeyframe (const Keyframe< ValueT > &keyframe)
	Add a keyframe to this track.
void	addKeyframe (float time, const ValueT &value)
	Add a keyframe to this track.
ValueT	at (float time) const
	Get the interpolated value at the given time.
void	clear ()
	Clear the track of all keyframes.
bool	empty () const
	Indicate whether this track does not contain any keyframes.
KeyframeProxy	operator[] (float time)
	Add a keyframe by assignment: track[time] = value;
	Track (const TrackID &id)
	Construct a track with given ID (and no update function).
	Track (const TrackID &id, UpdateFunc updateFunc)
	Construct a track with given ID and update function.
void	update (float time, bool ignoreIfEmpty=false)
	Call the update function with the interpolated value at the given time.

Friends
template<typename V>
std::ostream &	operator<< (std::ostream &os, const Track< V > &track)

Detailed Description

template<typename ValueT>
class armarx::trajectory::Track< ValueT >

A track represents the timeline of a single value, identified by a track ID.

A track is comprised of a sequence of keyframes and used to call a single update function.

Member Typedef Documentation

UpdateFunc

template<typename ValueT>

using UpdateFunc = std::function<void(ValueT)>

The update function type.

Constructor & Destructor Documentation

Track() [1/2]

template<typename ValueT>

Track ( const TrackID & id )

inline

Construct a track with given ID (and no update function).

Track() [2/2]

template<typename ValueT>

Track ( const TrackID & id, UpdateFunc updateFunc )

inline

Construct a track with given ID and update function.

Member Function Documentation

addKeyframe() [1/2]

template<typename ValueT>

void addKeyframe

(

const Keyframe< ValueT > &

keyframe

)

Add a keyframe to this track.

addKeyframe() [2/2]

template<typename ValueT>

void addKeyframe	(	float	time,
		const ValueT &	value )

Add a keyframe to this track.

at()

template<typename V>

V at

(

float

time

)

const

Get the interpolated value at the given time.

Exceptions

`error::EmptyTrack`

If the track is empty.

clear()

template<typename V>

void clear

(

)

Clear the track of all keyframes.

empty()

template<typename V>

bool empty

(

)

const

Indicate whether this track does not contain any keyframes.

operator[]()

template<typename V>

auto operator[]

(

float

time

)

Add a keyframe by assignment: track[time] = value;

update()

template<typename V>

void update	(	float	time,
		bool	ignoreIfEmpty = false )

Call the update function with the interpolated value at the given time.

Parameters

ignoreIfEmpty

If true and the track is empty, the method does nothing.

Exceptions

`error::EmptyTrack`

If the track is empty and ignoreIfEmpty is false.

Friends And Related Symbol Documentation

operator<<

template<typename ValueT>

template<typename V>

std::ostream & operator<< ( std::ostream & os, const Track< V > & track )

friend

---

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

• RobotAPI/libraries/SimpleTrajectory/Track.h