DtRwLocationReference Class Reference

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

Inheritance diagram for DtRwLocationReference:

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

Public Member Functions
	DtRwLocationReference ()
	DtRwLocationReference (const DtString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
	DtRwLocationReference (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
	DtRwLocationReference (const DtRwLocationReference &orig)
DtRwLocationReference &	operator= (const DtRwLocationReference &orig)
DtRwLocationReference &	operator= (const DtUUID &orig)
DtRwLocationReference &	operator= (const DtVector &orig)
DtString	markingText () const
	operator DtUUID () const
	operator DtVector () const
virtual	~DtRwLocationReference () override
virtual const char *	readerWriterType () const override
virtual void	setAbsoluteLocation (const DtVector &worldLocation)
virtual void	setObjectLocation (const DtUUID &object)
virtual DtString	stringRep () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual LocationType	locationType () const
virtual void	setLocationType (LocationType posType)
virtual DtUUID	object () const
virtual void	setObject (const DtUUID &object)
virtual DtVector	vector () const
virtual void	setVector (const DtVector &v)
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) const
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	postGetSelf ()
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)

Static Public Member Functions
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 Attributes
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

Friends
int	DtBufferSerialize::getSize (const DtRwLocationReference &val)
const char *	DtBufferSerialize::decode (DtRwLocationReference &val, const char *buffer)
char *	DtBufferSerialize::encode (const DtRwLocationReference &val, char *buffer)

Additional Inherited Members
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

Member Enumeration Documentation

enum DtRwLocationReference::LocationType

Enumerator
Location_Absolute
Location_Object	Location is an absolute geocentric coordinate specified in myVector.

Constructor & Destructor Documentation

DtRwLocationReference::DtRwLocationReference

(

)

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

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

DtRwLocationReference::DtRwLocationReference

(

const DtRwLocationReference &

orig

)

virtual DtRwLocationReference::~DtRwLocationReference ( )

overridevirtual

Member Function Documentation

static DtString DtRwLocationReference::locationTypeString ( LocationType  posType )

static

Returns a string for location type. (used in Lua)

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

static

Returns

The LocationType that corresponds to the passed in string.

Parameters

valid

will be true if the string was a valid location type.

DtRwLocationReference& DtRwLocationReference::operator=

(

const DtRwLocationReference &

orig

)

DtRwLocationReference& DtRwLocationReference::operator=

(

const DtUUID &

orig

)

DtRwLocationReference& DtRwLocationReference::operator=

(

const DtVector &

orig

)

DtString DtRwLocationReference::markingText

(

)

const

DtRwLocationReference::operator DtUUID

(

)

const

DtRwLocationReference::operator DtVector

(

)

const

virtual const char* DtRwLocationReference::readerWriterType ( ) const

overridevirtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

virtual LocationType DtRwLocationReference::locationType ( ) const

virtual

The type of location this object is specifying.

Note

The interpretation of the other parameters changes based on this enumeration.

virtual void DtRwLocationReference::setLocationType ( LocationType  posType )

virtual

The type of location this object is specifying.

Note

The interpretation of the other parameters changes based on this enumeration.

virtual DtUUID DtRwLocationReference::object ( ) const

virtual

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

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

virtual

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

Reimplemented in DtRwPositionReference.

virtual DtVector DtRwLocationReference::vector ( ) const

virtual

A vector used for this location.

Note

The coordinate system and intended use of this vector varies depending on the locationType().

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

virtual

A vector used for this location.

Note

The coordinate system and intended use of this vector varies depending on the locationType().

Reimplemented in DtRwPositionReference.

virtual void DtRwLocationReference::setAbsoluteLocation ( const DtVector &  worldLocation )

virtual

Convenience method for setting both locationType and vector at the same time.

virtual void DtRwLocationReference::setObjectLocation ( const DtUUID &  object )

virtual

Convenience method for setting both locationType and object at the same time.

virtual DtString DtRwLocationReference::stringRep ( ) const

virtual

Return a human readable string either as the marking text of the control point or the string of the location.

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

overridevirtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

Friends And Related Function Documentation

int DtBufferSerialize::getSize ( const DtRwLocationReference &  val )

friend

const char* DtBufferSerialize::decode ( DtRwLocationReference &  val, const char *  buffer  )

friend

char* DtBufferSerialize::encode ( const DtRwLocationReference &  val, char *  buffer  )

friend

Member Data Documentation

DtRwInt DtRwLocationReference::myLocationType

protected

Enumerated location type represented by this location.

DtRwVector DtRwLocationReference::myVector

protected

Raw vector data. This is used as different types of data depending on the location type.

DtRwUUID DtRwLocationReference::myObject

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/rwLocationReference.h