Actin  Version 5.5.2
Software for Robotics Simulation and Control
EcXmlObject Class Referenceabstract

A base class for xml objects. More...

#include <ecXmlObject.h>

Inherited by EcBaseXmlBasicType, EcPolygon, EcTriangle, EcXmlBaseVariableCompoundType, EcXmlCompoundType, EcXmlExample, EcXmlListType< ElementType >, EcXmlMapType< KeyType, ValueType >, EcXmlMapType< EcManipulatorLinkIdentifier, EcManipulatorLinkIdentifierSet >, EcXmlMapType< EcManipulatorLinkIdentifier, EcXmlU32Set >, EcXmlMapType< EcXmlBasicType, EcXmlVector >, EcXmlMapType< EcXmlString, EcCoordinateSystemTransformation >, EcXmlMapType< EcXmlString, EcDataMap >, EcXmlMapType< EcXmlString, EcDirectorObjectContainer >, EcXmlMapType< EcXmlString, EcDirectorObjectDirectory >, EcXmlMapType< EcXmlString, EcGraspSequence >, EcXmlMapType< EcXmlString, EcIndividualJointController >, EcXmlMapType< EcXmlString, EcIndividualJointControllerContainer >, EcXmlMapType< EcXmlString, EcManipulationSceneDirectionSimpleStateContainerVector >, EcXmlMapType< EcXmlString, EcManipulationSceneDirectionStateContainerVector >, EcXmlMapType< EcXmlString, EcParallelSimJobResults >, EcXmlMapType< EcXmlString, EcPose >, EcXmlMapType< EcXmlString, EcPoseSet >, EcXmlMapType< EcXmlString, EcRigidBodyMassProperties >, EcXmlMapType< EcXmlString, EcStoppingCriterionVector >, EcXmlMapType< EcXmlString, EcSystemCollisionExclusionMap >, EcXmlMapType< EcXmlString, EcXmlBoolean >, EcXmlMapType< EcXmlString, EcXmlOrientation >, EcXmlMapType< EcXmlString, EcXmlPairType< EcXmlString, EcXmlBoolean > >, EcXmlMapType< EcXmlString, EcXmlReal >, EcXmlMapType< EcXmlString, EcXmlRealVector >, EcXmlMapType< EcXmlString, EcXmlString >, EcXmlMapType< EcXmlString, EcXmlStringRealMap >, EcXmlMapType< EcXmlString, EcXmlStringU32Map >, EcXmlMapType< EcXmlString, EcXmlStringVector >, EcXmlMapType< EcXmlString, EcXmlU32 >, EcXmlMapType< EcXmlString, EcXmlU32Vector >, EcXmlMapType< EcXmlString, EcXmlVector >, EcXmlMapType< EcXmlString, ExclusionRoleLinksMap >, EcXmlMapType< EcXmlU32, EcAttachmentNodeState >, EcXmlMapType< EcXmlU32, EcRrtPathPlanner >, EcXmlMapType< EcXmlU32, EcRrtPathPlannerContainer >, EcXmlMapType< EcXmlU32, EcXmlU32Set >, EcXmlOrientation, EcXmlPairType< FirstType, SecondType >, EcXmlPairType< EcUvCoordinateType, EcUvCoordinateType >, EcXmlPairType< EcXmlReal, EcXmlReal >, EcXmlPairType< EcXmlString, EcXmlBoolean >, EcXmlPairType< EcXmlString, EcXmlString >, EcXmlPairType< EcXmlU32, EcXmlU32 >, EcXmlPairType< EcXmlVector, EcXmlVector >, EcXmlSetType< ElementType >, EcXmlSetType< EcXmlString >, EcXmlSetType< EcXmlU32 >, EcXmlVector, EcXmlVectorBasicType< ElementType >, EcXmlVectorBasicType< EcXmlInt32 >, EcXmlVectorBasicType< EcXmlReal >, EcXmlVectorBasicType< EcXmlU32 >, EcXmlVectorType< ElementType >, EcXmlVectorType< Ec::AsyncThreadData >, EcXmlVectorType< EcAccelerationState >, EcXmlVectorType< EcAxisAlignedBoundingBox >, EcXmlVectorType< EcBasicDirectionIssues >, EcXmlVectorType< EcBrick >, EcXmlVectorType< EcCapsule >, EcXmlVectorType< EcCircle >, EcXmlVectorType< EcControlExpressionContainer >, EcXmlVectorType< EcControlExpressionDescription >, EcXmlVectorType< EcCoordinateSystemTransformation >, EcXmlVectorType< EcCoordinateSystemTransformationVector >, EcXmlVectorType< EcDigitalIOXmlItem >, EcXmlVectorType< EcDirectionConditionContainer >, EcXmlVectorType< EcDisplaySystemDataCapture >, EcXmlVectorType< EcEditorGraspFrameData >, EcXmlVectorType< EcEndEffectorDataCapture >, EcXmlVectorType< EcEndEffectorPlacement >, EcXmlVectorType< EcEndEffectorSet >, EcXmlVectorType< EcForceControlDescriptionVector >, EcXmlVectorType< EcForceSensorSet >, EcXmlVectorType< EcFrameContainer >, EcXmlVectorType< EcGeneralForce >, EcXmlVectorType< EcGeneralVelocity >, EcXmlVectorType< EcGraspFrameContainer >, EcXmlVectorType< EcGraspFrameStateContainer >, EcXmlVectorType< EcGraspOffsetContainer >, EcXmlVectorType< EcGraspOffsetStateContainer >, EcXmlVectorType< EcGroupUserData >, EcXmlVectorType< EcIndividualManipulator >, EcXmlVectorType< EcIndividualVelocityControlDescription >, EcXmlVectorType< EcJointFrame >, EcXmlVectorType< EcLicense >, EcXmlVectorType< EcLight >, EcXmlVectorType< EcLineAndNeighbors >, EcXmlVectorType< EcLineSegment >, EcXmlVectorType< EcLinkAccelerationState >, EcXmlVectorType< EcLinkArticulationState >, EcXmlVectorType< EcLinkDataCapture >, EcXmlVectorType< EcLinkForceState >, EcXmlVectorType< EcLinkMassState >, EcXmlVectorType< EcLinkPositionState >, EcXmlVectorType< EcLinkVelocityState >, EcXmlVectorType< EcManipulationFrameStateContainer >, EcXmlVectorType< EcManipulationOffsetStateContainer >, EcXmlVectorType< EcManipulationScene >, EcXmlVectorType< EcManipulationSceneContainer >, EcXmlVectorType< EcManipulationSceneCue >, EcXmlVectorType< EcManipulationSceneDirectionContainer >, EcXmlVectorType< EcManipulationSceneDirectionContainerVector >, EcXmlVectorType< EcManipulationSceneDirectionStateContainer >, EcXmlVectorType< EcManipulationSceneDirectionStateContainerVector >, EcXmlVectorType< EcManipulationSceneSimpleState >, EcXmlVectorType< EcManipulationSceneStateContainer >, EcXmlVectorType< EcManipulatorActiveState >, EcXmlVectorType< EcManipulatorAttachmentChange >, EcXmlVectorType< EcManipulatorAttachmentNode >, EcXmlVectorType< EcManipulatorControlInput >, EcXmlVectorType< EcManipulatorDataCapture >, EcXmlVectorType< EcManipulatorDataStorage >, EcXmlVectorType< EcManipulatorEndEffectorAcceleration >, EcXmlVectorType< EcManipulatorEndEffectorPlacement >, EcXmlVectorType< EcManipulatorEndEffectorPlacementVector >, EcXmlVectorType< EcManipulatorEndEffectorVelocity >, EcXmlVectorType< EcManipulatorExternalForce >, EcXmlVectorType< EcManipulatorGraspingModule >, EcXmlVectorType< EcManipulatorJointController >, EcXmlVectorType< EcManipulatorLink >, EcXmlVectorType< EcManipulatorSelfCollisionLinkMap >, EcXmlVectorType< EcManipulatorSystemState >, EcXmlVectorType< EcManipulatorTorque >, EcXmlVectorType< EcManufacturerData >, EcXmlVectorType< EcOffsetContainer >, EcXmlVectorType< EcParallelSimJobBranch >, EcXmlVectorType< EcParallelSimJobResults >, EcXmlVectorType< EcPermissionData >, EcXmlVectorType< EcPlacementsData >, EcXmlVectorType< EcPlanarVector >, EcXmlVectorType< EcPluginConfigPair >, EcXmlVectorType< EcPositionState >, EcXmlVectorType< EcPositionStateRandomVariation >, EcXmlVectorType< EcPositionStateWaypoint >, EcXmlVectorType< EcPropagationResultData >, EcXmlVectorType< EcPropagationResultDataVector >, EcXmlVectorType< EcSbLinkData >, EcXmlVectorType< EcSbManipulatorCollectionData >, EcXmlVectorType< EcSensorBaseDataCaptureType >, EcXmlVectorType< EcServoJointCalibrationPoint >, EcXmlVectorType< EcSplineControlPoint >, EcXmlVectorType< EcStartStateAndPath >, EcXmlVectorType< EcStringLinkPropertyRandomVariationMap >, EcXmlVectorType< EcSurfacePropertyRandomVariation >, EcXmlVectorType< EcTableFunctionVectorSearch >, EcXmlVectorType< EcVelocityControlDescriptionVector >, EcXmlVectorType< EcVelocityState >, EcXmlVectorType< EcVelocityStateRandomVariation >, EcXmlVectorType< EcWaypointSequenceDirection >, EcXmlVectorType< EcWaypointSequenceDirectionState >, EcXmlVectorType< EcXml2DPoint >, EcXmlVectorType< EcXmlBoolean >, EcXmlVectorType< EcXmlBooleanVector >, EcXmlVectorType< EcXmlConstraintVectorType >, EcXmlVectorType< EcXmlInt16Vector >, EcXmlVectorType< EcXmlMapType >, EcXmlVectorType< EcXmlOrientation >, EcXmlVectorType< EcXmlPairType >, EcXmlVectorType< EcXmlRealRealPair >, EcXmlVectorType< EcXmlRealVector >, EcXmlVectorType< EcXmlRealVectorVector >, EcXmlVectorType< EcXmlString >, EcXmlVectorType< EcXmlStringPolygonVectorPair >, EcXmlVectorType< EcXmlStringStringPair >, EcXmlVectorType< EcXmlStringTriangleVectorPair >, EcXmlVectorType< EcXmlU32U32Pair >, EcXmlVectorType< EcXmlU32U32PairVector >, EcXmlVectorType< EcXmlU32Vector >, EcXmlVectorType< EcXmlU32VectorVector >, EcXmlVectorType< EcXmlVectorVector >, EcXmlVectorType< HardwareCalibrationPoint >, EcXmlVectorType< WaypointPathPair >, and EcXmlVectorVector.

Public Member Functions

 ECDECLARE_BIGFOUR (EcXmlObject)
 
virtual EcXmlObjectclone () const =0
 clone
 
virtual EcBoolean xmlInit ()
 xml-initialize
 
virtual EcBoolean read (EcXmlReader &stream)
 read this object from an XML stream
 
virtual EcBoolean readAttribute (EcXmlReader &stream)
 read this attribute from an XML stream
 
virtual EcBoolean write (EcXmlWriter &stream) const
 write this object to an XML stream
 
virtual EcBoolean writeSchema (EcXmlSchema &stream) const
 write the schema for this object to 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

EcU8 m_State
 the state of the object - eight boolean flags
 

Static Protected Attributes

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

A base class for xml objects.

EcXmlObject is a base class that defines the common interface for all XML objects in Actin with read, write,and xml-init functions. It contains a collection of methods used to assist in serialization of a class instance.

Examples:
ecCustomTypeLink.cpp, and ecXmlMain.cpp.

Definition at line 23 of file ecXmlObject.h.

Member Function Documentation

EcXmlObject::ECDECLARE_BIGFOUR ( EcXmlObject  )

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


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