cnoid::AbstractSeq Class Reference

#include <AbstractSeq.h>

Inheritance diagram for cnoid::AbstractSeq:

Public Member Functions
virtual	~AbstractSeq ()
virtual AbstractSeq &	operator= (const AbstractSeq &rhs)
virtual std::shared_ptr< AbstractSeq >	cloneSeq () const =0
void	copySeqProperties (const AbstractSeq &source)
const std::string &	seqType () const
virtual double	getFrameRate () const =0
virtual void	setFrameRate (double frameRate)=0
double	getTimeStep () const
void	setTimeStep (double timeStep)
double	getTimeOfFrame (int frame) const
int	getFrameOfTime (double time) const
virtual double	getOffsetTime () const =0
virtual void	setOffsetTime (double time)=0
int	getOffsetTimeFrame () const
virtual int	getNumFrames () const =0
virtual void	setNumFrames (int n, bool clearNewElements=false)=0
void	setTimeLength (double length, bool clearNewElements=false)
double	getTimeLength () const
const std::string &	seqContentName ()
virtual void	setSeqContentName (const std::string &name)
bool	readSeq (const Mapping *archive, std::ostream &os=nullout())
bool	writeSeq (YAMLWriter &writer)
const std::string &	seqMessage () const
	deprecated. Use the os parameter of readSeq to get messages in reading More...

Static Public Member Functions
static double	defaultFrameRate ()

Protected Member Functions
	AbstractSeq (const char *seqType)
	AbstractSeq (const AbstractSeq &org)
void	setSeqType (const std::string &type)
virtual bool	doReadSeq (const Mapping *archive, std::ostream &os)
virtual bool	doWriteSeq (YAMLWriter &writer, std::function< void()> additionalPartCallback)
void	clearSeqMessage ()
	deprecated. Use the os parameter of readSeq to get messages in reading More...
void	addSeqMessage (const std::string &message)
	deprecated. Use the os parameter of readSeq to get messages in reading More...

Constructor & Destructor Documentation

AbstractSeq() [1/2]

AbstractSeq::AbstractSeq ( const char *  seqType )

protected

AbstractSeq() [2/2]

AbstractSeq::AbstractSeq ( const AbstractSeq &  org )

protected

~AbstractSeq()

AbstractSeq::~AbstractSeq ( )

virtual

Member Function Documentation

addSeqMessage()

void cnoid::AbstractSeq::addSeqMessage ( const std::string &  message )

inlineprotected

deprecated. Use the os parameter of readSeq to get messages in reading

clearSeqMessage()

void cnoid::AbstractSeq::clearSeqMessage ( )

inlineprotected

deprecated. Use the os parameter of readSeq to get messages in reading

cloneSeq()

virtual std::shared_ptr<AbstractSeq> cnoid::AbstractSeq::cloneSeq ( ) const

pure virtual

Implemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::Seq< ElementType >, cnoid::MultiSE3Seq, cnoid::MultiSE3MatrixSeq, cnoid::MultiDeviceStateSeq, cnoid::MultiVector3Seq, cnoid::BodyMotion, cnoid::Vector3Seq, cnoid::ZMPSeq, cnoid::MultiValueSeq, cnoid::ReferencedObjectSeq, and cnoid::AbstractMultiSeq.

copySeqProperties()

void AbstractSeq::copySeqProperties

(

const AbstractSeq &

source

)

defaultFrameRate()

double AbstractSeq::defaultFrameRate ( )

static

doReadSeq()

bool AbstractSeq::doReadSeq ( const Mapping *  archive, std::ostream &  os  )

protectedvirtual

Reimplemented in cnoid::BodyMotion, cnoid::MultiSE3Seq, cnoid::CollisionSeq, cnoid::Vector3Seq, cnoid::MultiVector3Seq, cnoid::ZMPSeq, and cnoid::MultiValueSeq.

doWriteSeq()

bool AbstractSeq::doWriteSeq ( YAMLWriter &  writer, std::function< void()>  additionalPartCallback  )

protectedvirtual

Reimplemented in cnoid::Vector3Seq, cnoid::MultiValueSeq, cnoid::BodyMotion, cnoid::MultiSE3Seq, cnoid::MultiDeviceStateSeq, cnoid::CollisionSeq, cnoid::MultiVector3Seq, cnoid::ZMPSeq, and cnoid::AbstractMultiSeq.

getFrameOfTime()

int AbstractSeq::getFrameOfTime

(

double

time

)

const

getFrameRate()

virtual double cnoid::AbstractSeq::getFrameRate ( ) const

pure virtual

Implemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::Seq< ElementType >, and cnoid::BodyMotion.

getNumFrames()

virtual int cnoid::AbstractSeq::getNumFrames ( ) const

pure virtual

Implemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::Seq< ElementType >, and cnoid::BodyMotion.

getOffsetTime()

virtual double cnoid::AbstractSeq::getOffsetTime ( ) const

pure virtual

Implemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::Seq< ElementType >, and cnoid::BodyMotion.

getOffsetTimeFrame()

int AbstractSeq::getOffsetTimeFrame

(

)

const

getTimeLength()

double AbstractSeq::getTimeLength

(

)

const

This function returns the duration of the sequence.

Note

Valid data exists for time less than this time. You must not access to the frame corresponding to this time because there is no data at the time.

getTimeOfFrame()

double AbstractSeq::getTimeOfFrame

(

int

frame

)

const

getTimeStep()

double AbstractSeq::getTimeStep

(

)

const

operator=()

AbstractSeq & AbstractSeq::operator= ( const AbstractSeq &  rhs )

virtual

Reimplemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::MultiSeq< DeviceStatePtr >, cnoid::MultiSeq< SE3, Eigen::aligned_allocator< SE3 > >, cnoid::MultiSeq< double >, cnoid::MultiSeq< Isometry3, Eigen::aligned_allocator< Isometry3 > >, cnoid::MultiSeq< Vector3, Eigen::aligned_allocator< Vector3 > >, cnoid::MultiSeq< std::shared_ptr< CollisionLinkPairList > >, cnoid::Seq< ElementType >, cnoid::Seq< ReferencedPtr >, cnoid::Seq< Vector3 >, and cnoid::ZMPSeq.

readSeq()

bool AbstractSeq::readSeq	(	const Mapping *	archive,
		std::ostream &	os = nullout()
	)

seqContentName()

const std::string& cnoid::AbstractSeq::seqContentName ( )

inline

seqMessage()

const std::string & AbstractSeq::seqMessage

(

)

const

deprecated. Use the os parameter of readSeq to get messages in reading

seqType()

const std::string& cnoid::AbstractSeq::seqType ( ) const

inline

setFrameRate()

virtual void cnoid::AbstractSeq::setFrameRate ( double  frameRate )

pure virtual

Implemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::MultiSeq< DeviceStatePtr >, cnoid::MultiSeq< SE3, Eigen::aligned_allocator< SE3 > >, cnoid::MultiSeq< double >, cnoid::MultiSeq< Isometry3, Eigen::aligned_allocator< Isometry3 > >, cnoid::MultiSeq< Vector3, Eigen::aligned_allocator< Vector3 > >, cnoid::MultiSeq< std::shared_ptr< CollisionLinkPairList > >, cnoid::Seq< ElementType >, cnoid::Seq< ReferencedPtr >, cnoid::Seq< Vector3 >, and cnoid::BodyMotion.

setNumFrames()

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

pure virtual

Implemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::MultiSeq< DeviceStatePtr >, cnoid::MultiSeq< SE3, Eigen::aligned_allocator< SE3 > >, cnoid::MultiSeq< double >, cnoid::MultiSeq< Isometry3, Eigen::aligned_allocator< Isometry3 > >, cnoid::MultiSeq< Vector3, Eigen::aligned_allocator< Vector3 > >, cnoid::MultiSeq< std::shared_ptr< CollisionLinkPairList > >, cnoid::Seq< ElementType >, cnoid::Seq< ReferencedPtr >, cnoid::Seq< Vector3 >, and cnoid::BodyMotion.

setOffsetTime()

virtual void cnoid::AbstractSeq::setOffsetTime ( double  time )

pure virtual

Implemented in cnoid::MultiSeq< ElementType, Allocator >, cnoid::MultiSeq< DeviceStatePtr >, cnoid::MultiSeq< SE3, Eigen::aligned_allocator< SE3 > >, cnoid::MultiSeq< double >, cnoid::MultiSeq< Isometry3, Eigen::aligned_allocator< Isometry3 > >, cnoid::MultiSeq< Vector3, Eigen::aligned_allocator< Vector3 > >, cnoid::MultiSeq< std::shared_ptr< CollisionLinkPairList > >, cnoid::Seq< ElementType >, cnoid::Seq< ReferencedPtr >, cnoid::Seq< Vector3 >, and cnoid::BodyMotion.

setSeqContentName()

void AbstractSeq::setSeqContentName ( const std::string &  name )

virtual

setSeqType()

void AbstractSeq::setSeqType ( const std::string &  type )

protected

setTimeLength()

void cnoid::AbstractSeq::setTimeLength ( double  length, bool  clearNewElements = false  )

inline

setTimeStep()

void AbstractSeq::setTimeStep

(

double

timeStep

)

writeSeq()

bool AbstractSeq::writeSeq

(

YAMLWriter &

writer

)

---

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

• AbstractSeq.h
• AbstractSeq.cpp