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 (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 createSignaturePropagatorDescriptor(), allowing derived classes to do memory allocation if necessary.
virtual void	setRadioType (const DtString &typeString)
	See myRadioType.
virtual DtString	radioType () const
	See myRadioType.
virtual void	setCommModelName (const DtString &name)
	See myCommModelName.
virtual DtString	commModelName () const
	See myCommModelName.
virtual void	setPublishTransmitter (bool value)
	See myPublishTransmitter.
virtual bool	publishTransmitter () const
	See myPublishTransmitter.
virtual DtVrfRadioTransmitterParams &	transmitterParams ()
	Access the myTransmitterParams.
virtual const DtVrfRadioTransmitterParams &	transmitterParams () const
	Access the myTransmitterParams.
virtual bool	transmitterParamsSpecified () const
	Indicated whether or not any transmitter parameters were specified.
virtual void	setSampleRate (double value)
	See mySampleRate.
virtual double	sampleRate () const
	See mySampleRate.
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 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 DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Uses the factory to create a new radio descriptor of the specified type.
static DtVrfRadioDescriptor *	createRadioDescriptor (const char *typeString)
	Uses the factory to create a new radio descriptor of the specified type.
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.

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

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 DtReaderWriterFactory	theFactory

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::pair < DtSymbolString, DtString >	DtVariableNameType
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.

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

See myRadioType.

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

virtual

See myCommModelName.

virtual DtString DtVrfRadioDescriptor::commModelName ( ) const

virtual

See myCommModelName.

virtual void DtVrfRadioDescriptor::setPublishTransmitter ( bool  value )

virtual

See myPublishTransmitter.

virtual bool DtVrfRadioDescriptor::publishTransmitter ( ) const

virtual

See myPublishTransmitter.

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

Access the myTransmitterParams.

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

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

See mySampleRate.

virtual void DtVrfRadioDescriptor::putData ( FILE *  fp, int  indentLevel = 0  )

virtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtVrfRadioDescriptor::getData ( DtlObjPtr  args, const DtFilename &  searchPath, 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.

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 DtFilename &  searchPath, 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

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

static DtVrfRadioDescriptor* DtVrfRadioDescriptor::creator ( )

static

Returns

A new instance of this class.

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:

• include/vrfobjparam/vrfRadioDescriptor.h