Choreonoid  1.8
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cnoid::AbstractSeq Class Referenceabstract

#include <AbstractSeq.h>

Inheritance diagram for cnoid::AbstractSeq:
cnoid::AbstractMultiSeq cnoid::BodyMotion cnoid::Seq< ElementType > cnoid::Seq< ReferencedPtr > cnoid::Seq< Vector3 > cnoid::MultiSeq< ElementType, Allocator > cnoid::MultiSeq< DeviceStatePtr > cnoid::MultiSeq< double > cnoid::MultiSeq< Isometry3, Eigen::aligned_allocator< Isometry3 > > cnoid::MultiSeq< SE3, Eigen::aligned_allocator< SE3 > > cnoid::MultiSeq< std::shared_ptr< CollisionLinkPairList > > cnoid::MultiSeq< Vector3, Eigen::aligned_allocator< Vector3 > > cnoid::ReferencedObjectSeq cnoid::Vector3Seq

Public Member Functions

virtual ~AbstractSeq ()
virtual AbstractSeqoperator= (const AbstractSeq &rhs)
virtual std::shared_ptr< AbstractSeqcloneSeq () 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)

◆ AbstractSeq() [2/2]

AbstractSeq::AbstractSeq ( const AbstractSeq org)

◆ ~AbstractSeq()

AbstractSeq::~AbstractSeq ( )

Member Function Documentation

◆ addSeqMessage()

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

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

◆ clearSeqMessage()

void cnoid::AbstractSeq::clearSeqMessage ( )

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

◆ cloneSeq()

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

◆ copySeqProperties()

void AbstractSeq::copySeqProperties ( const AbstractSeq source)

◆ defaultFrameRate()

double AbstractSeq::defaultFrameRate ( )

◆ doReadSeq()

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

◆ doWriteSeq()

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

◆ getFrameOfTime()

int AbstractSeq::getFrameOfTime ( double  time) const

◆ getFrameRate()

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

◆ getNumFrames()

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

◆ getOffsetTime()

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

◆ getOffsetTimeFrame()

int AbstractSeq::getOffsetTimeFrame ( ) const

◆ getTimeLength()

double AbstractSeq::getTimeLength ( ) const

This function returns the duration of the sequence.

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)

◆ readSeq()

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

◆ seqContentName()

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

◆ 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

◆ setFrameRate()

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

◆ setNumFrames()

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

◆ setOffsetTime()

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

◆ setSeqContentName()

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

◆ setSeqType()

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

◆ setTimeLength()

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

◆ setTimeStep()

void AbstractSeq::setTimeStep ( double  timeStep)

◆ writeSeq()

bool AbstractSeq::writeSeq ( YAMLWriter writer)

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