DtVrfRadioDescriptor Class Reference

Descriptor base class for DtRadio instances. A descriptor tells what type of radio to create as well as any parameters for the radio.

Inheritance diagram for DtVrfRadioDescriptor:

Public Member Functions
	DtVrfRadioDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVrfRadioDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVrfRadioDescriptor (const DtVrfRadioDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtVrfRadioDescriptor &	operator= (const DtVrfRadioDescriptor &orig)
virtual	~DtVrfRadioDescriptor () override
virtual DtString	type () const
virtual DtVrfRadioDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual bool	init ()
bool	operator== (const DtVrfRadioDescriptor &) const
bool	operator!= (const DtVrfRadioDescriptor &rhs) const
virtual void	setRadioType (const DtString &typeString)
virtual DtString	radioType () const
virtual void	setCommModelName (const DtString &name)
virtual DtString	commModelName () const
virtual void	setPublishTransmitter (bool value)
virtual bool	publishTransmitter () const
virtual DtVrfRadioTransmitterParams &	transmitterParams ()
virtual const DtVrfRadioTransmitterParams &	transmitterParams () const
virtual bool	transmitterParamsSpecified () const
virtual void	setSampleRate (double value)
virtual double	sampleRate () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtVrfRadioDescriptorFactory *	factory ()
static void	setFactory (DtVrfRadioDescriptorFactory *factory)
static DtVrfRadioDescriptor *	creator ()
static DtVrfRadioDescriptor *	createRadioDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
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)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myRadioType
DtRwString	myCommModelName
DtRwBoolean	myPublishTransmitter
DtVrfRadioTransmitterParams	myTransmitterParams
DtRwReal	mySampleRate
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
bool	myInvalid
bool	myChangedFlag

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
static DtOutputStream *	theOutputStream

Private Member Functions
	DtVrfRadioDescriptor ()

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)

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

overridevirtual

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 ( std::string &  fp, int  indentLevel = 0  )

overridevirtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

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

overridevirtual

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.

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

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.

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/vrfRadioDescriptor.h