Actin®  Version 5.2.0
Software for Robotics Simulation and Control
EcBaseMotionScriptContainer Class Reference

Base motion script container class. More...

#include <ecBaseMotionScriptContainer.h>

Inheritance diagram for EcBaseMotionScriptContainer:
EcMotionScriptObject EcMotionScriptParallel EcMotionScriptSequence EcMotionScriptStreamSequence

Public Member Functions

void clearMotions ()
 clear motions
 
void addMotion (const EcMotionScriptSharedPtr &pMotion)
 add motion
 
EcBoolean registerSymbol (const EcString &symbol, const EcMotionScriptSharedPtr &pValue)
 Register symbol. More...
 
EcMotionScriptObjectfindSymbol (const EcString &symbol) const
 find symbol
 
virtual EcBoolean read (const EcMotionScriptTokenTree &tokenTree, EcString *pErrorMsg) EC_OVERRIDE
 read motion vector
 
virtual EcString write () const EC_OVERRIDE
 write
 
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 ()
 destructor
 
Status status () const
 get status
 
EcReal progress () const
 get progress in [0, 1]
 
virtual void setContainter (EcBaseMotionScriptContainer *pContainer)
 set the container
 
virtual const EcStringtoken () const =0
 token
 
EcBoolean readWithContainer (const EcMotionScriptTokenTree &tokenTree, EcBaseMotionScriptContainer *pContainer, EcString *pErrorMsg)
 read with container
 
virtual Status run (EcBaseControlSystemModifier &modifier, const EcReal currentTime)=0
 run the script
 
virtual void pause ()
 request to pause
 
virtual void resume ()
 request to resume
 
virtual void abort ()
 Set the status to ABORTED.
 

Protected Attributes

EcMotionScriptSharedPtrVector m_MotionVector
 
EcMotionScriptSymbolMap m_MotionScriptSymbolMap
 
- Protected Attributes inherited from EcMotionScriptObject
EcBaseMotionScriptContainerm_pContainer
 the container
 
Status m_Status
 motion status
 
EcReal m_Progress
 motion script progress in [0, 1]
 
EcBoolean m_PauseFlag
 

Additional Inherited Members

- Public Types inherited from EcMotionScriptObject
enum  Status {
  NOT_STARTED,
  IN_PROGRESS,
  STOPPING,
  PAUSED,
  SUCCEEDED,
  FAILED,
  ABORTED
}
 status
 
- 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)
 tokenize
 
static EcBoolean readFromTokens (EcStringList &tokens, EcMotionScriptTokenTree &tokenTree, EcString *pErrorMsg)
 read from tokens
 
static EcBoolean registerScript (const EcString &scriptToken, const EcMotionScriptObjectCreator &creator)
 

Detailed Description

Base motion script container class.

Definition at line 19 of file ecBaseMotionScriptContainer.h.

Member Function Documentation

EcBoolean EcBaseMotionScriptContainer::registerSymbol ( const EcString symbol,
const EcMotionScriptSharedPtr pValue 
)

Register symbol.

Parameters
[in]symbolsymbol to be registered
[in]valuevalue of the symbol
Returns
false if the symbol is a key word
virtual void EcBaseMotionScriptContainer::restart ( )
virtual

restart by setting the status to NOT_STARTED

Implements EcMotionScriptObject.

Reimplemented in EcMotionScriptStreamSequence.


The documentation for this class was generated from the following file:
Created by Energid Technologies www.energid.com
Copyright © 2016 Energid. All trademarks mentioned in this document are property of their respective owners.