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

Holds a class to describe a manipulator. More...

#include <ecSbManipulatorData.h>

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

Public Member Functions

 ECXMLOBJECT (EcSbManipulatorData)
 
virtual void registerComponents () EC_OVERRIDE
 Creates a static creator method. More...
 
virtual EcBoolean fixedBaseFlag () const
 get fixed base flag More...
 
virtual void setFixedBaseFlag (EcBoolean fixedBaseFlag)
 set fixed base flag More...
 
virtual const EcCoordinateSystemTransformationposition () const
 get position More...
 
virtual void setPosition (const EcCoordinateSystemTransformation &position)
 set position More...
 
- Public Member Functions inherited from EcSbLinkData
 ECXMLOBJECT (EcSbLinkData)
 
virtual const EcSbPhysicalExtentphysicalExtent () const
 get physical extent More...
 
virtual void setPhysicalExtent (const EcSbPhysicalExtent &physicalExtent)
 set physical extent More...
 
virtual const EcSbKinematicskinematics () const
 get kinematics parameters More...
 
virtual void setKinematics (const EcSbKinematics &kinematics)
 set kinematics parameters More...
 
virtual const EcSbJointActuatorjointActuator () const
 get joint actuator More...
 
virtual void setJointActuator (const EcSbJointActuator &jointActuator)
 set joint actuator More...
 
virtual const EcRigidBodyMassPropertiesmassProperties () const
 get mass properties More...
 
virtual void setMassProperties (const EcRigidBodyMassProperties &massProperties)
 set mass properties More...
 
virtual const EcSbLinkDataVectorlinks () const
 get links More...
 
virtual void setLinks (const EcSbLinkDataVector &links)
 set links More...
 
- Public Member Functions inherited from EcXmlCompoundType
 ECDECLARE_BIGFOUR (EcXmlCompoundType)
 
virtual EcBoolean xmlInit () EC_OVERRIDE
 xmlInitialize
 
virtual EcBoolean read (EcXmlReader &stream) EC_OVERRIDE
 read object from an XML stream
 
virtual EcBoolean readAttributes (EcXmlReader &stream)
 read object attributes from an XML stream
 
virtual EcBoolean readElements (EcXmlReader &stream)
 read object elements from an XML stream
 
virtual EcBoolean write (EcXmlWriter &stream) const EC_OVERRIDE
 write object to an XML stream
 
virtual EcBoolean writeAttributes (EcXmlWriter &stream) const
 write object attributes to an XML stream
 
virtual EcBoolean writeElements (EcXmlWriter &stream) const
 write object elements to an XML stream
 
virtual EcBoolean writeSchema (EcXmlSchema &stream) const EC_OVERRIDE
 write schema
 
virtual EcBoolean writeSchemaAttributes (EcXmlSchema &stream) const
 write schema attributes
 
virtual EcBoolean writeSchemaElements (EcXmlSchema &stream) const
 write schema elements
 
virtual void registerComponent (const EcToken &token, EcXmlObject *obj)
 register a single component More...
 
virtual void registerComponent (EcXmlObject *obj)
 register a single component More...
 
virtual void registerComponentReadOnly (const EcToken &token, EcXmlObject *obj)
 register a single component as read-only More...
 
virtual const EcXmlComponentMapcomponentMap () const
 get a reference to the component map
 
virtual void registerAttributeComponent (const EcToken &AttribToken, EcXmlObject *Obj)
 register a single attribute component More...
 
virtual void registerAttributeComponentReadOnly (const EcToken &AttribToken, EcXmlObject *Obj)
 register a single attribute component read-only More...
 
virtual const EcXmlComponentMapattributeComponentMap ()
 get a reference to the component attribute map
 
virtual const EcXmlSpecialDescriptorMapspecialDescriptorMap ()
 get a reference to the special-descriptor map
 
virtual void registerComponentDescriptor (const EcToken &xmlToken, const EcToken &descriptorToken, const EcString &descriptorString)
 register an XML token-string descriptor More...
 
virtual const EcXmlTokenStringDescriptorMapMaptokenStringDescriptorMap ()
 get a reference to the XML token-string descriptor map
 
virtual EcBoolean hasChildren () const
 return EcTrue if there are children components or EcFalse if an empty element.
 
virtual EcBoolean hasAttributes () const
 return EcTrue if there are attributes in the element.
 
- Public Member Functions inherited from EcXmlObject
 ECDECLARE_BIGFOUR (EcXmlObject)
 
virtual EcXmlObjectclone () const =0
 clone
 
virtual EcBoolean readAttribute (EcXmlReader &stream)
 read this attribute from an XML stream
 
virtual EcBoolean createSchema (const EcString &filename, const EcToken &objectName=EcXml::EcDefaultToken) const
 create schema
 
virtual EcBoolean xmlInitialized () const
 get XML initialized flag. This bit is set on initialization.
 
