A readable, writable type whose name is the name of a component and that has a list of component names and port interfaces to connect to. More...

Inherits DtReaderWriter.

Public Member Functions

DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)

copy constructor More...

DtComponentDescriptor & operator= (const DtComponentDescriptor &orig)

assignment More...

virtual ~DtComponentDescriptor ()

virtual DtString type () const

Returns the type of component this descriptor describes. More...

virtual DtComponentDescriptor * clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual void putData (std::string &fp, int indentLevel=0)

Overrides base class putData to output our type. More...

virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

getData is just used to get us past the type in the data stream, since it's not actually stored. More...

virtual bool init ()

Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. More...

bool operator== (const DtComponentDescriptor &) const

constructor

Parameters

componentName	DtReaderWriter name of the component. This is the name of the descriptor entry as it appears in a parameter database file.
parentRegistry	The registry of the DtReaderWriter object to which this object belongs.

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. More...

virtual const DtString & componentType () const

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. More...

virtual bool tickPeriodUsesRealTime () const

virtual const DtString & processStateRepositoryName () const

Name which this component will assign to its PSR. More...

virtual void setProcessStateRepositoryName (const DtString &name)

virtual const DtString & processStateRepositoryType () const

Type of PSR this component will create. More...

virtual void setProcessStateRepositoryType (const DtString &type)

virtual void setIsEnabled (bool yesNo)

Is the component enabled or not. More...

virtual bool isEnabled () const

virtual void setDebugActive (bool active)

Should detailed debug info be printed for this component. More...

virtual bool debugActive () const

virtual void setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)

virtual DtReal minTaskVisualizationTickPeriod () const

virtual void setTaskVisualizationsEnabled (bool enabled)

virtual bool taskVisualizationsEnabled () const

virtual void setCreateComponent (bool yesNo)

Should the component be created or not. More...

virtual bool createComponent () const

virtual void setCreateOnRemoteObject (bool yesNo)

Whether or not this component is created on remote versions of the object. More...

virtual bool createOnRemoteObject () const

Public Member Functions inherited from DtReaderWriter

DtReaderWriter ()

default constructor More...

DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

pseudo-copy constructor More...

DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

copy constructor More...

const DtReaderWriter & operator= (const DtReaderWriter &orig)

assignment operator More...

bool operator== (const DtReaderWriter &) const

Equivalence operator. More...

bool operator!= (const DtReaderWriter &rhs)

virtual ~DtReaderWriter ()

destructor More...

virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

Top level call to write itself to file. More...

virtual void postPutSelf ()

Called after either version of put self (file or environment). Default is no-op. More...

virtual void prePutSelf ()

Called before either version of put self (file or environment). Default is no-op. More...

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

Top level to read itself from an input stream. More...

virtual void postGetSelf ()

Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void preGetSelf ()

Called before either version of get self (file or environment). Default is no-op. More...

