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

base class of motion script variable type More...

#include <ecBaseMotionScriptVariable.h>

Inheritance diagram for EcBaseMotionScriptVariable:
EcMotionScriptObject EcBaseMotionScriptVariableType< ValueType > EcMotionScriptBooleanObject EcMotionScriptOrientationObject EcMotionScriptPoseObject EcMotionScriptRealObject EcMotionScriptRealVectorObject EcMotionScriptStringObject EcMotionScriptTranslationObject EcMotionScriptU32Object EcMotionScriptU32VectorObject

Public Types

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

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)
 

Additional Inherited Members

- 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
 
virtual EcBoolean read (const EcMotionScriptTokenTree &tokenTree, EcString *pErrorMsg)=0
 read list
 
EcBoolean readWithContainer (const EcMotionScriptTokenTree &tokenTree, EcBaseMotionScriptContainer *pContainer, EcString *pErrorMsg)
 read with container
 
virtual EcString write () const =0
 write to script
 
virtual Status run (EcBaseControlSystemModifier &modifier, const EcReal currentTime)=0
 run the script
 
virtual void restart ()=0
 restart by setting the status to NOT_STARTED
 
virtual void pause ()
 request to pause
 
virtual void resume ()
 request to resume
 
virtual void abort ()
 Set the status to ABORTED.
 
- 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
 

Detailed Description

base class of motion script variable type

Base class of motion script variables.

Definition at line 15 of file ecBaseMotionScriptVariable.h.

Member Function Documentation

static EcBoolean EcBaseMotionScriptVariable::isSymbolValid ( const EcString symbol,
EcString pErrorMsg 
)
static

Check if a symbol is valid.

A symbol must start with a letter or _ and contain a-zA-Z0-9_ only.


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.