DtMovementBasedTerrainPreloadControllerDescriptor Class Reference

Descriptor for the DtMovementBasedTerrainPreloadController class. More...

Inheritance diagram for DtMovementBasedTerrainPreloadControllerDescriptor:

Public Member Functions
	DtMovementBasedTerrainPreloadControllerDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtMovementBasedTerrainPreloadControllerDescriptor (const DtMovementBasedTerrainPreloadControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtMovementBasedTerrainPreloadControllerDescriptor ()
DtMovementBasedTerrainPreloadControllerDescriptor &	operator= (const DtMovementBasedTerrainPreloadControllerDescriptor &orig)
	assignment
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	geometryType () const
	Accessor/mutator for myGeometryType.
virtual void	setGeometryType (const DtString &type)
	Accessor/mutator for myGeometryType.
virtual double	minPreloadDistance () const
	Accessor/mutator for #myMinPreloadRadius.
virtual void	setMinPreloadDistance (double distance)
	Accessor/mutator for #myMinPreloadRadius.
virtual double	maxPreloadDistance () const
	Accessor/mutator for #myMaxPreloadRadius.
virtual void	setMaxPreloadDistance (double distance)
	Accessor/mutator for #myMaxPreloadRadius.
Public Member Functions inherited from DtTerrainPreloadControllerDescriptor
	DtTerrainPreloadControllerDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtTerrainPreloadControllerDescriptor (const DtTerrainPreloadControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtTerrainPreloadControllerDescriptor ()
DtTerrainPreloadControllerDescriptor &	operator= (const DtTerrainPreloadControllerDescriptor &orig)
	assignment
virtual int	preloadPriority () const
	Accessor/mutator for myPreloadPriority.
virtual void	setPreloadPriority (const int &priority)
	Accessor/mutator for myPreloadPriority.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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 (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtMovementBasedTerrainPreloadControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtTerrainPreloadControllerDescriptor
	DtTerrainPreloadControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myGeometryType
	Parameter Name: geometry-type Parameter Description: Type of geometry used to define the preload for this entity.
DtRwReal	myMinPreloadDistance
	Parameter Name: min-preload-distance Parameter Description: Minimum distance from the entity to preload terrain.
DtRwReal	myMaxPreloadDistance
	Parameter Name: max-preload-distance Parameter Description: Maximum distance from the entity to preload terrain.
Protected Attributes inherited from DtTerrainPreloadControllerDescriptor
DtRwInt	myPreloadPriority
	Parameter Name: preload-priority Parameter Description: Priority of preload commands generated by this entity relative to other terrain paging commands.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

Descriptor for the DtMovementBasedTerrainPreloadController class.

Contains parameters that can be specified in the parameter database for this controller.

Constructor & Destructor Documentation

DtMovementBasedTerrainPreloadControllerDescriptor::DtMovementBasedTerrainPreloadControllerDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

real constructor

DtMovementBasedTerrainPreloadControllerDescriptor::DtMovementBasedTerrainPreloadControllerDescriptor	(	const DtMovementBasedTerrainPreloadControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtMovementBasedTerrainPreloadControllerDescriptor::~DtMovementBasedTerrainPreloadControllerDescriptor ( )

virtual

DtMovementBasedTerrainPreloadControllerDescriptor::DtMovementBasedTerrainPreloadControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtMovementBasedTerrainPreloadControllerDescriptor& DtMovementBasedTerrainPreloadControllerDescriptor::operator=

(

const DtMovementBasedTerrainPreloadControllerDescriptor &

orig

)

assignment

virtual DtString DtMovementBasedTerrainPreloadControllerDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns

DtMovementBasedTerrainPreloadControllerDescriptorType

Reimplemented from DtTerrainPreloadControllerDescriptor.

virtual DtComponentDescriptor* DtMovementBasedTerrainPreloadControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtTerrainPreloadControllerDescriptor.

static DtComponentDescriptor* DtMovementBasedTerrainPreloadControllerDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtTerrainPreloadControllerDescriptor.

virtual DtString DtMovementBasedTerrainPreloadControllerDescriptor::geometryType ( ) const

virtual

Accessor/mutator for myGeometryType.

virtual void DtMovementBasedTerrainPreloadControllerDescriptor::setGeometryType ( const DtString &  type )

virtual

Accessor/mutator for myGeometryType.

virtual double DtMovementBasedTerrainPreloadControllerDescriptor::minPreloadDistance ( ) const

virtual

Accessor/mutator for #myMinPreloadRadius.

virtual void DtMovementBasedTerrainPreloadControllerDescriptor::setMinPreloadDistance ( double  distance )

virtual

Accessor/mutator for #myMinPreloadRadius.

virtual double DtMovementBasedTerrainPreloadControllerDescriptor::maxPreloadDistance ( ) const

virtual

Accessor/mutator for #myMaxPreloadRadius.

virtual void DtMovementBasedTerrainPreloadControllerDescriptor::setMaxPreloadDistance ( double  distance )

virtual

Accessor/mutator for #myMaxPreloadRadius.

Member Data Documentation

DtRwString DtMovementBasedTerrainPreloadControllerDescriptor::myGeometryType

protected

Parameter Name: geometry-type
Parameter Description: Type of geometry used to define the preload for this entity.

Parameter Values: "sphere" "chord" Parameter Default Value: "chord"

DtRwReal DtMovementBasedTerrainPreloadControllerDescriptor::myMinPreloadDistance

protected

Parameter Name: min-preload-distance
Parameter Description: Minimum distance from the entity to preload terrain.

This distance will be used when the entity is stopped, or moving slowly. Parameter Units: meters Parameter Default Value: 2.0

DtRwReal DtMovementBasedTerrainPreloadControllerDescriptor::myMaxPreloadDistance

protected

Parameter Name: max-preload-distance
Parameter Description: Maximum distance from the entity to preload terrain.

This will cap the preload distance to this value when the entity is moving quickly. Parameter Units: meters Parameter Default Value: 1000.0

---

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

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