DtTerrainInterfaceConfig Class Reference

Class DtTerrainInterfaceConfig is a readable-writable class holding terrain interface configuration options. More...

Inheritance diagram for DtTerrainInterfaceConfig:

Public Member Functions
	DtTerrainInterfaceConfig (const DtTerrainInterfaceConfig &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtTerrainInterfaceConfig &	operator= (const DtTerrainInterfaceConfig &orig)
	assignment
virtual	~DtTerrainInterfaceConfig ()
	Destructor.
virtual const int	maxFeatureNetworkThreads () const
virtual const int	maxUnusedFeatures () const
virtual const int	obstaclePageTableLoadingThreads () const
virtual const int	perSourcePageTableDepth () const
virtual const int	obstaclePageTableDepth () const
virtual const int	pathFinderMaxSize () const
virtual const int	pathFinderTileSize () const
virtual const double	pathFinderLoadTimeout () const
virtual const double	pathFinderVertexTolerance () const
	DtTerrainInterfaceConfig (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor.
	DtTerrainInterfaceConfig (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor.
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.

Protected Attributes
DtRwInt	myMaxNetworkThreads
	Parameter Name: max-feature-network-threads Parameter Description: The max number of background threads that will be used to read streaming feature data.
DtRwInt	myMaxUnusedFeatures
	Parameter Name: max-unused-features Parameter Description: Max number of unused features to store in memory.
DtRwInt	myObstaclePageTableLoadingThreads
	Parameter Name: obstacle-page-table-threads Parameter Description: Max number of simultaneous threads that will be used for executing feature loading tasks for obstacle features.
DtRwInt	myPerSourcePageTableDepth
	Parameter Name: per-source-page-table-depth Parameter Description: The depth of the Quad-Tree used for tracking loaded features for each feature source.
DtRwInt	myObstaclePageTableDepth
	Parameter Name: obstacle-page-table-depth Parameter Description: The depth of the Quad-Tree used for tracking loaded features for each obstacle feature set.
DtRwInt	myPathFinderMaxSize
	Parameter Name: pathfinder-max-features Parameter Description: The max size of a DtPathFinder.
DtRwInt	myPathFinderTileSize
	Parameter Name: pathfinder-tile-size Parameter Description: The length (in meters) of each side of the path finder's grid tiles.
DtRwReal	myPathFinderLoadTimeout
	Parameter Name: pathfinder-load-timeout Parameter Description: The amount of time (in seconds) that the path finder will wait on loading a tile of features before giving up on that tile.
DtRwReal	myPathFinderVertexTolerance
	Parameter Name: pathfinder-vertex-tolerance Parameter Description: The distance tolerance (in meters) within which feature vertices are considered to be the same vertex.
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.

Private Member Functions
	DtTerrainInterfaceConfig ()
	default constructor; not implemented

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 Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
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 void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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

Detailed Description

Class DtTerrainInterfaceConfig is a readable-writable class holding terrain interface configuration options.

This class lives in vrfutil so that it is not necessary to depend on terrain interface to use this config object. These configuration options cannot be changed at runtime.

Constructor & Destructor Documentation

DtTerrainInterfaceConfig::DtTerrainInterfaceConfig	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor.

DtTerrainInterfaceConfig::DtTerrainInterfaceConfig	(	const DtSymbolString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor.

DtTerrainInterfaceConfig::DtTerrainInterfaceConfig	(	const DtTerrainInterfaceConfig &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

Parameters

orig	DtTerrainInterfaceConfig to copy.
parentRegistry	The registry of the DtReaderWriter object to which this object belongs.

virtual DtTerrainInterfaceConfig::~DtTerrainInterfaceConfig ( )

virtual

Destructor.

DtTerrainInterfaceConfig::DtTerrainInterfaceConfig ( )

private

default constructor; not implemented

Member Function Documentation

DtTerrainInterfaceConfig& DtTerrainInterfaceConfig::operator=

(

const DtTerrainInterfaceConfig &

orig

)

assignment

virtual const int DtTerrainInterfaceConfig::maxFeatureNetworkThreads ( ) const

inlinevirtual

virtual const int DtTerrainInterfaceConfig::maxUnusedFeatures ( ) const

inlinevirtual

virtual const int DtTerrainInterfaceConfig::obstaclePageTableLoadingThreads ( ) const

inlinevirtual

virtual const int DtTerrainInterfaceConfig::perSourcePageTableDepth ( ) const

inlinevirtual

virtual const int DtTerrainInterfaceConfig::obstaclePageTableDepth ( ) const

inlinevirtual

virtual const int DtTerrainInterfaceConfig::pathFinderMaxSize ( ) const

inlinevirtual

virtual const int DtTerrainInterfaceConfig::pathFinderTileSize ( ) const

inlinevirtual

virtual const double DtTerrainInterfaceConfig::pathFinderLoadTimeout ( ) const

inlinevirtual

virtual const double DtTerrainInterfaceConfig::pathFinderVertexTolerance ( ) const

inlinevirtual

Member Data Documentation

DtRwInt DtTerrainInterfaceConfig::myMaxNetworkThreads

protected

Parameter Name: max-feature-network-threads
Parameter Description: The max number of background threads that will be used to read streaming feature data.

Parameter Default Value: 4

DtRwInt DtTerrainInterfaceConfig::myMaxUnusedFeatures

protected

Parameter Name: max-unused-features
Parameter Description: Max number of unused features to store in memory.

Once this threshold has been reached, unused features will be paged out
until the number is below this threshold. Parameter Default Value: 500000

DtRwInt DtTerrainInterfaceConfig::myObstaclePageTableLoadingThreads

protected

Parameter Name: obstacle-page-table-threads Parameter Description: Max number of simultaneous threads that will be
used for executing feature loading tasks for obstacle features.

Parameter Default Value: 8

DtRwInt DtTerrainInterfaceConfig::myPerSourcePageTableDepth

protected

Parameter Name: per-source-page-table-depth Parameter Description: The depth of the Quad-Tree used for tracking
loaded features for each feature source.

Parameter Default Value: 13

DtRwInt DtTerrainInterfaceConfig::myObstaclePageTableDepth

protected

Parameter Name: obstacle-page-table-depth Parameter Description: The depth of the Quad-Tree used for tracking
loaded features for each obstacle feature set.

Parameter Default Value: 13

DtRwInt DtTerrainInterfaceConfig::myPathFinderMaxSize

protected

Parameter Name: pathfinder-max-features Parameter Description: The max size of a DtPathFinder.

Once a path
finder has exceeded this number of loaded features, it will be deleted,
to be recreated the next time a path plan is requested. Parameter Default Value: 50000

DtRwInt DtTerrainInterfaceConfig::myPathFinderTileSize

protected

Parameter Name: pathfinder-tile-size Parameter Description: The length (in meters) of each side of the path
finder's grid tiles.

This determines how frequently the path finder has
to load new features. Parameter Default Value: 1000 Parameter Units: meters

DtRwReal DtTerrainInterfaceConfig::myPathFinderLoadTimeout

protected

Parameter Name: pathfinder-load-timeout Parameter Description: The amount of time (in seconds) that the path finder
will wait on loading a tile of features before giving up on that tile.

Parameter Default Value: 20 Parameter Units: seconds

DtRwReal DtTerrainInterfaceConfig::myPathFinderVertexTolerance

protected

Parameter Name: pathfinder-vertex-tolerance Parameter Description: The distance tolerance (in meters) within which
feature vertices are considered to be the same vertex.

Used when features
are added to the DtPathFinder's graph. Parameter Default Value: 1.0 Parameter Units: meters

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/terrainInterfaceConfig.h