virtual void writeSelf (std::string &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. More...

virtual DtSymbolString name () const

Accessor for name of this readable/writable object. More...

virtual void addAlias (const DtSymbolString &alias)

Add an alias as an alternative name for this object. More...

virtual void addAlias (const DtString &alias)

virtual bool hasAlias (const DtSymbolString &alias)

virtual const aliasContainer & aliases () const

virtual void setReadonly (bool flag)

Set read-only flag. More...

bool isReadonly () const

virtual void reset ()

For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int alignment () const

For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool variableIsBound () const

virtual void unbindVariable ()

Sets the myVariableIsBound flag to false. More...

virtual void setName (const DtString &)

Set the name of the object. More...

virtual const char * readerWriterType () const

Used to supply a string type that this reader writer type is. More...

virtual const char * xmlType () const

virtual DtString prettyPrint () const

Routine to return a human readable form of the reader/writer variable. More...

std::string debugText () const

virtual void bindVariables (DtVariableBindingsList variableBindings)

Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool hasVariableReference () const

Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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. More...

virtual void recordUpdateTime () const

Can be implemented in subclasses to stamp the time when updated. More...

virtual bool wasUpdatedSince (DtTime t) const

Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool changedSinceLastChecked ()

Returns true if this objects value has changed since the last time this function was called. More...

virtual bool peekChangedSinceLastChecked () const

Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void setValueSpecified (bool specified, bool recurse=false)

The specified flags are used for optional values. More...

virtual bool valueSpecified () const

virtual bool isVariableReference () const

Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void setIsVariableReference (bool value)

virtual void clearAllVariableReferenceFlags ()

Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString variableName () const

The variable name, if this object is a variable reference. More...

virtual void setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter * defaultRWValue () const

The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter * defaultRWValue ()

virtual void setDefaultRWValue (DtReaderWriter *)

Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

Give the stream, if the stream contains a default value then set it here. More...

const DtReaderWriterRegistry & registry () const

Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry & registry ()

virtual DtPropertyInterface * property ()

virtual const DtPropertyInterface * property () const

virtual DtString toXml () const

virtual DtRwVariableBindings * generateVariableBindings () const

Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool toXml (const DtFilename &) const

Writes contents of xml result to the given filename. More...

virtual bool fromXml (const DtString &)

Restores object from given xml string. Returns true if valid. More...

virtual bool fromXmlFile (const DtFilename &)

Restores object from given xml file. More...

virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const

Override to add attributes of actual data. More...

virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

Called when the item is a variable reference. More...

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

Gets data from the environment value. More...

virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...

virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Called when the item is a variable reference. More...

Static Public Member Functions
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. More...

static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e. More...

static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class. More...

static DtComponentDescriptor *	creator ()


static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor. More...

static void	setFactory (DtComponentDescriptorFactory *factory)

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Member Functions
	DtComponentDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component. More...

DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component. More...

DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. More...

DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. More...

DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. More...

DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component. More...

DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not. More...

DtRwBoolean	myDebug
	This parameter defaults to false. More...

DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations. More...

DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled. More...

DtRwBoolean	myCreateComponent

DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local. More...

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
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Static Protected Attributes
static DtComponentDescriptorFactory *	myFactory

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

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

Detailed Description

A readable, writable type whose name is the name of a component and that has a list of component names and port interfaces to connect to.

Developer Description: DtComponentDescriptor provides all the infrastructure needed to work with the component factory. It has setComponentType() and componentType() members for setting and inspecting the type of component being attached to the entity. The type() member function describes the type of the component descriptor to the component descriptor factory, as found in compDescTypes.h.

Examples using DtComponentDescriptor include

Constructor & Destructor Documentation

DtComponentDescriptor::DtComponentDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtComponentDescriptor::DtComponentDescriptor	(	const DtSymbolString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

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

copy constructor

Parameters

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

virtual DtComponentDescriptor::~DtComponentDescriptor ( )

virtual

DtComponentDescriptor::DtComponentDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

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

assignment

virtual DtString DtComponentDescriptor::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.

virtual DtComponentDescriptor* DtComponentDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

virtual

virtual void DtComponentDescriptor::setComponentType ( const DtString & componentType )

virtual

Type of DtSimComponent this descriptor is associated with.

Used to indicate what type of model component to create when creating an entity from parameters. Component type strings are defined in compTypes.h.

virtual const DtString& DtComponentDescriptor::componentType ( ) const

virtual

virtual void DtComponentDescriptor::putData	(	std::string &	fp,
		int	indentLevel = `0`
	)

virtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtComponentDescriptor::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

virtual

getData is just used to get us past the type in the data stream, since it's not actually stored.

Reimplemented from DtReaderWriter.

Reimplemented in DtNavTagTraversalControllerDescriptor.

virtual bool DtComponentDescriptor::init ( )

virtual

Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.

Reimplemented in DtOccupancyDirectorDescriptor, DtDamageAdjudicationComponentDescriptor, DtSuppressionActuatorDescriptor, DtFormationControllerDescriptor, and DtNonLethalDamageActuatorDescriptor.

virtual void DtComponentDescriptor::setMinTickPeriod ( DtReal minTickPeriod )

virtual

Minimum tick period for this component in seconds. Set to -1.0 by default (unspecified - tick at rate appropriate for frame mode).

virtual DtReal DtComponentDescriptor::minTickPeriod ( ) const

virtual

virtual void DtComponentDescriptor::setMinTickPeriodVariance ( DtReal minTickPeriodVariance )

virtual

Minimum tick period variance for this component in seconds. Set to -1.0 by default (unspecified).

virtual DtReal DtComponentDescriptor::minTickPeriodVariance ( ) const

virtual

virtual void DtComponentDescriptor::setTickPeriodUsesRealTime ( bool value )

virtual

Accessor/mutator for myTickPeriodUsesRealTime.

virtual bool DtComponentDescriptor::tickPeriodUsesRealTime ( ) const

virtual

virtual const DtString& DtComponentDescriptor::processStateRepositoryName ( ) const

virtual

Name which this component will assign to its PSR.

Names must be unique across all PSR names configured as part of an entity.

virtual void DtComponentDescriptor::setProcessStateRepositoryName ( const DtString & name )

virtual

virtual const DtString& DtComponentDescriptor::processStateRepositoryType ( ) const

virtual

Type of PSR this component will create.

PSR types are defined in procSRTypes.h.

virtual void DtComponentDescriptor::setProcessStateRepositoryType ( const DtString & type )

virtual

virtual void DtComponentDescriptor::setIsEnabled ( bool yesNo )

virtual

Is the component enabled or not.

virtual bool DtComponentDescriptor::isEnabled ( ) const

virtual

virtual void DtComponentDescriptor::setDebugActive ( bool active )

inlinevirtual

Should detailed debug info be printed for this component.

"Detailed" debug info can mean per-tick print info that is too verbose for the usual output, even when limited to the Debug notify level. In this case, it is best to dump data to the back-end console using DtWarn, rather than to the entity console using objectConsoleDebug. Printing to the back-end avoids trying to send volumes of data over the network to the front end.
This flag can be used in a component as follows:
code> if (myDescriptor->debugActive() &&
entity()->objectConsole()->notifyLevel() == DtNlDebug)
{
DtWarn("Stuff to dump this tick\n");
...
/code>
To activate this debug, put (debug-detail True) in any component descriptor (i.e., in a .sysdef file).

virtual bool DtComponentDescriptor::debugActive ( ) const

inlinevirtual

virtual void DtComponentDescriptor::setMinTaskVisualizationTickPeriod ( DtReal minTickPeriod )

virtual

Minimum tick period for this component's task visualizations in seconds. Set to -1.0 by default (unspecified - tick with every component tick).

virtual DtReal DtComponentDescriptor::minTaskVisualizationTickPeriod ( ) const

virtual

virtual void DtComponentDescriptor::setTaskVisualizationsEnabled ( bool enabled )

virtual

Whether task visualizations are enabled for this component. Default is enabled.

virtual bool DtComponentDescriptor::taskVisualizationsEnabled ( ) const

virtual

virtual void DtComponentDescriptor::setCreateComponent ( bool yesNo )

virtual

Should the component be created or not.

virtual bool DtComponentDescriptor::createComponent ( ) const

virtual

virtual void DtComponentDescriptor::setCreateOnRemoteObject ( bool yesNo )

virtual

Whether or not this component is created on remote versions of the object.

virtual bool DtComponentDescriptor::createOnRemoteObject ( ) const

virtual

static void DtComponentDescriptor::addComponentDescriptorCreatorFcn	(	const DtString &	type,
		DtComponentDescriptorCreatorFcn	fcn
	)

static

Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.

static DtComponentDescriptorFactory* DtComponentDescriptor::factory ( )

static

The factory for creating objects of type DtComponentDescriptor.

The factory is used to generate component descriptors on demand, when reading in parameter database files.

static void DtComponentDescriptor::setFactory ( DtComponentDescriptorFactory * factory )

static

static DtComponentDescriptor* DtComponentDescriptor::createComponentDescriptor	(	DtlObjPtr	mtlStream,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

static

Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.

a parameter database file).

Parameters

mtlStream	Input stream from an MTL file.
searchPath	Path at which any DtReaderWriterFile items should be searched for if encountered when parsing the mtlStream.

Returns: Newly created and initialized instance of this class, with data read in from the MTL stream.

static DtComponentDescriptor* DtComponentDescriptor::createComponentDescriptor ( const char * pName )

static

Creates and initializes a new instance of this class.

Parameters

pName DtReaderWriter name of the component. The name appears as the first string of a component descriptor

Returns: Newly created and initialized instance of this class.

static DtComponentDescriptor* DtComponentDescriptor::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.

bool DtComponentDescriptor::operator== ( const DtComponentDescriptor & ) const

Member Data Documentation

DtRwString DtComponentDescriptor::myComponentType

protected

Parameter Name: component-type
Parameter Description: String identifying type of component.

See Also: compDescTypes.h

DtRwReal DtComponentDescriptor::myMinTickPeriod

protected

Parameter Name: min-tick-period
Parameter Description: Average tick period for this component.

The tick period varies randomly each time the component is ticked. The period can range from T - V/2 to T + V/2, where T is the period and V is the variance (with a minimum of 0). The default is -1, which means as-fast-as-possible.
Parameter Default Value: -1.0
Parameter Units: seconds
Parameter Range: -1.0 (unspecified), positive real numbers

DtRwReal DtComponentDescriptor::myMinTickPeriodVariance

protected

Parameter Name: min-tick-period-variance
Parameter Description: A time range for the tick period.

The tick period varies randomly each time the component is ticked. The period can range from T - V/2 to T + V/2, where V is the variance (with a minimum of 0). The default is -1, which means zero.
Parameter Default Value: -1.0
Parameter Units: seconds
Parameter Range: -1.0 (as fast as possible), positive real numbers

DtRwBoolean DtComponentDescriptor::myTickPeriodUsesRealTime

protected

Parameter Name: tick-period-uses-real-time
Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick.

Note that a component with a non-zero tick period will not be ticked during a simulation pause if it uses simulation time (the default).
Parameter Default Value: False
Parameter Units: True/False

DtRwString DtComponentDescriptor::myProcessStateRepositoryName

protected

Parameter Name: process-state-repository-name
Parameter Description: Name of the process state repository associated with this component.

Process state repository names must be unique across all process state repository names configured for an entity.

DtRwString DtComponentDescriptor::myProcessStateRepositoryType

protected

Parameter Name: process-state-repository-type
Parameter Description: Type of the process state repository associated with this component.

Process state repository type are defined in procSRTypes.

DtRwBoolean DtComponentDescriptor::myIsEnabled

protected

Parameter Name: is-enabled
Parameter Description: Is the component enabled (allowed to tick) or not.

Parameter Default Value: True

DtRwBoolean DtComponentDescriptor::myDebug

protected

This parameter defaults to false.

If set true in a config file, lots of debug detail may be printed out, depending on what developers have put in the source code.

DtRwReal DtComponentDescriptor::myMinTaskVisualizationTickPeriod

protected

Parameter Name: min-task-visualization-tick-period
Parameter Description: Average tick period for this component's task visualizations.

The tick period varies randomly each time the component is ticked. The period can range from T - V/2 to T + V/2, where T is the period and V is the variance (with a minimum of 0). The default is -1, which means whenever the component is ticked.
Parameter Default Value: -1.0
Parameter Units: seconds
Parameter Range: -1.0 (unspecified), positive real numbers

DtRwBoolean DtComponentDescriptor::myTaskVisualizationsEnabled

protected

Parameter Name: task-visualizations-enabled
Parameter Description: Whether this component's task visualizations are enabled.

Parameter Default Value: True

DtRwBoolean DtComponentDescriptor::myCreateComponent

protected

DtRwBoolean DtComponentDescriptor::myCreateOnRemoteObject

protected

Parameter Name: create-on-remote-object
Parameter Description: If true, this component will be created on remote objects as well as local.

Parameter Default Value: False

DtComponentDescriptorFactory* DtComponentDescriptor::myFactory

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjparam/componentDescriptor.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation