DtBhavePluginOptions Class Reference

Instances of DtBhaveAppOptions store options to be used by B-HAVE. More...

Inheritance diagram for DtBhavePluginOptions:

Public Member Functions
	DtBhavePluginOptions (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtBhavePluginOptions ()
	Destructor.
virtual bool	lifeformGenerateObstacleFeatures () const
	! The following functions are used for pathdata generation
virtual void	setLifeformGenerateObstacleFeatures (bool)
virtual bool	lifeformGeneratePathFeatures () const
virtual void	setLifeformGeneratePathFeatures (bool)
virtual bool	lifeformGenerateRoadSoilType () const
virtual void	setLifeformGenerateRoadSoilType (bool)
virtual double	lifeformEntityHeight () const
virtual void	setLifeformEntityHeight (double)
virtual double	lifeformEntityRadius () const
virtual void	setLifeformEntityRadius (double)
virtual double	lifeformGraphDensity () const
virtual void	setLifeformGraphDensity (double)
virtual double	lifeformSlopeMaximum () const
virtual void	setLifeformSlopeMaximum (double)
virtual double	lifeformStepMaximum () const
virtual void	setLifeformStepMaximum (double)
virtual double	lifeformRasterPrecision () const
virtual void	setLifeformRasterPrecision (double)
virtual bool	groundPlatformGenerateObstacleFeatures () const
virtual void	setGroundPlatformGenerateObstacleFeatures (bool)
virtual bool	groundPlatformGeneratePathFeatures () const
virtual void	setGroundPlatformGeneratePathFeatures (bool)
virtual bool	groundPlatformGenerateRoadSoilType () const
virtual void	setGroundPlatformGenerateRoadSoilType (bool)
virtual double	groundPlatformEntityHeight () const
virtual void	setGroundPlatformEntityHeight (double)
virtual double	groundPlatformEntityRadius () const
virtual void	setGroundPlatformEntityRadius (double)
virtual double	groundPlatformGraphDensity () const
virtual void	setGroundPlatformGraphDensity (double)
virtual double	groundPlatformSlopeMaximum () const
virtual void	setGroundPlatformSlopeMaximum (double)
virtual double	groundPlatformStepMaximum () const
virtual void	setGroundPlatformStepMaximum (double)
virtual double	groundPlatformRasterPrecision () const
virtual void	setGroundPlatformRasterPrecision (double)
virtual DtString	groundPlatformFilter () const
virtual void	setGroundPlatformFilter (DtString)
virtual DtString	lifeformFilter () const
virtual void	setLifeformFilter (DtString)
virtual DtString	groundPlatformWaterFilter () const
virtual void	setGroundPlatformWaterFilter (DtString)
virtual DtString	lifeformWaterFilter () const
virtual void	setLifeformWaterFilter (DtString)
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
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 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 Member Functions
	DtBhavePluginOptions (const DtBhavePluginOptions &orig)
	Copy constructor.
DtBhavePluginOptions &	operator= (const DtBhavePluginOptions &rhs)
	Assignment operator.
virtual bool	operator== (const DtBhavePluginOptions &) const
	Equal operator.
virtual bool	operator!= (const DtBhavePluginOptions &) const
	Difference operator.
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.

Protected Attributes
DtRwReal	myLFEntityHeight
DtRwReal	myLFEntityRadius
DtRwReal	myLFGraphDensity
DtRwReal	myLFSlopeMaximum
DtRwReal	myLFStepMaximum
DtRwReal	myLFRasterPrecision
DtRwReal	myGPEntityHeight
DtRwReal	myGPEntityRadius
DtRwReal	myGPGraphDensity
DtRwReal	myGPSlopeMaximum
DtRwReal	myGPStepMaximum
DtRwReal	myGPRasterPrecision
DtRwBoolean	myLFGenerateObstacleFeatures
DtRwBoolean	myGPGenerateObstacleFeatures
DtRwBoolean	myLFGeneratePathFeatures
DtRwBoolean	myGPGeneratePathFeatures
DtRwBoolean	myLFGenerateRST
DtRwBoolean	myGPGenerateRST
DtRwString	myGPFilter
DtRwString	myLFFilter
DtRwString	myGPWaterFilter
DtRwString	myLFWaterFilter
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
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 DtReaderWriterFactory *	factory ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

Instances of DtBhaveAppOptions store options to be used by B-HAVE.

Constructor & Destructor Documentation

DtBhavePluginOptions::DtBhavePluginOptions	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

Constructor.

virtual DtBhavePluginOptions::~DtBhavePluginOptions ( )

virtual

Destructor.

DtBhavePluginOptions::DtBhavePluginOptions ( const DtBhavePluginOptions &  orig )

protected

Copy constructor.

Member Function Documentation

virtual bool DtBhavePluginOptions::lifeformGenerateObstacleFeatures ( ) const

virtual

! The following functions are used for pathdata generation

Returns

virtual void DtBhavePluginOptions::setLifeformGenerateObstacleFeatures ( bool  )

virtual

virtual bool DtBhavePluginOptions::lifeformGeneratePathFeatures ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformGeneratePathFeatures ( bool  )

virtual

virtual bool DtBhavePluginOptions::lifeformGenerateRoadSoilType ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformGenerateRoadSoilType ( bool  )

virtual

virtual double DtBhavePluginOptions::lifeformEntityHeight ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformEntityHeight ( double  )

virtual

virtual double DtBhavePluginOptions::lifeformEntityRadius ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformEntityRadius ( double  )

virtual

virtual double DtBhavePluginOptions::lifeformGraphDensity ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformGraphDensity ( double  )

virtual

virtual double DtBhavePluginOptions::lifeformSlopeMaximum ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformSlopeMaximum ( double  )

virtual

virtual double DtBhavePluginOptions::lifeformStepMaximum ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformStepMaximum ( double  )

virtual

virtual double DtBhavePluginOptions::lifeformRasterPrecision ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformRasterPrecision ( double  )

virtual

virtual bool DtBhavePluginOptions::groundPlatformGenerateObstacleFeatures ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformGenerateObstacleFeatures ( bool  )

virtual

virtual bool DtBhavePluginOptions::groundPlatformGeneratePathFeatures ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformGeneratePathFeatures ( bool  )

virtual

virtual bool DtBhavePluginOptions::groundPlatformGenerateRoadSoilType ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformGenerateRoadSoilType ( bool  )

virtual

virtual double DtBhavePluginOptions::groundPlatformEntityHeight ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformEntityHeight ( double  )

virtual

virtual double DtBhavePluginOptions::groundPlatformEntityRadius ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformEntityRadius ( double  )

virtual

virtual double DtBhavePluginOptions::groundPlatformGraphDensity ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformGraphDensity ( double  )

virtual

virtual double DtBhavePluginOptions::groundPlatformSlopeMaximum ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformSlopeMaximum ( double  )

virtual

virtual double DtBhavePluginOptions::groundPlatformStepMaximum ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformStepMaximum ( double  )

virtual

virtual double DtBhavePluginOptions::groundPlatformRasterPrecision ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformRasterPrecision ( double  )

virtual

virtual DtString DtBhavePluginOptions::groundPlatformFilter ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformFilter ( DtString  )

virtual

virtual DtString DtBhavePluginOptions::lifeformFilter ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformFilter ( DtString  )

virtual

virtual DtString DtBhavePluginOptions::groundPlatformWaterFilter ( ) const

virtual

virtual void DtBhavePluginOptions::setGroundPlatformWaterFilter ( DtString  )

virtual

virtual DtString DtBhavePluginOptions::lifeformWaterFilter ( ) const

virtual

virtual void DtBhavePluginOptions::setLifeformWaterFilter ( DtString  )

virtual

DtBhavePluginOptions& DtBhavePluginOptions::operator= ( const DtBhavePluginOptions &  rhs )

protected

Assignment operator.

virtual bool DtBhavePluginOptions::operator== ( const DtBhavePluginOptions &  ) const

protectedvirtual

Equal operator.

virtual bool DtBhavePluginOptions::operator!= ( const DtBhavePluginOptions &  ) const

protectedvirtual

Difference operator.

Member Data Documentation

DtRwReal DtBhavePluginOptions::myLFEntityHeight

protected

DtRwReal DtBhavePluginOptions::myLFEntityRadius

protected

DtRwReal DtBhavePluginOptions::myLFGraphDensity

protected

DtRwReal DtBhavePluginOptions::myLFSlopeMaximum

protected

DtRwReal DtBhavePluginOptions::myLFStepMaximum

protected

DtRwReal DtBhavePluginOptions::myLFRasterPrecision

protected

DtRwReal DtBhavePluginOptions::myGPEntityHeight

protected

DtRwReal DtBhavePluginOptions::myGPEntityRadius

protected

DtRwReal DtBhavePluginOptions::myGPGraphDensity

protected

DtRwReal DtBhavePluginOptions::myGPSlopeMaximum

protected

DtRwReal DtBhavePluginOptions::myGPStepMaximum

protected

DtRwReal DtBhavePluginOptions::myGPRasterPrecision

protected

DtRwBoolean DtBhavePluginOptions::myLFGenerateObstacleFeatures

protected

DtRwBoolean DtBhavePluginOptions::myGPGenerateObstacleFeatures

protected

DtRwBoolean DtBhavePluginOptions::myLFGeneratePathFeatures

protected

DtRwBoolean DtBhavePluginOptions::myGPGeneratePathFeatures

protected

DtRwBoolean DtBhavePluginOptions::myLFGenerateRST

protected

DtRwBoolean DtBhavePluginOptions::myGPGenerateRST

protected

DtRwString DtBhavePluginOptions::myGPFilter

protected

DtRwString DtBhavePluginOptions::myLFFilter

protected

DtRwString DtBhavePluginOptions::myGPWaterFilter

protected

DtRwString DtBhavePluginOptions::myLFWaterFilter

protected

---

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

• include/bhaveUtil/bhavePluginOptions.h