Inheritance diagram for BHAVE::KynapseDescriptor:

Public Member Functions
	KynapseDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	KynapseDescriptor (const KynapseDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	All component descriptors must provide a valid copy constructor.
KynapseDescriptor &	operator= (const KynapseDescriptor &orig)
	All component descriptors must provide a valid assignment operator.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	All component descriptors must provide a valid clone function.
virtual	~KynapseDescriptor ()
	Destructor.
virtual DtString	type () const
	Returns the type of descriptor.
virtual void	setPublishDebugRoutes (bool val)
virtual bool	publishDebugRoutes () const
virtual void	setInitialMovementMode (const DtString &val)
	Indicates whether the initial movement mode of this entity is preferred or Free.
virtual const DtString	initalMovementMode () const

virtual void	setNearDistance (DtReal nearDistance)
	Accessor/mutator for myNearDistance.
virtual DtReal	nearDistance () const
	Accessor/mutator for myNearDistance.

virtual void	setApproachSpeed (DtReal approachSpeed)
	Accessor/mutator for myApproachSpeed.
virtual DtReal	approachSpeed () const
	Accessor/mutator for myApproachSpeed.

virtual void	setAtDistance (DtReal atDistance)
	Accessor/mutator for myAtDistance.
virtual DtReal	atDistance () const
	Accessor/mutator for myAtDistance.
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.
	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.
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.

Static Public Member Functions
static DtComponentDescriptor *	creator ()
	Creator function to be registered with DtComponentDescriptorFactory.
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
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.
DtRwBoolean	myPublishDebugRoutes
	Parameter Name: publish-debug-routes Parameter Description: Publish debug lines .
DtRwString	myInitialMovementMode
	Parameter Name: initial-movement-mode Parameter Description: The movement mode of the entity: free, avoid, or prefer-roads.
DtRwReal	myNearDistance
	Parameter Name: near-distance Parameter Description: The distance from a destination point at which an entity begins to slow down.
DtRwReal	myAtDistance
	Parameter Name: at-distance Parameter Description: The distance from a destination point at which an entity considers itself to be at the point.
DtRwReal	myApproachSpeed
	Parameter Name: approach-speed Parameter Description: Speed entity should go when approaching (near) its goal.
DtRwString	myBotClass
	Parameter Name: bot-class Parameter Description: The class of the Kynapse bot to be created by the B-HAVE factory.
DtPathSoilFactorList	myPathSoilFactorList
	Parameter Name: publish-debug-routes Parameter Description: Publish debug lines .
virtual void	setBotClass (DtRwString botclass)
	Accessor/mutator for myBotClass.
virtual DtRwString	botClass () const
	Parameter Name: publish-debug-routes Parameter Description: Publish debug lines .
virtual DtPathSoilFactorList &	pathSoilFactorList ()
	Parameter Name: publish-debug-routes Parameter Description: Publish debug lines .
virtual const DtPathSoilFactorList &	pathSoilFactorList () const
	Parameter Name: publish-debug-routes Parameter Description: Publish debug lines .
void	getSelf (DtlObjPtr args, const DtFilename &searchPath)
	Parameter Name: publish-debug-routes Parameter Description: Publish debug lines .

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
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
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.
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Constructor & Destructor Documentation

BHAVE::KynapseDescriptor::KynapseDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

real constructor

BHAVE::KynapseDescriptor::KynapseDescriptor	(	const KynapseDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

All component descriptors must provide a valid copy constructor.

virtual BHAVE::KynapseDescriptor::~KynapseDescriptor ( )

virtual

Destructor.

Member Function Documentation

KynapseDescriptor& BHAVE::KynapseDescriptor::operator= ( const KynapseDescriptor & orig )

All component descriptors must provide a valid assignment operator.

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

virtual

All component descriptors must provide a valid clone function.

Reimplemented from DtComponentDescriptor.

virtual DtString BHAVE::KynapseDescriptor::type ( ) const

virtual

Returns the type of descriptor.

This will be used to create the descriptor on read from an mtl file

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* BHAVE::KynapseDescriptor::creator ( )

static

Creator function to be registered with DtComponentDescriptorFactory.

Reimplemented from DtComponentDescriptor.

virtual void BHAVE::KynapseDescriptor::setPublishDebugRoutes ( bool val )

virtual

virtual bool BHAVE::KynapseDescriptor::publishDebugRoutes ( ) const

virtual

virtual void BHAVE::KynapseDescriptor::setInitialMovementMode ( const DtString & val )

virtual

Indicates whether the initial movement mode of this entity is preferred or Free.

This can be changed at runtime using the Set Movement Mode command to individual entities.

virtual const DtString BHAVE::KynapseDescriptor::initalMovementMode ( ) const

virtual

virtual void BHAVE::KynapseDescriptor::setNearDistance ( DtReal nearDistance )

virtual

Accessor/mutator for myNearDistance.

virtual DtReal BHAVE::KynapseDescriptor::nearDistance ( ) const

virtual

Accessor/mutator for myNearDistance.

virtual void BHAVE::KynapseDescriptor::setApproachSpeed ( DtReal approachSpeed )

virtual

Accessor/mutator for myApproachSpeed.

virtual DtReal BHAVE::KynapseDescriptor::approachSpeed ( ) const

virtual

Accessor/mutator for myApproachSpeed.

virtual void BHAVE::KynapseDescriptor::setAtDistance ( DtReal atDistance )

virtual

Accessor/mutator for myAtDistance.

virtual DtReal BHAVE::KynapseDescriptor::atDistance ( ) const

virtual

Accessor/mutator for myAtDistance.

virtual void BHAVE::KynapseDescriptor::setBotClass ( DtRwString botclass )

virtual

Accessor/mutator for myBotClass.

virtual DtRwString BHAVE::KynapseDescriptor::botClass ( ) const

virtual

Parameter Name: publish-debug-routes
Parameter Description: Publish debug lines .

Parameter Default Value: true.

virtual DtPathSoilFactorList& BHAVE::KynapseDescriptor::pathSoilFactorList ( )

virtual

Parameter Name: publish-debug-routes
Parameter Description: Publish debug lines .

Parameter Default Value: true.

virtual const DtPathSoilFactorList& BHAVE::KynapseDescriptor::pathSoilFactorList ( ) const

virtual

Parameter Name: publish-debug-routes
Parameter Description: Publish debug lines .

Parameter Default Value: true.

void BHAVE::KynapseDescriptor::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath
	)

Parameter Name: publish-debug-routes
Parameter Description: Publish debug lines .

Parameter Default Value: true.

Member Data Documentation

DtRwBoolean BHAVE::KynapseDescriptor::myPublishDebugRoutes

protected

Parameter Name: publish-debug-routes
Parameter Description: Publish debug lines .

Parameter Default Value: true.

DtRwString BHAVE::KynapseDescriptor::myInitialMovementMode

protected

Parameter Name: initial-movement-mode
Parameter Description: The movement mode of the entity: free, avoid, or prefer-roads.

Parameter Default Value: "free" .

DtRwReal BHAVE::KynapseDescriptor::myNearDistance

protected

Parameter Name: near-distance
Parameter Description: The distance from a destination point at which an entity begins to slow down.

Parameter Default Value: 25.
Parameter Units: meters

DtRwReal BHAVE::KynapseDescriptor::myAtDistance

protected

Parameter Name: at-distance Parameter Description: The distance from a destination point at which an entity considers itself to be at the point.

Parameter Default Value: 1. Parameter Units: meters

DtRwReal BHAVE::KynapseDescriptor::myApproachSpeed

protected

Parameter Name: approach-speed
Parameter Description: Speed entity should go when approaching (near) its goal.

Default is 2. m/s.
Parameter Default Value: 2.
Parameter Units: meters/second

DtRwString BHAVE::KynapseDescriptor::myBotClass

protected

Parameter Name: bot-class
Parameter Description: The class of the Kynapse bot to be created by the B-HAVE factory.

Parameter Default Value: "entity-bot".

DtPathSoilFactorList BHAVE::KynapseDescriptor::myPathSoilFactorList

protected

Parameter Name: publish-debug-routes
Parameter Description: Publish debug lines .

Parameter Default Value: true.

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

include/bhaveMsgs/kynapseDesc.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation