Actin  Version 5.5.5
Software for Robotics Simulation and Control
EcMotionScriptSequence Class Reference

Holds motion script sequence (vector). More...

#include <ecMotionScriptSequence.h>

Inheritance diagram for EcMotionScriptSequence:
Collaboration diagram for EcMotionScriptSequence:

Public Member Functions

virtual const EcStringtoken () const EC_OVERRIDE
virtual EcBoolean read (const EcMotionScriptTokenTree &tokenTree, EcString *pErrorMsg) EC_OVERRIDE
 read list More...
virtual Status run (EcBaseControlSystemModifier &modifier, const EcReal currentTime) EC_OVERRIDE
 run the script More...
virtual EcMotionScriptSequenceclone (EcBaseMotionScriptContainer *pContainer) const EC_OVERRIDE
 Clone with container. More...
- Public Member Functions inherited from EcBaseMotionScriptContainer
virtual void clearMotions ()
 clear motions
virtual void addMotion (const EcMotionScriptSharedPtr &pMotion)
 add motion
EcBoolean connectContainer ()
 connect container together
EcBoolean registerSymbol (const EcString &symbol, const EcMotionScriptSharedPtr &pValue)
 Register symbol. More...
EcBoolean registerSymbol (const EcString &symbol, EcMotionScriptObject *pValue)
 Register symbol. More...
EcMotionScriptObjectfindSymbol (const EcString &symbol) const
 find symbol
virtual EcString write () const EC_OVERRIDE
virtual void restart () EC_OVERRIDE
 restart by setting the status to NOT_STARTED More...
virtual EcBoolean isEmpty () const
 check if motion vector is empty
const EcMotionScriptSharedPtrVectormotionVector () const
 get motion vector
- Public Member Functions inherited from EcMotionScriptObject
 EcMotionScriptObject ()
 default constructor
virtual ~EcMotionScriptObject ()
Status status () const
 get status
EcReal progress () const
 get progress in [0, 1]
virtual EcBoolean setContainer (EcBaseMotionScriptContainer *pContainer)
 set the container More...
EcBoolean readWithContainer (const EcMotionScriptTokenTree &tokenTree, EcBaseMotionScriptContainer *pContainer, EcString *pErrorMsg)
 read with container
virtual void pause ()
 request to pause
virtual void resume ()
 request to resume

Static Public Member Functions

static EcMotionScriptObjectnewObject ()
 motion script object creator
static const EcStringscriptToken ()
 script token
- Static Public Member Functions inherited from EcMotionScriptObject
static EcMotionScriptSharedPtr parseScript (const EcString &script, EcString *pErrorMsg)
 parse script
static EcMotionScriptSharedPtr parseScript (const EcMotionScriptTokenTree &tokenTree, EcBaseMotionScriptContainer *pContainer, EcString *pErrorMsg)
 parse script
static EcBoolean isKeyword (const EcString &symbol)
 is keyword
static EcBoolean tokenize (const EcString &script, EcStringList &tokens, EcString *pErrorMsg)
static EcBoolean readFromTokens (EcStringList &tokens, EcMotionScriptTokenTree &tokenTree, EcString *pErrorMsg)
 read from tokens
static EcBoolean registerScript (const EcString &scriptToken, const EcMotionScriptObjectCreator &creator)
static EcStringSet registeredScriptTokens ()

Additional Inherited Members

- Public Types inherited from EcMotionScriptObject
enum  Status {
- Protected Types inherited from EcBaseMotionScriptContainer
typedef std::map< EcString, EcMotionScriptObject * > EcMotionScriptSymbolMap
 typedef of EcMotionScriptSymbolMap
- Protected Attributes inherited from EcBaseMotionScriptContainer
EcMotionScriptSharedPtrVector m_MotionVector
EcMotionScriptSymbolMap m_MotionScriptSymbolMap
- Protected Attributes inherited from EcMotionScriptObject
 the container
Status m_Status
 motion status
EcReal m_Progress
 motion script progress in [0, 1]
EcBoolean m_PauseFlag

Detailed Description

Holds motion script sequence (vector).

Definition at line 15 of file ecMotionScriptSequence.h.

Member Function Documentation

virtual EcMotionScriptSequence* EcMotionScriptSequence::clone ( EcBaseMotionScriptContainer pContainer) const

Clone with container.

This method is intended for internal use only.

Reimplemented from EcMotionScriptObject.

virtual EcBoolean EcMotionScriptSequence::read ( const EcMotionScriptTokenTree tokenTree,
EcString pErrorMsg 

read list

Reimplemented from EcBaseMotionScriptContainer.

virtual Status EcMotionScriptSequence::run ( EcBaseControlSystemModifier modifier,
const EcReal  currentTime 

run the script

Implements EcMotionScriptObject.

Reimplemented in EcMotionScriptFunction.

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