virtual void setXmlInitialized (EcBoolean val=EcTrue)
 set XML initialized flag. This bit is set on initialization.
 
virtual EcBoolean specified () const
 get specified flag. This bit is set upon reading from an XML file.
 
virtual void setSpecified (EcBoolean val=EcTrue)
 set specified flag. This bit is set upon reading from an XML file.
 
virtual EcBoolean isBasicType () const
 Return true/false for basic type.
 
virtual EcBoolean equalsDefault () const
 tests equality of XML object with default
 
virtual EcBoolean equality (const EcXmlObject *other) const =0
 equality - a virtual equality to an EcXmlObject pointer
 
virtual EcXmlObjectnewObject () const =0
 creates new object - a virtual new to an EcXmlObject pointer
 
virtual const EcTokentoken () const =0
 gets the xml token used for writing out.
 

Protected Attributes

EcXmlBoolean m_FixedBaseFlag
 fixed base flag
 
EcCoordinateSystemTransformation m_Position
 object position
 
- Protected Attributes inherited from EcSbLinkData
EcSbPhysicalExtent m_PhysicalExtent
 Physical Extent.
 
EcSbKinematics m_Kinematics
 Kinematics.
 
EcSbJointActuator m_JointActuator
 Joint actuator.
 
EcRigidBodyMassProperties m_MassProperties
 Mass properties.
 
EcSbLinkDataVector m_Links
 vector of child links
 
- Protected Attributes inherited from EcXmlCompoundType
EcXmlComponentMapm_pComponentMap
 
EcXmlComponentMapm_pAttributeComponentMap
 
EcXmlSpecialDescriptorMapm_pSpecialDescriptorMap
 
EcXmlTokenStringDescriptorMapMapm_pComponentMapTokenStringDescriptor
 
- Protected Attributes inherited from EcXmlObject
EcU8 m_State
 the state of the object - eight boolean flags
 

Additional Inherited Members

- Public Types inherited from EcXmlCompoundType
enum  {
  READONLYCOMPONENT = 0,
  READONLYATTRIBUTE
}
 special-descriptor codes More...
 
- Protected Member Functions inherited from EcXmlCompoundType
virtual EcBoolean readValueFromToken (const EcToken &token, EcXmlReader &stream)
 
virtual EcBoolean readValueFromSpecialToken (const EcToken &token, EcXmlReader &stream)
 read value from unregistered token
 
virtual EcBoolean readAttributeFromToken (const EcToken &token, EcXmlReader &stream)
 
virtual EcXmlComponentMapnewComponentMap () const
 allocate a new componentMap
 
virtual EcXmlSpecialDescriptorMapnewSpecialDescriptorMap ()
 allocate a new specialDescriptorsMap
 
virtual EcXmlTokenStringDescriptorMapMapnewTokenStringDescriptorMap ()
 allocate a new tokenStringDescriptorsMap
 
virtual void createComponentMap () const
 create component map
 
virtual void createAttributeComponentMap ()
 create attribute component map
 
virtual void createSpecialDescriptorMap ()
 create special-descriptors map
 
virtual void createTokenStringDescriptorMap ()
 create token-string descriptor map
 
virtual EcBoolean isReadOnlyComponent (const EcToken token) const
 check to see if the token corresponds to a read-only component
 
virtual EcBoolean isReadOnlyAttribute (const EcToken token) const
 check to see if the token corresponds to a read-only attribute
 
virtual EcXmlObjectlibraryAttribute ()
 
- Static Protected Attributes inherited from EcXmlObject
static const EcU8 m_theXmlInitializedBit
 the bit used to describe xml initialization
 
static const EcU8 m_theSpecifiedBit
 the bit used to describe specification
 

Detailed Description

Holds a class to describe a manipulator.

Definition at line 17 of file ecSbManipulatorData.h.

Member Function Documentation

EcSbManipulatorData::ECXMLOBJECT ( EcSbManipulatorData  )

ECXMLOBJECT(EcCls) Macro declares a constructor, destructor, copy constructor, equal operator, and equality operator

virtual EcBoolean EcSbManipulatorData::fixedBaseFlag ( ) const
virtual

get fixed base flag

Returns
fixed base flag
virtual const EcCoordinateSystemTransformation& EcSbManipulatorData::position ( ) const
virtual

get position

Returns
position
virtual void EcSbManipulatorData::registerComponents ( )
virtual

Creates a static creator method.

register components This is a pure virtual function. The derived class should use this method register all its relevant components.

Reimplemented from EcSbLinkData.

Reimplemented in EcSbManipulatorCollectionData.

virtual void EcSbManipulatorData::setFixedBaseFlag ( EcBoolean  fixedBaseFlag)
virtual

set fixed base flag

Parameters
fixedBaseFlagfixedBaseFlag The fixed base flag
virtual void EcSbManipulatorData::setPosition ( const EcCoordinateSystemTransformation position)
virtual

set position

Parameters
positionposition The position

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