Choreonoid  1.8
Public Member Functions | Protected Member Functions | List of all members
cnoid::MultiValueSeq Class Reference

#include <MultiValueSeq.h>

Inheritance diagram for cnoid::MultiValueSeq:
cnoid::MultiSeq< double > cnoid::Deque2D< double, std::allocator< double > > cnoid::AbstractMultiSeq cnoid::AbstractSeq

Public Member Functions

 MultiValueSeq ()
 
 MultiValueSeq (int numFrames, int numParts=1)
 
 MultiValueSeq (const MultiValueSeq &org)
 
virtual ~MultiValueSeq ()
 
virtual std::shared_ptr< AbstractSeqcloneSeq () const override
 
bool loadPlainFormat (const std::string &filename, std::ostream &os=nullout())
 
bool saveAsPlainFormat (const std::string &filename, std::ostream &os=nullout())
 
- Public Member Functions inherited from cnoid::MultiSeq< double >
 MultiSeq (const char *seqType)
 
 MultiSeq (const char *seqType, int numFrames, int numParts)
 
 MultiSeq (const MultiSeqType &org)
 
virtual ~MultiSeq ()
 
MultiSeqTypeoperator= (const MultiSeqType &rhs)
 
virtual AbstractSeqoperator= (const AbstractSeq &rhs) override
 
virtual std::shared_ptr< AbstractSeqcloneSeq () const override
 
void copySeqProperties (const MultiSeqType &source)
 
virtual void setDimension (int newNumFrames, int newNumParts, bool fillNewElements=false) override
 
virtual double getFrameRate () const override
 
double frameRate () const
 
virtual void setFrameRate (double frameRate) override
 
const double timeStep () const
 
virtual void setNumParts (int newNumParts, bool fillNewElements=false) override
 
int numFrames () const
 
virtual int getNumFrames () const override
 
virtual void setNumFrames (int newNumFrames, bool fillNewElements=false) override
 
void clearFrames ()
 
virtual int getNumParts () const override
 
int numParts () const
 
double timeLength () const
 
int frameOfTime (double time) const
 
double timeOfFrame (int frame) const
 
double offsetTime () const
 
virtual double getOffsetTime () const override
 
virtual void setOffsetTime (double time) override
 
int offsetTimeFrame () const
 
void setOffsetTimeFrame (int offset)
 
const Part part (int index) const
 
Part part (int index)
 
Frame frame (int index)
 
const Frame frame (int index) const
 
void popFrontFrame ()
 
Frame appendFrame ()
 
int clampFrameIndex (int frameIndex)
 
- Public Member Functions inherited from cnoid::AbstractMultiSeq
 AbstractMultiSeq (const char *seqType)
 
 AbstractMultiSeq (const AbstractMultiSeq &org)
 
virtual ~AbstractMultiSeq ()
 
AbstractMultiSeqoperator= (const AbstractMultiSeq &rhs)
 
void copySeqProperties (const AbstractMultiSeq &source)
 
virtual int getNumParts () const =0
 
virtual int partIndex (const std::string &partLabel) const
 
virtual const std::string & partLabel (int partIndex) const
 
virtual AbstractSeqoperator= (const AbstractSeq &rhs)
 
- Public Member Functions inherited from cnoid::AbstractSeq
virtual ~AbstractSeq ()
 
void copySeqProperties (const AbstractSeq &source)
 
const std::string & seqType () const
 
virtual double getFrameRate () const =0
 
double getTimeStep () const
 
void setTimeStep (double timeStep)
 
double getTimeOfFrame (int frame) const
 
int getFrameOfTime (double time) const
 
virtual double getOffsetTime () const =0
 
int getOffsetTimeFrame () const
 
virtual int getNumFrames () const =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...
 

Protected Member Functions

virtual bool doReadSeq (const Mapping *archive, std::ostream &os) override
 
virtual bool doWriteSeq (YAMLWriter &writer, std::function< void()> writeAdditionalPart) override
 
- Protected Member Functions inherited from cnoid::MultiSeq< double >
virtual value_type defaultValue () const
 
- Protected Member Functions inherited from cnoid::AbstractMultiSeq
std::vector< std::string > readSeqPartLabels (const Mapping *archive)
 
bool writeSeqPartLabels (YAMLWriter &writer)
 
- Protected Member Functions inherited from cnoid::AbstractSeq
 AbstractSeq (const char *seqType)
 
 AbstractSeq (const AbstractSeq &org)
 
void setSeqType (const std::string &type)
 
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...
 

Additional Inherited Members

- Public Types inherited from cnoid::MultiSeq< double >
typedef Deque2D< double, std::allocator< double > > Container
 
typedef Container::value_type value_type
 
typedef Container::Row Frame
 
typedef Container::Column Part
 
typedef value_type Element
 
- Static Public Member Functions inherited from cnoid::AbstractSeq
static double defaultFrameRate ()
 
- Protected Attributes inherited from cnoid::MultiSeq< double >
double frameRate_
 
double offsetTime_
 

Constructor & Destructor Documentation

◆ MultiValueSeq() [1/3]

MultiValueSeq::MultiValueSeq ( )

◆ MultiValueSeq() [2/3]

MultiValueSeq::MultiValueSeq ( int  numFrames,
int  numParts = 1 
)

◆ MultiValueSeq() [3/3]

MultiValueSeq::MultiValueSeq ( const MultiValueSeq org)

◆ ~MultiValueSeq()

MultiValueSeq::~MultiValueSeq ( )
virtual

Member Function Documentation

◆ cloneSeq()

std::shared_ptr< AbstractSeq > MultiValueSeq::cloneSeq ( ) const
overridevirtual

◆ doReadSeq()

bool MultiValueSeq::doReadSeq ( const Mapping archive,
std::ostream &  os 
)
overrideprotectedvirtual

Reimplemented from cnoid::AbstractSeq.

◆ doWriteSeq()

bool MultiValueSeq::doWriteSeq ( YAMLWriter writer,
std::function< void()>  writeAdditionalPart 
)
overrideprotectedvirtual

Reimplemented from cnoid::AbstractMultiSeq.

◆ loadPlainFormat()

bool MultiValueSeq::loadPlainFormat ( const std::string &  filename,
std::ostream &  os = nullout() 
)

◆ saveAsPlainFormat()

bool MultiValueSeq::saveAsPlainFormat ( const std::string &  filename,
std::ostream &  os = nullout() 
)

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