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

Motion script for attaching manipulator. More...

#include <ecManipulatorMotionAttachManipulator.h>

Inheritance diagram for EcManipulatorMotionAttachManipulator:
[legend]
Collaboration diagram for EcManipulatorMotionAttachManipulator:
[legend]

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 setDependentManipulatorIndex (const EcU32 manipIndex)
 set dependent manipulator index
 
void setDependentManipulatorIndex (const EcMotionScriptU32ObjectSharedPtr &pManipIndex)
 set dependent manipulator index
 
const EcMotionScriptU32ObjectSharedPtr & dependentManipulatorIndex () const
 get dependent manipulator indenx
 
void setBaseManipulatorIndex (const EcU32 manipIndex)
 set base manipulator index
 
void setBaseManipulatorIndex (const EcMotionScriptU32ObjectSharedPtr &pManipIndex)
 set base manipulator index
 
const EcMotionScriptU32ObjectSharedPtr & baseManipulatorIndex () const
 get base manipulator index
 
void setLinkIndex (const EcU32 linkIndex)
 set link index
 
void setLinkIndex (const EcMotionScriptU32ObjectSharedPtr &pLinkIndex)
 set link index
 
const EcMotionScriptU32ObjectSharedPtr & linkIndex () const
 get link index
 
- Public Member Functions inherited from EcBaseManipulatorMotion
void setManipulatorIndex (const EcU32 manipIndex)
 set manipulator index
 
void setManipulatorIndex (const EcMotionScriptU32ObjectSharedPtr &pManipIndex)
 set manipulator index
 
const EcMotionScriptU32ObjectSharedPtr & manipulatorIndex () const
 get manipulator index
 
void setMotionId (const EcInt32 id)
 Set the motion ID.
 
EcInt32 motionId () const
 Get the motion ID.
 
- 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 EcBoolean setContainer (EcBaseMotionScriptContainer *pContainer)
 set the container More...
 
virtual EcMotionScriptObjectclone (EcBaseMotionScriptContainer *pContainer) const
 Clone with 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)
 tokenize
 
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 {
  NOT_STARTED,
  IN_PROGRESS,
  STOPPING,
  PAUSED,
  SUCCEEDED,
  FAILED
}
 status
 
- Protected Attributes inherited from EcBaseManipulatorMotion
EcMotionScriptU32ObjectSharedPtr m_pManipIndex
 manipulator index
 
EcInt32 m_MotionId
 the motion ID, currently only used by the group motion manager
 
- 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

Motion script for attaching manipulator.

Motion scripts for attaching/detaching manipulator.

Definition at line 17 of file ecManipulatorMotionAttachManipulator.h.

Member Function Documentation

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

read list

Implements EcMotionScriptObject.

virtual void EcManipulatorMotionAttachManipulator::restart ( )
virtual

restart by setting the status to NOT_STARTED

Implements EcBaseManipulatorMotion.

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

run the script

Implements EcBaseManipulatorMotion.

virtual EcString EcManipulatorMotionAttachManipulator::write ( ) const
virtual

write to script

Implements EcMotionScriptObject.


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