makRadio::DtRadioSystemInitializer Class Reference

Initializer for the radio system (including radios)

Inheritance diagram for makRadio::DtRadioSystemInitializer:

Public Types
typedef DtRwTemplatedListPtr < DtRwRadioState, true >	Radios
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 )()

Public Member Functions
	DtRadioSystemInitializer (const DtString &name="radio-system", DtReaderWriterRegistry *parentRegistry=0)
	DtRadioSystemInitializer (const DtRadioSystemInitializer &)
virtual	~DtRadioSystemInitializer ()
DtRadioSystemInitializer &	operator= (const DtRadioSystemInitializer &)
virtual void	setPlaybackDevice (const DtString &)
virtual const DtString &	playbackDevice () const
virtual void	setCaptureDevice (const DtString &)
virtual const DtString &	captureDevice () const
virtual void	setVoxThreshold (double d)
virtual double	voxThreshold () const
virtual void	setEnableJammers (bool)
virtual bool	enableJammers () const
virtual void	setSampleRate (int)
virtual int	sampleRate () const
virtual void	setFormat (const DtString &)
virtual const DtString &	format () const
virtual void	setCaptureFrequency (int)
virtual int	captureFrequency () const
virtual void	setEnabled (bool)
virtual bool	enabled () const
virtual void	clearRadios ()
virtual void	addRadio (const DtRwRadioState &)
virtual void	removeRadio (const DtString &)
virtual const Radios &	radios () const
virtual bool	load (const DtFilename &)
virtual bool	save ()
virtual bool	save (const DtFilename &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () 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)
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 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	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 const char *	theXmlType ()
static void	initializeForReaderWriterFactory ()
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
DtRwReal	myVoxThreshold
DtRwBoolean	myEnableJammers
DtRwInt	mySampleRate
DtRwString	myFormat
DtRwInt	myCaptureFrequency
DtRwString	myPlaybackDevice
DtRwString	myCaptureDevice
DtRwBoolean	myEnabled
Radios	myRadios
DtFilename	myConfigurationFile
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

Additional Inherited Members
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwRadioState, true> makRadio::DtRadioSystemInitializer::Radios

Constructor & Destructor Documentation

makRadio::DtRadioSystemInitializer::DtRadioSystemInitializer	(	const DtString &	name = "radio-system",
		DtReaderWriterRegistry *	parentRegistry = 0
	)

makRadio::DtRadioSystemInitializer::DtRadioSystemInitializer

(

const DtRadioSystemInitializer &

)

virtual makRadio::DtRadioSystemInitializer::~DtRadioSystemInitializer ( )

virtual

Member Function Documentation

DtRadioSystemInitializer& makRadio::DtRadioSystemInitializer::operator=

(

const DtRadioSystemInitializer &

)

virtual void makRadio::DtRadioSystemInitializer::setPlaybackDevice ( const DtString &  )

virtual

Only to be used if there is more than one sound card and you know the name. blank or unset is fine for most uses.

virtual const DtString& makRadio::DtRadioSystemInitializer::playbackDevice ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setCaptureDevice ( const DtString &  )

virtual

Only to be used if there is more than one sound card and you know the name. blank or unset is fine for most uses.

virtual const DtString& makRadio::DtRadioSystemInitializer::captureDevice ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setVoxThreshold ( double  d )

virtual

Default is 0.1.

virtual double makRadio::DtRadioSystemInitializer::voxThreshold ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setEnableJammers ( bool  )

virtual

Default is true.

virtual bool makRadio::DtRadioSystemInitializer::enableJammers ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setSampleRate ( int  )

virtual

Default is 11025; 22050, 44100 are other choices.

virtual int makRadio::DtRadioSystemInitializer::sampleRate ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setFormat ( const DtString &  )

virtual

Default is MONO8; MLAW8, MONO16 are other choices.

virtual const DtString& makRadio::DtRadioSystemInitializer::format ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setCaptureFrequency ( int  )

virtual

Default is 20 frequency (in hertz) for how often the capture device should be polled. larger numbers means more frequent polling and smaller capture buffers and lower latency smaller numbers means less frequent polling and larger capture buffers with higher latency.

virtual int makRadio::DtRadioSystemInitializer::captureFrequency ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::setEnabled ( bool  )

virtual

Whether or not system is enabled (default is true)

virtual bool makRadio::DtRadioSystemInitializer::enabled ( ) const

virtual

virtual void makRadio::DtRadioSystemInitializer::clearRadios ( )

virtual

Clears out the current radios.

virtual void makRadio::DtRadioSystemInitializer::addRadio ( const DtRwRadioState &  )

virtual

Adds in a radio by radio name. Will remove existing radio of given name.

virtual void makRadio::DtRadioSystemInitializer::removeRadio ( const DtString &  )

virtual

Removes radio by the given name.

virtual const Radios& makRadio::DtRadioSystemInitializer::radios ( ) const

virtual

Radios.

virtual bool makRadio::DtRadioSystemInitializer::load ( const DtFilename &  )

virtual

Loads the channel configuration from the given file.

Reimplemented in makRadio::DtRadioAppSystemInitializer.

virtual bool makRadio::DtRadioSystemInitializer::save ( )

virtual

Saves the configuration to the last loaded filename.

Reimplemented in makRadio::DtRadioAppSystemInitializer.

virtual bool makRadio::DtRadioSystemInitializer::save ( const DtFilename &  )

virtual

Saves the configuration to the given filename.

virtual const char* makRadio::DtRadioSystemInitializer::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

static const char* makRadio::DtRadioSystemInitializer::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* makRadio::DtRadioSystemInitializer::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

static void makRadio::DtRadioSystemInitializer::initializeForReaderWriterFactory ( )

static

Member Data Documentation

DtRwReal makRadio::DtRadioSystemInitializer::myVoxThreshold

protected

DtRwBoolean makRadio::DtRadioSystemInitializer::myEnableJammers

protected

DtRwInt makRadio::DtRadioSystemInitializer::mySampleRate

protected

DtRwString makRadio::DtRadioSystemInitializer::myFormat

protected

DtRwInt makRadio::DtRadioSystemInitializer::myCaptureFrequency

protected

DtRwString makRadio::DtRadioSystemInitializer::myPlaybackDevice

protected

DtRwString makRadio::DtRadioSystemInitializer::myCaptureDevice

protected

DtRwBoolean makRadio::DtRadioSystemInitializer::myEnabled

protected

Radios makRadio::DtRadioSystemInitializer::myRadios

protected

DtFilename makRadio::DtRadioSystemInitializer::myConfigurationFile

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/makRadio/radioSystemInitializer.h