VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtSimObjectStateRepository Class Reference

The DtSimObjectStateRepository is an abstract base class (ABC) for all state repositories. More...

Inheritance diagram for DtSimObjectStateRepository:
Inheritance graph
[legend]

Public Member Functions

 DtSimObjectStateRepository (DtVrfObject *simObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtSimObjectStateRepositoryoperator= (const DtSimObjectStateRepository &orig)
virtual ~DtSimObjectStateRepository ()
virtual
DtSimObjectStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString type () const
 returns DtSimObjectStateRepositoryType
virtual const int objectStateRepositorySubType () const
virtual bool init ()
 Our 'virtual' constructor. Calls all the create<>() methods.
virtual void updatePositionFromModelVertices ()
virtual void updateBVolFromModelVertices ()
virtual const DtObjectType & objectType () const
virtual void setObjectType (const DtObjectType &objectType)
virtual bool createKinematicState ()
 Creates a DtVrfKinematicState.
virtual DtVrfKinematicStatevrfKinematicState ()
virtual const DtVrfKinematicStatevrfKinematicState () const
virtual bool createObjectGeometry ()
virtual DtVrfObjectGeometryvrfObjectGeometry ()
virtual const DtVrfObjectGeometryvrfObjectGeometry () const
virtual bool createAttachments ()
virtual DtAttachmentManagerattachments ()
virtual const DtAttachmentManagerattachments () const
virtual
DtSimObjectStateRepository
parent ()
virtual const
DtSimObjectStateRepository
parent () const
virtual bool isEmbarkedOn (const DtString &parent) const
virtual void attachToParent (DtString parent)
 Looks up the parent state repository using the given echelon ID and puts it in a call to attachToParent.
virtual void attachToParent (DtSimObjectStateRepository *parent)
 Adds this state repository to the given parent's list of attached state repositories and updates myAttachedToRepository and myRootSimStateRepository.
virtual void detachFromParent ()
virtual const DtStringattachedToRepositoryName ()
virtual
DtSimObjectStateRepository
findRootSimStateRepository ()
virtual const
DtSimObjectStateRepository
findRootSimStateRepository () const
virtual void ancestorObjectChanged ()
virtual void putData (FILE *fp, int indentLevel=0)
 overridden to update myAttachedToRepositoryName before it gets written out
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Sets myAttachedToRepository after myAttachedToRepositoryName is read in.
virtual void preGetSelf ()
 Hook function called immediately prior to getSelf().
virtual void postGetSelf ()
 Hook function called immediately following getSelf().
virtual bool processCompleteAttachment (DtVrfObject *simObject)
virtual void processObjectAboutToBeRemovedCallback (DtVrfObject *simObject)
virtual class
DtVrfObjectStateRepository
toVrfObjectStateRepository ()
virtual class
DtVrfObjectStateRepository
toVrfObjectStateRepository () const
virtual void setCoordinateSystem (const Coordinate_System *coordinateSystem)
 Sets the coordinate system in myObjectGeometry and myKinematicState.
virtual DtVrfObjectvrfObject ()
virtual const DtVrfObjectvrfObject () const
virtual void setVrfObject (DtVrfObject *vrfObject)
virtual DtSimKinematicStatekinematicState ()
virtual const DtSimKinematicStatekinematicState () const
virtual DtVrfObjectGeometryobjectGeometry ()
virtual const DtVrfObjectGeometryobjectGeometry () const
virtual const DtVectorbodyPosition () const
 Now superseded by kinematic state parentCS functions.
virtual void setBodyPosition (const DtVector &pos)
 Formerly setMeInParent.
virtual void setBodyPosition (DtFloat64 x, DtFloat64 y, DtFloat64 z)
const DtDcm & bodyOrientationMatrix () const
 Formerly meToParent().
virtual void embarkOnParent (const DtString &parent)
 Embarks this entity on the specified parent.
virtual bool leftOf (const DtVector &localVector) const
virtual bool inside (const DtVector &point) const
virtual double distanceToLocalVector (const DtVector &localVector) const
 Returns the distance from a position in local.
const Coordinate_System * coordinateSystem () const
virtual void removeVertex (int iIndex)
 These routines simply call down to the kinematic state to get/set the results.
virtual void addLocalVertex (const DtVector &vertex)
 These routines simply call down to the kinematic state to get/set the results.
virtual void addLocalVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setLocalVertices (const DtLocalVertexList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setLocalVertices (const DtList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual const DtLocalVertexListlocalVertices () const
 These routines simply call down to the kinematic state to get/set the results.
virtual const
DtLocalVectorIterator
localVertexIterator () const
 These routines simply call down to the kinematic state to get/set the results.
virtual void addWorldVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setWorldVertices (const DtVertexList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual void setWorldVertices (const DtList &vertices, DtVector &newGeometricCenter)
 These routines simply call down to the kinematic state to get/set the results.
virtual const DtVertexListworldVertices () const
 These routines simply call down to the kinematic state to get/set the results.
virtual const DtRwVectorIteratorworldVertexIterator () const
 These routines simply call down to the kinematic state to get/set the results.
virtual void setRelativeVertices (const DtLocalVertexList &vertices)
 Access/modify vertices relative to to the parent to which this object is attached.
virtual void setRelativeVertices (const DtList &vertices)
 Access/modify vertices relative to to the parent to which this object is attached.
virtual const DtLocalVertexListrelativeVertices () const
 Access/modify vertices relative to to the parent to which this object is attached.
virtual const
DtLocalVectorIterator
relativeVertexIterator () const
 Access/modify vertices relative to to the parent to which this object is attached.
const DtVectorlocalPosition () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalPosition (const DtVector &pos)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorlocalVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalVelocity (const DtVector &vel)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorlocalAcceleration () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalAcceleration (const DtVector &acc)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorrelativeVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setRelativeVelocity (const DtVector &vel)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorrelativeAcceleration () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setRelativeAcceleration (const DtVector &acc)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtTaitBryan & localOrientation () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalOrientation (const DtTaitBryan &angles)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorworldPosition () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldPosition (const DtVector &pos)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorworldVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldVelocity (const DtVector &vel)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorworldAcceleration () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldAcceleration (const DtVector &acc)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtTaitBryan & worldOrientation () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setWorldOrientation (const DtTaitBryan &angles)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVectorrotationalVelocity () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setRotationalVelocity (const DtVector &rotationalVelocity)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtDcm & localOrientationMatrix () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalOrientationMatrix (const DtDcm &orient)
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value.
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static void completeAttachmentCallback (DtVrfObject *simObject, void *usr)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
static void objectAboutToBeRemovedCallback (DtVrfObject *simObject, void *usr)
static DtSimObjectStateRepositoryisSimObjectStateRepository (DtSimObjectStateRepository *repository)
static const
DtSimObjectStateRepository
isSimObjectStateRepository (const DtSimObjectStateRepository *repository)
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const chartheXmlType ()
 The type that is used when archiving to an XML stream.
static const DtFilename & appPath ()
 Gets the current working directory.
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static void cleanupFactory ()
static DtReaderWriterFactoryfactory ()
static DtReaderWritercreateFromXmlFile (const DtFilename &)
 Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromXml (const DtString &)
 Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP)
 Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP.
- Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType ObjectCount ()
static const DtObjectContainer * ObjectContainer ()

Protected Member Functions

 DtSimObjectStateRepository (const DtSimObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtSimObjectStateRepository ()
 Default Constructor; not implemented.
virtual void setOrientationRelativeToParent ()
 If attached to a parent, and a terrain database is present, set orientation relative to parent.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

DtVrfObjectmySimObject
DtRwObjectType myObjectType
DtVrfObjectGeometrymyObjectGeometry
DtVrfKinematicStatemyKinematicState
DtAttachmentManagermyAttachments
DtSimObjectStateRepositorymyAttachedToRepository
DtRwString myAttachedToRepositoryName
 used for reading & writing the name of myAttachedToRepository
DtSimObjectStateRepositorymyRootSimStateRepository
const Coordinate_System * myCoordinateSystemPtr
 Caches pointer to coordinate system so it can set it after myKinematic state is created.
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString > 
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::vector< DtFilename > SearchPaths
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static bool theCreatorFcnSet
static DtReaderWriterFactorytheFactory
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn

Detailed Description

The DtSimObjectStateRepository is an abstract base class (ABC) for all state repositories.

State repositories represent all information about an object that can arrive from or be transmitted over the DIS or HLA/RPR virtual network.

Constructor & Destructor Documentation

DtSimObjectStateRepository::DtSimObjectStateRepository ( DtVrfObject simObject,
const DtObjectType &  objectType,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
DtSimObjectStateRepository::DtSimObjectStateRepository ( const DtSimObjectStateRepository orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
protected
virtual DtSimObjectStateRepository::~DtSimObjectStateRepository ( )
virtual
DtSimObjectStateRepository::DtSimObjectStateRepository ( )
protected

Default Constructor; not implemented.

Member Function Documentation

const DtSimObjectStateRepository& DtSimObjectStateRepository::operator= ( const DtSimObjectStateRepository orig)
virtual DtSimObjectStateRepository* DtSimObjectStateRepository::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual
virtual DtString DtSimObjectStateRepository::type ( ) const
virtual
virtual const int DtSimObjectStateRepository::objectStateRepositorySubType ( ) const
virtual
Returns
DtSimObjectStateRepositorySubTypeBase

Reimplemented in DtVrfObjectStateRepository.

virtual bool DtSimObjectStateRepository::init ( )
virtual
virtual void DtSimObjectStateRepository::updatePositionFromModelVertices ( )
virtual

Reimplemented in DtVrfObjectStateRepository.

virtual void DtSimObjectStateRepository::updateBVolFromModelVertices ( )
virtual

Reimplemented in DtVrfObjectStateRepository.

virtual const DtObjectType& DtSimObjectStateRepository::objectType ( ) const
virtual
virtual void DtSimObjectStateRepository::setObjectType ( const DtObjectType &  objectType)
virtual
virtual bool DtSimObjectStateRepository::createKinematicState ( )
virtual

Creates a DtVrfKinematicState.

virtual DtVrfKinematicState* DtSimObjectStateRepository::vrfKinematicState ( )
virtual
virtual const DtVrfKinematicState* DtSimObjectStateRepository::vrfKinematicState ( ) const
virtual
virtual bool DtSimObjectStateRepository::createObjectGeometry ( )
virtual
virtual DtVrfObjectGeometry* DtSimObjectStateRepository::vrfObjectGeometry ( )
virtual
virtual const DtVrfObjectGeometry* DtSimObjectStateRepository::vrfObjectGeometry ( ) const
virtual
virtual bool DtSimObjectStateRepository::createAttachments ( )
virtual

Reimplemented in DtVrfObjectStateRepository.

virtual DtAttachmentManager* DtSimObjectStateRepository::attachments ( )
virtual
virtual const DtAttachmentManager* DtSimObjectStateRepository::attachments ( ) const
virtual
virtual DtSimObjectStateRepository* DtSimObjectStateRepository::parent ( )
virtual
virtual const DtSimObjectStateRepository* DtSimObjectStateRepository::parent ( ) const
virtual
virtual bool DtSimObjectStateRepository::isEmbarkedOn ( const DtString parent) const
virtual
virtual void DtSimObjectStateRepository::attachToParent ( DtString  parent)
virtual

Looks up the parent state repository using the given echelon ID and puts it in a call to attachToParent.

Reimplemented in DtVrfObjectStateRepository.

virtual void DtSimObjectStateRepository::attachToParent ( DtSimObjectStateRepository parent)
virtual

Adds this state repository to the given parent's list of attached state repositories and updates myAttachedToRepository and myRootSimStateRepository.

The parent coordinate system is zeroed out, making this object relative to the parent instead of relative to the world.

Reimplemented in DtVrfObjectStateRepository.

virtual void DtSimObjectStateRepository::detachFromParent ( )
virtual

Reimplemented in DtVrfObjectStateRepository.

virtual const DtString& DtSimObjectStateRepository::attachedToRepositoryName ( )
virtual
virtual DtSimObjectStateRepository* DtSimObjectStateRepository::findRootSimStateRepository ( )
virtual
virtual const DtSimObjectStateRepository* DtSimObjectStateRepository::findRootSimStateRepository ( ) const
virtual
virtual void DtSimObjectStateRepository::ancestorObjectChanged ( )
virtual
virtual void DtSimObjectStateRepository::putData ( FILE *  fp,
int  indentLevel = 0 
)
virtual

overridden to update myAttachedToRepositoryName before it gets written out

Reimplemented from DtReaderWriter.

Reimplemented in DtVrfObjectStateRepository.

virtual void DtSimObjectStateRepository::getSelf ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList variableBindings 
)
virtual
virtual void DtSimObjectStateRepository::preGetSelf ( )
inlinevirtual

Hook function called immediately prior to getSelf().

Reimplemented from DtReaderWriter.

Reimplemented in DtVrfAggregateStateRepository, and DtHumanStateRepository.

virtual void DtSimObjectStateRepository::postGetSelf ( )
inlinevirtual

Hook function called immediately following getSelf().

Reimplemented from DtReaderWriter.

Reimplemented in DtVrfAggregateStateRepository, and DtHumanStateRepository.

static void DtSimObjectStateRepository::completeAttachmentCallback ( DtVrfObject simObject,
void *  usr 
)
static

These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.

virtual bool DtSimObjectStateRepository::processCompleteAttachment ( DtVrfObject simObject)
virtual

Reimplemented in DtVrfObjectStateRepository.

static void DtSimObjectStateRepository::objectAboutToBeRemovedCallback ( DtVrfObject simObject,
void *  usr 
)
static

Reimplemented in DtVrfObjectStateRepository.

virtual void DtSimObjectStateRepository::processObjectAboutToBeRemovedCallback ( DtVrfObject simObject)
virtual

Reimplemented in DtVrfObjectStateRepository.

static DtSimObjectStateRepository* DtSimObjectStateRepository::isSimObjectStateRepository ( DtSimObjectStateRepository repository)
static
static const DtSimObjectStateRepository* DtSimObjectStateRepository::isSimObjectStateRepository ( const DtSimObjectStateRepository repository)
static
virtual class DtVrfObjectStateRepository* DtSimObjectStateRepository::toVrfObjectStateRepository ( )
virtual

Reimplemented in DtVrfObjectStateRepository.

virtual class DtVrfObjectStateRepository* DtSimObjectStateRepository::toVrfObjectStateRepository ( ) const
virtual

Reimplemented in DtVrfObjectStateRepository.

virtual void DtSimObjectStateRepository::setCoordinateSystem ( const Coordinate_System *  coordinateSystem)
virtual

Sets the coordinate system in myObjectGeometry and myKinematicState.

virtual DtVrfObject* DtSimObjectStateRepository::vrfObject ( )
virtual
virtual const DtVrfObject* DtSimObjectStateRepository::vrfObject ( ) const
virtual
virtual void DtSimObjectStateRepository::setVrfObject ( DtVrfObject vrfObject)
virtual
virtual DtSimKinematicState* DtSimObjectStateRepository::kinematicState ( )
virtual
virtual const DtSimKinematicState* DtSimObjectStateRepository::kinematicState ( ) const
virtual
virtual DtVrfObjectGeometry* DtSimObjectStateRepository::objectGeometry ( )
virtual
virtual const DtVrfObjectGeometry* DtSimObjectStateRepository::objectGeometry ( ) const
virtual
virtual const DtVector& DtSimObjectStateRepository::bodyPosition ( ) const
virtual

Now superseded by kinematic state parentCS functions.

Formerly meInParent.

virtual void DtSimObjectStateRepository::setBodyPosition ( const DtVector pos)
virtual

Formerly setMeInParent.

virtual void DtSimObjectStateRepository::setBodyPosition ( DtFloat64  x,
DtFloat64  y,
DtFloat64  z 
)
virtual
const DtDcm& DtSimObjectStateRepository::bodyOrientationMatrix ( ) const

Formerly meToParent().

virtual void DtSimObjectStateRepository::embarkOnParent ( const DtString parent)
virtual

Embarks this entity on the specified parent.

Ultimately calls attachToParent()

virtual void DtSimObjectStateRepository::removeVertex ( int  iIndex)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::addLocalVertex ( const DtVector vertex)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::addLocalVertex ( const DtVector vertex,
DtVector newGeometricCenter 
)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::setLocalVertices ( const DtLocalVertexList vertices,
DtVector newGeometricCenter 
)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::setLocalVertices ( const DtList &  vertices,
DtVector newGeometricCenter 
)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual const DtLocalVertexList& DtSimObjectStateRepository::localVertices ( ) const
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual const DtLocalVectorIterator& DtSimObjectStateRepository::localVertexIterator ( ) const
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::addWorldVertex ( const DtVector vertex,
DtVector newGeometricCenter 
)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::setWorldVertices ( const DtVertexList vertices,
DtVector newGeometricCenter 
)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::setWorldVertices ( const DtList &  vertices,
DtVector newGeometricCenter 
)
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual const DtVertexList& DtSimObjectStateRepository::worldVertices ( ) const
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual const DtRwVectorIterator& DtSimObjectStateRepository::worldVertexIterator ( ) const
virtual

These routines simply call down to the kinematic state to get/set the results.

See the kinematic state class for information on these routines

virtual void DtSimObjectStateRepository::setRelativeVertices ( const DtLocalVertexList vertices)
virtual

Access/modify vertices relative to to the parent to which this object is attached.

virtual void DtSimObjectStateRepository::setRelativeVertices ( const DtList &  vertices)
virtual

Access/modify vertices relative to to the parent to which this object is attached.

virtual const DtLocalVertexList& DtSimObjectStateRepository::relativeVertices ( ) const
virtual

Access/modify vertices relative to to the parent to which this object is attached.

virtual const DtLocalVectorIterator& DtSimObjectStateRepository::relativeVertexIterator ( ) const
virtual

Access/modify vertices relative to to the parent to which this object is attached.

virtual bool DtSimObjectStateRepository::leftOf ( const DtVector localVector) const
virtual
virtual bool DtSimObjectStateRepository::inside ( const DtVector point) const
virtual
const DtVector& DtSimObjectStateRepository::localPosition ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setLocalPosition ( const DtVector pos)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::localVelocity ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setLocalVelocity ( const DtVector vel)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::localAcceleration ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setLocalAcceleration ( const DtVector acc)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::relativeVelocity ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setRelativeVelocity ( const DtVector vel)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::relativeAcceleration ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setRelativeAcceleration ( const DtVector acc)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtTaitBryan& DtSimObjectStateRepository::localOrientation ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setLocalOrientation ( const DtTaitBryan &  angles)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::worldPosition ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setWorldPosition ( const DtVector pos)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::worldVelocity ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setWorldVelocity ( const DtVector vel)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::worldAcceleration ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setWorldAcceleration ( const DtVector acc)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtTaitBryan& DtSimObjectStateRepository::worldOrientation ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setWorldOrientation ( const DtTaitBryan &  angles)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtVector& DtSimObjectStateRepository::rotationalVelocity ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setRotationalVelocity ( const DtVector rotationalVelocity)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

const DtDcm& DtSimObjectStateRepository::localOrientationMatrix ( ) const

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

void DtSimObjectStateRepository::setLocalOrientationMatrix ( const DtDcm &  orient)

Convenience methods for accessing corresponding methods in DtVrfKinematicState.

virtual double DtSimObjectStateRepository::distanceToLocalVector ( const DtVector localVector) const
virtual

Returns the distance from a position in local.

If mySimObject is projected, this distance will be in 2D. If this object is projected and has multiple points, the distance will be the 2D distance from localPosition to the closest point along the closest edge. Otherwise it will be the distance between localPosition and the center point of the object.

const Coordinate_System* DtSimObjectStateRepository::coordinateSystem ( ) const
virtual void DtSimObjectStateRepository::setOrientationRelativeToParent ( )
protectedvirtual

If attached to a parent, and a terrain database is present, set orientation relative to parent.

Reimplemented in DtVrfObjectStateRepository.

Member Data Documentation

DtVrfObject* DtSimObjectStateRepository::mySimObject
protected
DtRwObjectType DtSimObjectStateRepository::myObjectType
protected
DtVrfObjectGeometry* DtSimObjectStateRepository::myObjectGeometry
protected
DtVrfKinematicState* DtSimObjectStateRepository::myKinematicState
protected
DtAttachmentManager* DtSimObjectStateRepository::myAttachments
protected
DtSimObjectStateRepository* DtSimObjectStateRepository::myAttachedToRepository
protected
DtRwString DtSimObjectStateRepository::myAttachedToRepositoryName
protected

used for reading & writing the name of myAttachedToRepository

DtSimObjectStateRepository* DtSimObjectStateRepository::myRootSimStateRepository
protected
const Coordinate_System* DtSimObjectStateRepository::myCoordinateSystemPtr
protected

Caches pointer to coordinate system so it can set it after myKinematic state is created.


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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)