DtSimArtPartDescriptor Class Reference

A readable, writable type that holds an articulated part type, attached-to part type, attachment point, and a list of art-part params (DtSimArtPartParamList). More...

Inheritance diagram for DtSimArtPartDescriptor:

Public Member Functions
	DtSimArtPartDescriptor (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSimArtPartDescriptor (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSimArtPartDescriptor (const DtString &partName, const DtSimArtPartDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtSimArtPartDescriptor (const DtSymbolString &partName, const DtSimArtPartDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtSimArtPartDescriptor &	operator= (const DtSimArtPartDescriptor &orig)
	assignment
virtual	~DtSimArtPartDescriptor ()
virtual DtSimArtPartDescriptor *	clone (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtSimArtPartDescriptor *	clone (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setParamList (const DtSimArtPartParamList &paramList)
	Accessor/mutator for myParamList.
virtual const DtSimArtPartParamList &	paramList () const
virtual void	setPartType (DtArtPartType partType)
	Accessor/mutator for myPartType.
virtual DtArtPartType	partType () const
virtual void	setParentPartType (DtArtPartType partType)
	Accessor/mutator for myParentPartType.
virtual DtArtPartType	parentPartType () const
virtual void	setAttachPoint (const DtVector &attachPoint)
	Accessor/mutator for myAttachPoint.
virtual const DtVector &	attachPoint () const
virtual DtReal	azimuthNeutralOffset () const
	Accessor/mutator for myAzimuthNeutralOffset.
virtual void	setAzimuthNeutralOffset (DtReal offset)
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 DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &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	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
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 char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () 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 void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () 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.

Protected Member Functions
	DtSimArtPartDescriptor ()
	default constructor
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
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myPartType
	Parameter Name: art-part-type Parameter Description: The type of an articulated part.
DtRwInt	myParentPartType
	Parameter Name: parent-part-type Parameter Description: The type of the object to which an articulated part is attached.
DtRwOffsetVector	myAttachPoint
	Parameter Name: attach-point Parameter Description: The point at which at the articulated or attached part is attached to another object.
DtSimArtPartParamList	myParamList
	Parameter Name: art-part-param-list Parameter Description: List of the VR-Link articulated part parameters that are published for this part.
DtRwReal	myAzimuthNeutralOffset
	Parameter Name: azimuth-neutral-offset Parameter Description: Sets and gets the neutral azimuth offset.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
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 Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
	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 DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	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 Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent

Detailed Description

A readable, writable type that holds an articulated part type, attached-to part type, attachment point, and a list of art-part params (DtSimArtPartParamList).

The read/write name is not used for anything in particular, and therefore may be used for file readability.

Constructor & Destructor Documentation

DtSimArtPartDescriptor::DtSimArtPartDescriptor ( )

protected

default constructor

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtString &	partName,
		const DtSimArtPartDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtSymbolString &	partName,
		const DtSimArtPartDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtSimArtPartDescriptor::~DtSimArtPartDescriptor ( )

virtual

Member Function Documentation

DtSimArtPartDescriptor& DtSimArtPartDescriptor::operator=

(

const DtSimArtPartDescriptor &

orig

)

assignment

virtual DtSimArtPartDescriptor* DtSimArtPartDescriptor::clone ( const DtString &  partName, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual DtSimArtPartDescriptor* DtSimArtPartDescriptor::clone ( const DtSymbolString &  partName, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual void DtSimArtPartDescriptor::setParamList ( const DtSimArtPartParamList &  paramList )

virtual

Accessor/mutator for myParamList.

virtual const DtSimArtPartParamList& DtSimArtPartDescriptor::paramList ( ) const

virtual

virtual void DtSimArtPartDescriptor::setPartType ( DtArtPartType  partType )

virtual

Accessor/mutator for myPartType.

virtual DtArtPartType DtSimArtPartDescriptor::partType ( ) const

virtual

virtual void DtSimArtPartDescriptor::setParentPartType ( DtArtPartType  partType )

virtual

Accessor/mutator for myParentPartType.

virtual DtArtPartType DtSimArtPartDescriptor::parentPartType ( ) const

virtual

virtual void DtSimArtPartDescriptor::setAttachPoint ( const DtVector &  attachPoint )

virtual

Accessor/mutator for myAttachPoint.

virtual const DtVector& DtSimArtPartDescriptor::attachPoint ( ) const

virtual

virtual DtReal DtSimArtPartDescriptor::azimuthNeutralOffset ( ) const

virtual

Accessor/mutator for myAzimuthNeutralOffset.

virtual void DtSimArtPartDescriptor::setAzimuthNeutralOffset ( DtReal  offset )

virtual

Member Data Documentation

DtRwInt DtSimArtPartDescriptor::myPartType

protected

Parameter Name: art-part-type Parameter Description: The type of an articulated part.

For the list of available values see the DIS Enumeration Document (Enumeration and Bit Encoded Values for Use with Protocols for DIS Applications).

DtRwInt DtSimArtPartDescriptor::myParentPartType

protected

Parameter Name: parent-part-type
Parameter Description: The type of the object to which an articulated part is attached.

For the list of available values see the DIS Enumeration Document (Enumeration and Bit Encoded Values for Use with Protocols for DIS Applications).
Parameter Default Value: 0

DtRwOffsetVector DtSimArtPartDescriptor::myAttachPoint

protected

Parameter Name: attach-point Parameter Description: The point at which at the articulated or attached part is attached to another object.

If this part is being attached to an entity, then the attach-point is is specified in the body coordinate system of the entity. If part is being attached to another attached or articulated part, then the attach-point is specified in the body coordinate system of the part it is being attached to. In a body coordinate system, the axes are specified as follows:

• x-axis points out of the 'front' of the object
  
• y-axis points out of the 'side' of the object
  
• z-axis points out of the 'bottom' of the object Parameter Default Value: (0. 0. 0.) Parameter Units: meters

DtSimArtPartParamList DtSimArtPartDescriptor::myParamList

protected

Parameter Name: art-part-param-list
Parameter Description: List of the VR-Link articulated part parameters that are published for this part.

Parameter names (enumerated values) refer to attributes, e.g. X (parameter 1), X rate (parameter 2), azimuth (parameter 11), azimuth rate (parameter 12), and so forth. Parameter Default Value:

DtRwReal DtSimArtPartDescriptor::myAzimuthNeutralOffset

protected

Parameter Name: azimuth-neutral-offset
Parameter Description: Sets and gets the neutral azimuth offset.

This angle represents the difference between the entity's heading and the neutral (or default) orientation of the weapon in the reference (network) representation. The 3D model for this entity is of course assumed to be using the same reference. For instance if you have a gun on the back of a ship which is designed to fire backwards and which is pointing toward the stern when the gun is in the neutral position (in the reference model and the 3D model), the azimuth-neutral-offset should be set to pi. This corresponds with the definition of the neutral position from section I.2.2.3 of the DIS IEEE Std 1278.1-2012.
Parameter Default Value: 0.0
Parameter Units: radians

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/simArtPartDescriptor.h