class DtLocalEntitySetControllerPSR:

Instances of DtLocalEntitySetControllerPSR are used to hold runtime variables for the DtLocalEntitySetController for checkpointing.

Inheritance diagram for DtLocalEntitySetControllerPSR:

[legend]

Public Member Functions
	DtLocalEntitySetControllerPSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

	DtLocalEntitySetControllerPSR (const DtLocalEntitySetControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)

virtual	~DtLocalEntitySetControllerPSR ()

DtLocalEntitySetControllerPSR &	operator= (const DtLocalEntitySetControllerPSR &orig)

virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const

virtual DtString	type () const


virtual bool	pendingSetLocationRequest () const

virtual void	setPendingSetLocationRequest (bool requestPending)


virtual DtVector	pendingSetLocation () const

virtual void	setPendingSetLocation (DtVector geocentricLocation)


virtual bool	pendingKeepGroundClamped () const

virtual void	setPendingKeepGroundClamped (bool)


virtual bool	pendingSetHeadingRequest () const

virtual void	setPendingSetHeadingRequest (bool requestPending)


virtual DtReal	pendingSetHeading () const

virtual void	setPendingSetHeading (DtReal heading)

Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)

const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)

virtual	~DtVrfProcessStateRepository ()

virtual bool	init ()

virtual bool	loadedFromMTL () const

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

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 *	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	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 DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry)

Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()

static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)

static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)

static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry=0)

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
DtRwBoolean	myPendingSetLocationRequest

DtRwVector	myPendingSetLocation

DtRwBoolean	myPendingSetHeadingRequest

DtRwReal	myPendingSetHeading

DtRwBoolean	myPendingKeepGroundClamped

Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject

bool	myLoadedFromMTL

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

Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()

const DtSimObject *	vrfObject () const

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

Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

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

DtLocalEntitySetControllerPSR::DtLocalEntitySetControllerPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

DtLocalEntitySetControllerPSR::DtLocalEntitySetControllerPSR	(	const DtLocalEntitySetControllerPSR &	orig,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor - not implemented

virtual DtLocalEntitySetControllerPSR::~DtLocalEntitySetControllerPSR ( )

virtual

destructor

Member Function Documentation

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

assignment operator - not implemented

virtual DtVrfProcessStateRepository* DtLocalEntitySetControllerPSR::clone	(	const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtLocalEntitySetControllerPSR::type ( ) const

virtual

Returns DtVrfLocalEntitySetControllerProcessStateRepositoryType, as defined in procSRTypes.h.

Implements DtVrfProcessStateRepository.

virtual bool DtLocalEntitySetControllerPSR::pendingSetLocationRequest ( ) const

virtual

True if there is a set location request which is still pending on terrain for the requested location being paged in.

virtual void DtLocalEntitySetControllerPSR::setPendingSetLocationRequest ( bool requestPending )

virtual

True if there is a set location request which is still pending on terrain for the requested location being paged in.

virtual DtVector DtLocalEntitySetControllerPSR::pendingSetLocation ( ) const

virtual

Location of the pending set location request in geocentric coordinates.

virtual void DtLocalEntitySetControllerPSR::setPendingSetLocation ( DtVector geocentricLocation )

virtual

Location of the pending set location request in geocentric coordinates.

virtual bool DtLocalEntitySetControllerPSR::pendingKeepGroundClamped ( ) const

virtual

On placement from set location, keep ground clamped regardless of altitude in set location request.

virtual void DtLocalEntitySetControllerPSR::setPendingKeepGroundClamped ( bool )

virtual

On placement from set location, keep ground clamped regardless of altitude in set location request.

virtual bool DtLocalEntitySetControllerPSR::pendingSetHeadingRequest ( ) const

virtual

True if there is a set location request which is still pending on terrain for the requested location being paged in.

virtual void DtLocalEntitySetControllerPSR::setPendingSetHeadingRequest ( bool requestPending )

virtual

True if there is a set location request which is still pending on terrain for the requested location being paged in.

virtual DtReal DtLocalEntitySetControllerPSR::pendingSetHeading ( ) const

virtual

Location of the pending set location request in geocentric coordinates.

virtual void DtLocalEntitySetControllerPSR::setPendingSetHeading ( DtReal heading )

virtual

Location of the pending set location request in geocentric coordinates.

static DtVrfProcessStateRepository* DtLocalEntitySetControllerPSR::creator	(	const DtString &	rwName,
		DtLocalObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwBoolean DtLocalEntitySetControllerPSR::myPendingSetLocationRequest

protected

Set by processSetLocation when terrain has not yet been paged in for the requested location.

DtRwVector DtLocalEntitySetControllerPSR::myPendingSetLocation

protected

When myPendingSetLocationRequest is set, the value from the message (in geocentric coordinates) is stored here.

DtRwBoolean DtLocalEntitySetControllerPSR::myPendingSetHeadingRequest

protected

Set by processSetHeading when terrain has not yet been paged in for the requested heading.

DtRwReal DtLocalEntitySetControllerPSR::myPendingSetHeading

protected

When myPendingSetHeadingRequest is set, the value from the message (in geocentric coordinates) is stored here.

DtRwBoolean DtLocalEntitySetControllerPSR::myPendingKeepGroundClamped

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation