Holds a position of some form. May be an absolute position, or a reference to another object.

Inheritance diagram for DtRwPositionReference:

Public Member Functions
	DtRwPositionReference ()

	DtRwPositionReference (DtSimulationServices , const DtString &name, DtReaderWriterRegistry parentRegistry=nullptr)

	DtRwPositionReference (DtSimulationServices , const DtSymbolString &name, DtReaderWriterRegistry parentRegistry=nullptr)

	DtRwPositionReference (const DtRwPositionReference &orig, DtReaderWriterRegistry *parentRegistry)

	DtRwPositionReference (const DtRwPositionReference &orig)

DtRwPositionReference &	operator= (const DtRwPositionReference &orig)

virtual	~DtRwPositionReference ()

virtual bool	isValid () const

virtual DtVector	worldPosition () const

virtual DtVector	localPosition () const

virtual bool	isDeleted () const

virtual const DtUUID &	uuid () const

virtual const DtLocalVertexList &	localVertices () const

virtual DtString	objectName () const

virtual bool	haveVerticesChanged () const

virtual DtSimObjectReference	controlPoint () const

const DtRwPositionReference *	operator-> () const

virtual void	postGetSelf () override

bool	operator== (const DtRwPositionReference &) const

bool	operator!= (const DtRwPositionReference &rhs) const

bool	operator== (const DtVector &) const

bool	operator!= (const DtVector &rhs) const

bool	operator== (const DtSimObjectReference &) const

bool	operator!= (const DtSimObjectReference &rhs) const

bool	operator== (const DtUUID &) const

bool	operator!= (const DtUUID &rhs) const


virtual void	setObject (const DtUUID &object) override


virtual void	setVector (const DtVector &v) override

Public Member Functions inherited from DtRwLocationReference
	DtRwLocationReference ()

	DtRwLocationReference (const DtString &name, DtReaderWriterRegistry *parentRegistry=nullptr)

	DtRwLocationReference (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=nullptr)

	DtRwLocationReference (const DtRwLocationReference &orig)

DtRwLocationReference &	operator= (const DtRwLocationReference &orig)

virtual	~DtRwLocationReference ()

virtual const char *	readerWriterType () const override

virtual void	setAbsoluteLocation (const DtVector &worldLocation)

virtual void	setObjectLocation (const DtUUID &object)

virtual LocationType	locationType () const

virtual void	setLocationType (LocationType posType)

virtual DtUUID	object () const

virtual DtVector	vector () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
DtSimObjectReference	mySimObject

DtLocalVertexList	myLocalVertices

DtSimulationServices *	mySimulationServices = nullptr

DtVector	myOriginalVector

Protected Attributes inherited from DtRwLocationReference
DtRwInt	myLocationType

DtRwVector	myVector

DtRwUUID	myObject

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

bool	myInvalid

bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtRwLocationReference
enum	LocationType { Location_Absolute = 0, Location_Object = 1 }

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 DtRwLocationReference
static DtString	locationTypeString (LocationType posType)

static LocationType	stringToLocationType (const DtString &s, bool &valid)

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 ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtRwPositionReference::DtRwPositionReference ( )

DtRwPositionReference::DtRwPositionReference	(	DtSimulationServices *	,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `nullptr`
	)

DtRwPositionReference::DtRwPositionReference	(	DtSimulationServices *	,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `nullptr`
	)

DtRwPositionReference::DtRwPositionReference	(	const DtRwPositionReference &	orig,
		DtReaderWriterRegistry *	parentRegistry
	)

DtRwPositionReference::DtRwPositionReference ( const DtRwPositionReference & orig )

virtual DtRwPositionReference::~DtRwPositionReference ( )

virtual

Member Function Documentation

DtRwPositionReference& DtRwPositionReference::operator= ( const DtRwPositionReference & orig )

virtual void DtRwPositionReference::setObject ( const DtUUID & object )

overridevirtual

The UUID of an object referenced by this location. Only used in relevant LocationType types.

Reimplemented from DtRwLocationReference.

virtual void DtRwPositionReference::setVector ( const DtVector & v )

overridevirtual

A vector used for this location.

Note: The coordinate system and intended use of this vector varies depending on the locationType(). Assumes a geocentric vector

Reimplemented from DtRwLocationReference.

virtual bool DtRwPositionReference::isValid ( ) const

virtual

virtual DtVector DtRwPositionReference::worldPosition ( ) const

virtual

virtual DtVector DtRwPositionReference::localPosition ( ) const

virtual

virtual bool DtRwPositionReference::isDeleted ( ) const

virtual

virtual const DtUUID& DtRwPositionReference::uuid ( ) const

virtual

virtual const DtLocalVertexList& DtRwPositionReference::localVertices ( ) const

virtual

virtual DtString DtRwPositionReference::objectName ( ) const

virtual

virtual bool DtRwPositionReference::haveVerticesChanged ( ) const

virtual

If this is an absolute position, this will return true once if the last time the position was set is not equal to the original position.

virtual DtSimObjectReference DtRwPositionReference::controlPoint ( ) const

virtual

const DtRwPositionReference* DtRwPositionReference::operator-> ( ) const

inline

virtual void DtRwPositionReference::postGetSelf ( )

overridevirtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

bool DtRwPositionReference::operator== ( const DtRwPositionReference & ) const

bool DtRwPositionReference::operator!= ( const DtRwPositionReference & rhs ) const

inline

bool DtRwPositionReference::operator== ( const DtVector & ) const

bool DtRwPositionReference::operator!= ( const DtVector & rhs ) const

inline

bool DtRwPositionReference::operator== ( const DtSimObjectReference & ) const

bool DtRwPositionReference::operator!= ( const DtSimObjectReference & rhs ) const

inline

bool DtRwPositionReference::operator== ( const DtUUID & ) const

bool DtRwPositionReference::operator!= ( const DtUUID & rhs ) const

inline

Member Data Documentation

DtSimObjectReference DtRwPositionReference::mySimObject

protected

DtLocalVertexList DtRwPositionReference::myLocalVertices

protected

Only valid if the location is a point – this will contain the DtVector of that point.

DtSimulationServices* DtRwPositionReference::mySimulationServices = nullptr

protected

DtVector DtRwPositionReference::myOriginalVector

mutableprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/rwPositionReference.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation