DtVrfRadioDescriptor Class Reference

Descriptor base class for DtRadio instances. More...

Inheritance diagram for DtVrfRadioDescriptor:

Public Member Functions
	DtVrfRadioDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtVrfRadioDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVrfRadioDescriptor (const DtVrfRadioDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtVrfRadioDescriptor &	operator= (const DtVrfRadioDescriptor &orig)
	assignment
virtual	~DtVrfRadioDescriptor ()
virtual DtString	type () const
	Returns the type of this descriptor.
virtual DtVrfRadioDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type.
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.
virtual bool	init ()
	Base class init does nothing, but will be called by createSignaturePropagatorDescriptor(), allowing derived classes to do memory allocation if necessary.
bool	operator== (const DtVrfRadioDescriptor &) const
bool	operator!= (const DtVrfRadioDescriptor &rhs) const
virtual void	setRadioType (const DtString &typeString)
	See myRadioType.
virtual DtString	radioType () const
virtual void	setCommModelName (const DtString &name)
	See myCommModelName.
virtual DtString	commModelName () const
virtual void	setPublishTransmitter (bool value)
	See myPublishTransmitter.
virtual bool	publishTransmitter () const
virtual DtVrfRadioTransmitterParams &	transmitterParams ()
	Access the myTransmitterParams.
virtual const DtVrfRadioTransmitterParams &	transmitterParams () const
virtual bool	transmitterParamsSpecified () const
	Indicated whether or not any transmitter parameters were specified.
virtual void	setSampleRate (double value)
	See mySampleRate.
virtual double	sampleRate () const
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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.
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 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.
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.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtVrfRadioDescriptorFactory *	factory ()
	Factory used to generate new instances of DtRadioDescriptor objects, based on the types defined in signaturePropagatorDescTypes.h.
static void	setFactory (DtVrfRadioDescriptorFactory *factory)
static DtVrfRadioDescriptor *	creator ()
static DtVrfRadioDescriptor *	createRadioDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Uses the factory to create a new radio descriptor of the specified type.
static DtVrfRadioDescriptor *	createRadioDescriptor (const char *typeString)
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.
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 void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myRadioType
	Parameter Name: radio-type Parameter Description: String identifying type of radio object.
DtRwString	myCommModelName
	Parameter Name: comm-model-name Parameter Description: The name of the communication model which this radio is part of.
DtRwBoolean	myPublishTransmitter
	Parameter Name: publish-transmitter Parameter Description: Indicates whether or not this radio should publish a DIS/RPR transmitter object.
DtVrfRadioTransmitterParams	myTransmitterParams
	Parameter Name: transmitter-params Parameter Description: Parameters for the publishing of a DIS/RPR transmitter object in association with this radio.
DtRwReal	mySampleRate
	Parameter Name: sample-rate Parameter Description: Sample rate published in signal PDUs/interactions.
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.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Static Protected Attributes
static DtVrfRadioDescriptorFactory *	theFactory
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

Private Member Functions
	DtVrfRadioDescriptor ()
	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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

Detailed Description

Descriptor base class for DtRadio instances.

A descriptor tells what type of radio to create as well as any parameters for the radio.

Constructor & Destructor Documentation

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

real constructor

DtVrfRadioDescriptor::DtVrfRadioDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

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

copy constructor

virtual DtVrfRadioDescriptor::~DtVrfRadioDescriptor ( )

virtual

DtVrfRadioDescriptor::DtVrfRadioDescriptor ( )

private

default constructor; not implemented

Member Function Documentation

DtVrfRadioDescriptor& DtVrfRadioDescriptor::operator=

(

const DtVrfRadioDescriptor &

orig

)

assignment

virtual DtString DtVrfRadioDescriptor::type ( ) const

virtual

Returns the type of this descriptor.

Used to create the descriptor on read from an mtl file.

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

virtual

virtual void DtVrfRadioDescriptor::setRadioType ( const DtString &  typeString )

virtual

See myRadioType.

virtual DtString DtVrfRadioDescriptor::radioType ( ) const

virtual

virtual void DtVrfRadioDescriptor::setCommModelName ( const DtString &  name )

virtual

See myCommModelName.

virtual DtString DtVrfRadioDescriptor::commModelName ( ) const

virtual

virtual void DtVrfRadioDescriptor::setPublishTransmitter ( bool  value )

virtual

See myPublishTransmitter.

virtual bool DtVrfRadioDescriptor::publishTransmitter ( ) const

virtual

virtual DtVrfRadioTransmitterParams& DtVrfRadioDescriptor::transmitterParams ( )

virtual

Access the myTransmitterParams.

Non-const access to the transmitter parmas will set the specified flag to true.

virtual const DtVrfRadioTransmitterParams& DtVrfRadioDescriptor::transmitterParams ( ) const

virtual

virtual bool DtVrfRadioDescriptor::transmitterParamsSpecified ( ) const

virtual

Indicated whether or not any transmitter parameters were specified.

virtual void DtVrfRadioDescriptor::setSampleRate ( double  value )

virtual

See mySampleRate.

virtual double DtVrfRadioDescriptor::sampleRate ( ) const

virtual

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

virtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtVrfRadioDescriptor::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.

virtual bool DtVrfRadioDescriptor::init ( )

virtual

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

static DtVrfRadioDescriptorFactory* DtVrfRadioDescriptor::factory ( )

static

Factory used to generate new instances of DtRadioDescriptor objects, based on the types defined in signaturePropagatorDescTypes.h.

Reimplemented from DtReaderWriter.

static void DtVrfRadioDescriptor::setFactory ( DtVrfRadioDescriptorFactory *  factory )

static

static DtVrfRadioDescriptor* DtVrfRadioDescriptor::createRadioDescriptor ( DtlObjPtr  mtlStream, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

static

Uses the factory to create a new radio descriptor of the specified type.

static DtVrfRadioDescriptor* DtVrfRadioDescriptor::createRadioDescriptor ( const char *  typeString )

static

static DtVrfRadioDescriptor* DtVrfRadioDescriptor::creator ( )

static

Returns

A new instance of this class.

bool DtVrfRadioDescriptor::operator==

(

const DtVrfRadioDescriptor &

)

const

bool DtVrfRadioDescriptor::operator!= ( const DtVrfRadioDescriptor &  rhs ) const

inline

Member Data Documentation

DtRwString DtVrfRadioDescriptor::myRadioType

protected

Parameter Name: radio-type
Parameter Description: String identifying type of radio object.

Parameter Default Value:

DtRwString DtVrfRadioDescriptor::myCommModelName

protected

Parameter Name: comm-model-name
Parameter Description: The name of the communication model which this radio is part of.

This must correspond to a name in the comm model configuration file.

DtRwBoolean DtVrfRadioDescriptor::myPublishTransmitter

protected

Parameter Name: publish-transmitter
Parameter Description: Indicates whether or not this radio should publish a DIS/RPR transmitter object.

If true, the transmitter-params will be used to determine the attributes that are published.
Default Value: False.

DtVrfRadioTransmitterParams DtVrfRadioDescriptor::myTransmitterParams

protected

Parameter Name: transmitter-params
Parameter Description: Parameters for the publishing of a DIS/RPR transmitter object in association with this radio.

Default Value: Not specified.

DtRwReal DtVrfRadioDescriptor::mySampleRate

protected

Parameter Name: sample-rate
Parameter Description: Sample rate published in signal PDUs/interactions.

Default Value: 1.0e6. Units: bps

DtVrfRadioDescriptorFactory* DtVrfRadioDescriptor::theFactory

staticprotected

---

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

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