Choreonoid  1.8
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cnoid::MultiSeq< ElementType, Allocator > Class Template Reference

#include <MultiSeq.h>

Inheritance diagram for cnoid::MultiSeq< ElementType, Allocator >:
cnoid::Deque2D< ElementType, std::allocator< ElementType > > cnoid::AbstractMultiSeq cnoid::AbstractSeq

Public Types

typedef Deque2D< ElementType, Allocator > Container
 
typedef Container::value_type value_type
 
typedef Container::Row Frame
 
typedef Container::Column Part
 
typedef value_type Element
 

Public Member Functions

 MultiSeq (const char *seqType)
 
 MultiSeq (const char *seqType, int numFrames, int numParts)
 
 MultiSeq (const MultiSeqType &org)
 
virtual ~MultiSeq ()
 
MultiSeqType & operator= (const MultiSeqType &rhs)
 
virtual AbstractSeq & operator= (const AbstractSeq &rhs) override
 
virtual std::shared_ptr< AbstractSeq > cloneSeq () 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 ()
 
AbstractMultiSeq & operator= (const AbstractMultiSeq &rhs)
 
void copySeqProperties (const AbstractMultiSeq &source)
 
virtual int partIndex (const std::string &partLabel) const
 
virtual const std::string & partLabel (int partIndex) const
 
virtual AbstractSeq & operator= (const AbstractSeq &rhs)
 
- 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) const
 
int getFrameOfTime (double time) const
 
int getOffsetTimeFrame () const
 
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 value_type defaultValue () const
 
- Protected Member Functions inherited from cnoid::AbstractMultiSeq
virtual bool doWriteSeq (YAMLWriter &writer, std::function< void()> additionalPartCallback)
 
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)
 
virtual bool doReadSeq (const Mapping *archive, std::ostream &os)
 
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...
 

Protected Attributes

double frameRate_
 
double offsetTime_
 

Additional Inherited Members

- Static Public Member Functions inherited from cnoid::AbstractSeq
static double defaultFrameRate ()
 

Member Typedef Documentation

◆ Container

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
typedef Deque2D<ElementType, Allocator> cnoid::MultiSeq< ElementType, Allocator >::Container

◆ Element

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
typedef value_type cnoid::MultiSeq< ElementType, Allocator >::Element
Deprecated:
. Use value_type.

◆ Frame

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
typedef Container::Row cnoid::MultiSeq< ElementType, Allocator >::Frame

◆ Part

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
typedef Container::Column cnoid::MultiSeq< ElementType, Allocator >::Part

◆ value_type

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
typedef Container::value_type cnoid::MultiSeq< ElementType, Allocator >::value_type

Constructor & Destructor Documentation

◆ MultiSeq() [1/3]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
cnoid::MultiSeq< ElementType, Allocator >::MultiSeq ( const char *  seqType)
inline

◆ MultiSeq() [2/3]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
cnoid::MultiSeq< ElementType, Allocator >::MultiSeq ( const char *  seqType,
int  numFrames,
int  numParts 
)
inline

◆ MultiSeq() [3/3]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
cnoid::MultiSeq< ElementType, Allocator >::MultiSeq ( const MultiSeqType &  org)
inline

◆ ~MultiSeq()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual cnoid::MultiSeq< ElementType, Allocator >::~MultiSeq ( )
inlinevirtual

Member Function Documentation

◆ appendFrame()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
Frame cnoid::MultiSeq< ElementType, Allocator >::appendFrame ( )
inline

◆ clampFrameIndex()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
int cnoid::MultiSeq< ElementType, Allocator >::clampFrameIndex ( int  frameIndex)
inline

◆ clearFrames()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
void cnoid::MultiSeq< ElementType, Allocator >::clearFrames ( )
inline

◆ cloneSeq()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual std::shared_ptr<AbstractSeq> cnoid::MultiSeq< ElementType, Allocator >::cloneSeq ( ) const
inlineoverridevirtual

Implements cnoid::AbstractMultiSeq.

◆ copySeqProperties()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
void cnoid::MultiSeq< ElementType, Allocator >::copySeqProperties ( const MultiSeqType &  source)
inline

◆ defaultValue()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual value_type cnoid::MultiSeq< ElementType, Allocator >::defaultValue ( ) const
inlineprotectedvirtual

◆ frame() [1/2]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
Frame cnoid::MultiSeq< ElementType, Allocator >::frame ( int  index)
inline

◆ frame() [2/2]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
const Frame cnoid::MultiSeq< ElementType, Allocator >::frame ( int  index) const
inline

◆ frameOfTime()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
int cnoid::MultiSeq< ElementType, Allocator >::frameOfTime ( double  time) const
inline

◆ frameRate()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
double cnoid::MultiSeq< ElementType, Allocator >::frameRate ( ) const
inline

◆ getFrameRate()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual double cnoid::MultiSeq< ElementType, Allocator >::getFrameRate ( ) const
inlineoverridevirtual

Implements cnoid::AbstractSeq.

◆ getNumFrames()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual int cnoid::MultiSeq< ElementType, Allocator >::getNumFrames ( ) const
inlineoverridevirtual

Implements cnoid::AbstractSeq.

◆ getNumParts()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual int cnoid::MultiSeq< ElementType, Allocator >::getNumParts ( ) const
inlineoverridevirtual

Implements cnoid::AbstractMultiSeq.

◆ getOffsetTime()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual double cnoid::MultiSeq< ElementType, Allocator >::getOffsetTime ( ) const
inlineoverridevirtual

Implements cnoid::AbstractSeq.

◆ numFrames()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
int cnoid::MultiSeq< ElementType, Allocator >::numFrames ( ) const
inline

◆ numParts()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
int cnoid::MultiSeq< ElementType, Allocator >::numParts ( ) const
inline

◆ offsetTime()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
double cnoid::MultiSeq< ElementType, Allocator >::offsetTime ( ) const
inline

◆ offsetTimeFrame()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
int cnoid::MultiSeq< ElementType, Allocator >::offsetTimeFrame ( ) const
inline

◆ operator=() [1/2]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual AbstractSeq& cnoid::MultiSeq< ElementType, Allocator >::operator= ( const AbstractSeq &  rhs)
inlineoverridevirtual

Reimplemented from cnoid::AbstractSeq.

◆ operator=() [2/2]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
MultiSeqType& cnoid::MultiSeq< ElementType, Allocator >::operator= ( const MultiSeqType &  rhs)
inline

◆ part() [1/2]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
Part cnoid::MultiSeq< ElementType, Allocator >::part ( int  index)
inline

◆ part() [2/2]

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
const Part cnoid::MultiSeq< ElementType, Allocator >::part ( int  index) const
inline

◆ popFrontFrame()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
void cnoid::MultiSeq< ElementType, Allocator >::popFrontFrame ( )
inline

◆ setDimension()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual void cnoid::MultiSeq< ElementType, Allocator >::setDimension ( int  newNumFrames,
int  newNumParts,
bool  fillNewElements = false 
)
inlineoverridevirtual

Implements cnoid::AbstractMultiSeq.

◆ setFrameRate()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual void cnoid::MultiSeq< ElementType, Allocator >::setFrameRate ( double  frameRate)
inlineoverridevirtual

Implements cnoid::AbstractSeq.

◆ setNumFrames()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual void cnoid::MultiSeq< ElementType, Allocator >::setNumFrames ( int  newNumFrames,
bool  fillNewElements = false 
)
inlineoverridevirtual

Implements cnoid::AbstractSeq.

◆ setNumParts()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual void cnoid::MultiSeq< ElementType, Allocator >::setNumParts ( int  newNumParts,
bool  fillNewElements = false 
)
inlineoverridevirtual

Implements cnoid::AbstractMultiSeq.

◆ setOffsetTime()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
virtual void cnoid::MultiSeq< ElementType, Allocator >::setOffsetTime ( double  time)
inlineoverridevirtual

Implements cnoid::AbstractSeq.

◆ setOffsetTimeFrame()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
void cnoid::MultiSeq< ElementType, Allocator >::setOffsetTimeFrame ( int  offset)
inline

◆ timeLength()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
double cnoid::MultiSeq< ElementType, Allocator >::timeLength ( ) const
inline

◆ timeOfFrame()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
double cnoid::MultiSeq< ElementType, Allocator >::timeOfFrame ( int  frame) const
inline

◆ timeStep()

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
const double cnoid::MultiSeq< ElementType, Allocator >::timeStep ( ) const
inline

Member Data Documentation

◆ frameRate_

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
double cnoid::MultiSeq< ElementType, Allocator >::frameRate_
protected

◆ offsetTime_

template<typename ElementType , typename Allocator = std::allocator<ElementType>>
double cnoid::MultiSeq< ElementType, Allocator >::offsetTime_
protected
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17