DtVrfObjectLocalObjectFacade Class Reference

Inheritance diagram for DtVrfObjectLocalObjectFacade:

Public Member Functions
	DtVrfObjectLocalObjectFacade (DtLocalObject *, const DtLoadScenarioData &)
virtual	~DtVrfObjectLocalObjectFacade ()
virtual void	save (std::string &)
virtual bool	restore (const std::string &)
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual std::string	archiveState ()
virtual void	setupSimulationObjectGeometryGroup (int flags, const DtVector &geocentricOffsetLocation, double offsetRotation)
virtual DtVrfSimulationObjectGroupGeometry *	takeSimulationObjectGroupGeometry ()
virtual DtLocalObject *	localObject () const
virtual bool	hasSimulationObjectGroup () const
Public Member Functions inherited from DtLocalObjectFacadeBase
	DtLocalObjectFacadeBase (DtLocalObject *)
virtual	~DtLocalObjectFacadeBase ()
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	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 *	readerWriterType () const
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	wasUpdatedSince (DtTime t) 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 DtVrfObjectLocalObjectFacadeCreatorFcn	setVrfObjectLocalObjectProcyCreatorFcn (DtVrfObjectLocalObjectFacadeCreatorFcn)
static DtVrfObjectLocalObjectFacadeCreatorFcn	vrfObjectLocalObjectFacadeCreatorFnc ()
static DtVrfObjectLocalObjectFacade *	create (DtLocalObject *, const DtLoadScenarioData &)
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
virtual void	setupDecorator ()
virtual void	prePutSelf ()
virtual void	postPutSelf ()
virtual void	preGetSelf ()
virtual void	postGetSelf ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwString	myObjectClassType
DtRwInt	myRwPublishFlag
DtRwEntityIdentifier	myObjectIdentifier
DtRwVrfObjectName	myObjectName
DtRwObjectType	myObjectType
DtRwUUID	myVrfObjectUUID
DtVrfSimulationObjectGroupGeometry *	mySimulationGroupGeometry
DtLoadScenarioData	myUserData
Protected Attributes inherited from DtLocalObjectFacadeBase
DtLocalObject *	myLocalObject
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

Static Protected Attributes
static DtVrfObjectLocalObjectFacadeCreatorFcn	theVrfObjectLocalObjectFacadeCreatorFcn
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

Private Member Functions
	DtVrfObjectLocalObjectFacade (const DtVrfObjectLocalObjectFacade &orig)
DtVrfObjectLocalObjectFacade &	operator= (const DtVrfObjectLocalObjectFacade &orig)

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

Constructor & Destructor Documentation

DtVrfObjectLocalObjectFacade::DtVrfObjectLocalObjectFacade	(	DtLocalObject *	,
		const DtLoadScenarioData &
	)

Creates a vrf object around the DtStateData represented by the id.

virtual DtVrfObjectLocalObjectFacade::~DtVrfObjectLocalObjectFacade ( )

virtual

destructor

DtVrfObjectLocalObjectFacade::DtVrfObjectLocalObjectFacade ( const DtVrfObjectLocalObjectFacade &  orig )

private

copy constructor

Member Function Documentation

virtual void DtVrfObjectLocalObjectFacade::save ( std::string &  )

virtual

Saves the object to the given std::string.

virtual bool DtVrfObjectLocalObjectFacade::restore ( const std::string &  )

virtual

Restores from given string buffer.

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

virtual

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.

virtual std::string DtVrfObjectLocalObjectFacade::archiveState ( )

virtual

Returned the current state of the object (as if putSelf were called)

virtual void DtVrfObjectLocalObjectFacade::setupSimulationObjectGeometryGroup ( int  flags, const DtVector &  geocentricOffsetLocation, double  offsetRotation  )

virtual

If this is going to be restored as part of a simulation object group, make this call.

virtual DtVrfSimulationObjectGroupGeometry* DtVrfObjectLocalObjectFacade::takeSimulationObjectGroupGeometry ( )

virtual

Takes the simulation object geometry group member. Caller must delete the memory as it will be detached from this class.

static DtVrfObjectLocalObjectFacadeCreatorFcn DtVrfObjectLocalObjectFacade::setVrfObjectLocalObjectProcyCreatorFcn ( DtVrfObjectLocalObjectFacadeCreatorFcn  )

static

For previous versions of VRF that might have had customer object loading, install your own creator to create a subclass of this DtVrfObjectLocalObjectFacade to override preGetSelf() to add custom items to the registry and postGetSelf() to remove them and then use their values.

static DtVrfObjectLocalObjectFacadeCreatorFcn DtVrfObjectLocalObjectFacade::vrfObjectLocalObjectFacadeCreatorFnc ( )

static

static DtVrfObjectLocalObjectFacade* DtVrfObjectLocalObjectFacade::create ( DtLocalObject *  , const DtLoadScenarioData &    )

static

virtual DtLocalObject* DtVrfObjectLocalObjectFacade::localObject ( ) const

virtual

virtual bool DtVrfObjectLocalObjectFacade::hasSimulationObjectGroup ( ) const

virtual

virtual void DtVrfObjectLocalObjectFacade::setupDecorator ( )

inlineprotectedvirtual

Called after setSimObjectReference, will set up any logic needed. Default is a no-op.

Reimplemented from DtLocalObjectFacadeBase.

virtual void DtVrfObjectLocalObjectFacade::prePutSelf ( )

protectedvirtual

Override to write out <use-default> string for unspecified parameters.

Reimplemented from DtReaderWriter.

virtual void DtVrfObjectLocalObjectFacade::postPutSelf ( )

protectedvirtual

Called after either version of put self (file or environment). Default is no-op.

Reimplemented from DtReaderWriter.

virtual void DtVrfObjectLocalObjectFacade::preGetSelf ( )

protectedvirtual

Override to do additional setup required when reading older oob, ovl files.

Reimplemented from DtReaderWriter.

virtual void DtVrfObjectLocalObjectFacade::postGetSelf ( )

protectedvirtual

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

Reimplemented from DtReaderWriter.

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

private

assignment operator

Member Data Documentation

DtRwString DtVrfObjectLocalObjectFacade::myObjectClassType

protected

DtRwInt DtVrfObjectLocalObjectFacade::myRwPublishFlag

protected

DtRwEntityIdentifier DtVrfObjectLocalObjectFacade::myObjectIdentifier

protected

DtRwVrfObjectName DtVrfObjectLocalObjectFacade::myObjectName

protected

DtRwObjectType DtVrfObjectLocalObjectFacade::myObjectType

protected

DtRwUUID DtVrfObjectLocalObjectFacade::myVrfObjectUUID

protected

DtVrfSimulationObjectGroupGeometry* DtVrfObjectLocalObjectFacade::mySimulationGroupGeometry

protected

DtVrfObjectLocalObjectFacadeCreatorFcn DtVrfObjectLocalObjectFacade::theVrfObjectLocalObjectFacadeCreatorFcn

staticprotected

DtLoadScenarioData DtVrfObjectLocalObjectFacade::myUserData

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/vrfObjectLocalObjectFacade.h