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

Holds a real vector literal for motion script. More...

#include <ecMotionScriptRealVector.h>

Inheritance diagram for EcMotionScriptRealVector:
EcMotionScriptRealVectorObject EcBaseMotionScriptVariableType< ValueType > EcBaseMotionScriptVariable EcMotionScriptObject

Public Member Functions

virtual const EcStringtoken () const EC_OVERRIDE
 token
 
virtual EcBoolean read (const EcMotionScriptTokenTree &tokenTree, EcString *pErrorMsg) EC_OVERRIDE
 read list More...
 
virtual EcString write () const EC_OVERRIDE
 write to script More...
 
virtual Status run (EcBaseControlSystemModifier &modifier, const EcReal currentTime) EC_OVERRIDE
 run the script More...
 
virtual void restart () EC_OVERRIDE
 restart by setting the status to NOT_STARTED More...
 
void setLiteral (const EcRealVector &literal)
 set literal
 
EcBoolean isLiteral () const
 is literal
 
- Public Member Functions inherited from EcBaseMotionScriptVariableType< ValueType >
virtual const ValueType & value () const
 
virtual void setValue (const ValueType &value)
 set the value
 
- 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
 
EcBoolean readWithContainer (const EcMotionScriptTokenTree &tokenTree, EcBaseMotionScriptContainer *pContainer, EcString *pErrorMsg)
 read with container
 
virtual void pause ()
 request to pause
 
virtual void resume ()
 request to resume
 
virtual void abort ()
 Set the status to ABORTED.
 

Additional Inherited Members

- Public Types inherited from EcBaseMotionScriptVariableType< ValueType >
typedef ValueType value_type
 value type
 
- Public Types inherited from EcBaseMotionScriptVariable
enum  VariableType {
  VAR_TYPE_INVALID,
  VAR_TYPE_BOOLEAN,
  VAR_TYPE_ORIENTATION,
  VAR_TYPE_POSE,
  VAR_TYPE_REAL,
  VAR_TYPE_REAL_VECTOR,
  VAR_TYPE_STRING,
  VAR_TYPE_TRANSLATION,
  VAR_TYPE_U32,
  VAR_TYPE_U32_VECTOR
}
 variable type
 
- Public Types inherited from EcMotionScriptObject
enum  Status {
  NOT_STARTED,
  IN_PROGRESS,
  STOPPING,
  PAUSED,
  SUCCEEDED,
  FAILED,
  ABORTED
}
 status
 
- Static Public Member Functions inherited from EcMotionScriptRealVectorObject
static EcMotionScriptRealVectorObjectSharedPtr parseScript (const EcMotionScriptTokenTree &tokenTree, EcBaseMotionScriptContainer *pContainer, EcString *pErrorMsg)
 parse script
 
static void setLiteral (EcMotionScriptRealVectorObjectSharedPtr &pVariable, const EcRealVector &value)
 set literal
 
- Static Public Member Functions inherited from EcBaseMotionScriptVariable
static EcBoolean isSymbolValid (const EcString &symbol, EcString *pErrorMsg)
 Check if a symbol is valid. More...
 
- 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)
 
- Protected Attributes inherited from EcBaseMotionScriptVariableType< ValueType >
ValueType m_Value
 the value
 
- 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
 
- Static Protected Attributes inherited from EcMotionScriptRealVectorObject
static const EcMotionScriptRealVectorTokenMap m_MotionScriptRealVectorTokenMap
 

Detailed Description

Holds a real vector literal for motion script.

Holds classes of real-vector-specific motion scripts.

Definition at line 55 of file ecMotionScriptRealVector.h.

Member Function Documentation

virtual EcBoolean EcMotionScriptRealVector::read ( const EcMotionScriptTokenTree tokenTree,
EcString pErrorMsg 
)
virtual

read list

Implements EcMotionScriptObject.

virtual void EcMotionScriptRealVector::restart ( )
virtual

restart by setting the status to NOT_STARTED

Implements EcMotionScriptObject.

virtual Status EcMotionScriptRealVector::run ( EcBaseControlSystemModifier modifier,
const EcReal  currentTime 
)
virtual

run the script

Implements EcMotionScriptObject.

virtual EcString EcMotionScriptRealVector::write ( ) const
virtual

write to script

Implements EcMotionScriptObject.


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.