Choreonoid: cnoid::Seq< ElementType > Class Template Reference

Choreonoid 1.5

#include <Seq.h>

Inheritance diagram for cnoid::Seq< ElementType >:

Public Types
typedef boost::shared_ptr< SeqType >	Ptr

Public Member Functions
	Seq (const char *seqType, int nFrames=0.0)

	Seq (const SeqType &org)

SeqType &	operator= (const SeqType &rhs)

virtual AbstractSeq &	operator= (const AbstractSeq &rhs)

virtual AbstractSeqPtr	cloneSeq () const

virtual	~Seq ()

virtual double	getFrameRate () const

double	frameRate () const

virtual void	setFrameRate (double frameRate)

virtual int	getNumFrames () const

int	numFrames () const

virtual void	setNumFrames (int n, bool clearNewElements=false)

bool	empty () const

int	frameOfTime (double time) const

double	timeOfFrame (int frame) const

ElementType &	operator[] (int frameIndex)

const ElementType &	operator[] (int frameIndex) const

ElementType &	at (int frameIndex)

const ElementType &	at (int frameIndex) const

int	clampFrameIndex (int frameIndex, bool &out_isValidRange)

Public Member Functions inherited from cnoid::AbstractSeq
virtual	~AbstractSeq ()

void	copySeqProperties (const AbstractSeq &source)

const std::string &	seqType () const

double	getTimeStep () const

void	setTimeStep (double timeStep)

double	getTimeOfFrame (int frame)

virtual int	getOffsetTimeFrame () const

double	getOffsetTime () const

void	setTimeLength (double length, bool clearNewElements=false)

double	getTimeLength () const

const std::string &	seqContentName ()

virtual void	setSeqContentName (const std::string &content)

bool	readSeq (const Mapping &archive)

bool	writeSeq (YAMLWriter &writer)

const std::string &	seqMessage () const

Protected Member Functions
virtual ElementType	defaultValue () const

Protected Member Functions inherited from cnoid::AbstractSeq
	AbstractSeq (const char *seqType)

	AbstractSeq (const AbstractSeq &org)

virtual bool	doReadSeq (const Mapping &archive)

virtual bool	doWriteSeq (YAMLWriter &writer)

bool	checkSeqContent (const Mapping &archive, const std::string contentName, bool throwEx=false)

void	clearSeqMessage ()

void	addSeqMessage (const std::string &message)

Protected Attributes
std::vector< ElementType >	container

double	frameRate_

Additional Inherited Members
Static Public Member Functions inherited from cnoid::AbstractSeq
static const double	defaultFrameRate ()

Member Typedef Documentation

§ Ptr

template<typename ElementType>

typedef boost::shared_ptr<SeqType> cnoid::Seq< ElementType >::Ptr

Constructor & Destructor Documentation

§ Seq() [1/2]

template<typename ElementType>

cnoid::Seq< ElementType >::Seq	(	const char *	seqType,
		int	nFrames = `0.0`
	)

inline

§ Seq() [2/2]

template<typename ElementType>

cnoid::Seq< ElementType >::Seq ( const SeqType & org )

inline

§ ~Seq()

template<typename ElementType>

virtual cnoid::Seq< ElementType >::~Seq ( )

inlinevirtual

Member Function Documentation

§ at() [1/2]

template<typename ElementType>

ElementType& cnoid::Seq< ElementType >::at ( int frameIndex )

inline

§ at() [2/2]

template<typename ElementType>

const ElementType& cnoid::Seq< ElementType >::at ( int frameIndex ) const

inline

§ clampFrameIndex()

template<typename ElementType>

int cnoid::Seq< ElementType >::clampFrameIndex	(	int	frameIndex,
		bool &	out_isValidRange
	)

inline

§ cloneSeq()

template<typename ElementType>

virtual AbstractSeqPtr cnoid::Seq< ElementType >::cloneSeq ( ) const

inlinevirtual

Implements cnoid::AbstractSeq.

Reimplemented in cnoid::ZMPSeq, and cnoid::Vector3Seq.

§ defaultValue()

template<typename ElementType>

virtual ElementType cnoid::Seq< ElementType >::defaultValue ( ) const

inlineprotectedvirtual

Reimplemented in cnoid::Vector3Seq.

§ empty()

template<typename ElementType>

bool cnoid::Seq< ElementType >::empty ( ) const

inline

§ frameOfTime()

template<typename ElementType>

int cnoid::Seq< ElementType >::frameOfTime ( double time ) const

inline

§ frameRate()

template<typename ElementType>

double cnoid::Seq< ElementType >::frameRate ( ) const

inline

§ getFrameRate()

template<typename ElementType>

virtual double cnoid::Seq< ElementType >::getFrameRate ( ) const

inlinevirtual

Implements cnoid::AbstractSeq.

§ getNumFrames()

template<typename ElementType>

virtual int cnoid::Seq< ElementType >::getNumFrames ( ) const

inlinevirtual

Implements cnoid::AbstractSeq.

§ numFrames()

template<typename ElementType>

int cnoid::Seq< ElementType >::numFrames ( ) const

inline

§ operator=() [1/2]

template<typename ElementType>

SeqType& cnoid::Seq< ElementType >::operator= ( const SeqType & rhs )

inline

§ operator=() [2/2]

template<typename ElementType>

virtual AbstractSeq& cnoid::Seq< ElementType >::operator= ( const AbstractSeq< ElementType > & rhs )

inlinevirtual

Reimplemented from cnoid::AbstractSeq.

Reimplemented in cnoid::ZMPSeq.

§ operator[]() [1/2]

template<typename ElementType>

ElementType& cnoid::Seq< ElementType >::operator[] ( int frameIndex )

inline

§ operator[]() [2/2]

template<typename ElementType>

const ElementType& cnoid::Seq< ElementType >::operator[] ( int frameIndex ) const

inline

§ setFrameRate()

template<typename ElementType>

virtual void cnoid::Seq< ElementType >::setFrameRate ( double frameRate )

inlinevirtual

Implements cnoid::AbstractSeq.

§ setNumFrames()

template<typename ElementType>

virtual void cnoid::Seq< ElementType >::setNumFrames	(	int	n,
		bool	clearNewElements = `false`
	)

inlinevirtual

Implements cnoid::AbstractSeq.

§ timeOfFrame()

template<typename ElementType>

double cnoid::Seq< ElementType >::timeOfFrame ( int frame ) const

inline

Member Data Documentation

§ container

template<typename ElementType>

std::vector<ElementType> cnoid::Seq< ElementType >::container

protected

§ frameRate_

template<typename ElementType>

double cnoid::Seq< ElementType >::frameRate_

protected

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

Seq.h