DtIfRequestSetting Class Reference

class DtIfRequestSetting:

Instances of DtIfRequestSetting are used by DtVrfBackendListener to interrogate back-ends about the DtSettingsObjects stored in their settings managers.

Content-Type: DtRequestSettingMessageType

Parameters: settingName - the name of the DtSettingsObject being requested

Inheritance diagram for DtIfRequestSetting:

Public Member Functions
	DtIfRequestSetting ()
	DtIfRequestSetting (const DtIfRequestSetting &orig)
const DtIfRequestSetting &	operator= (const DtIfRequestSetting &orig)
virtual	~DtIfRequestSetting () override
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	printDataToString (DtString &str) override
virtual std::string	settingName () const
virtual void	setSettingName (const std::string &settingName)
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
std::string	mySettingName
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfRequestSetting::DtIfRequestSetting

(

)

default constructor

DtIfRequestSetting::DtIfRequestSetting

(

const DtIfRequestSetting &

orig

)

copy constructor

virtual DtIfRequestSetting::~DtIfRequestSetting ( )

overridevirtual

destructor

Member Function Documentation

const DtIfRequestSetting& DtIfRequestSetting::operator=

(

const DtIfRequestSetting &

orig

)

assignment operator

virtual int DtIfRequestSetting::type ( ) const

overridevirtual

returns DtIfRequestSettingMessageType

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfRequestSetting::clone ( ) const

overridevirtual

clone

Implements DtSimInterfaceContent.

virtual std::string DtIfRequestSetting::settingName ( ) const

virtual

The name of the settings object to request.

virtual void DtIfRequestSetting::setSettingName ( const std::string &  settingName )

virtual

The name of the settings object to request.

virtual int DtIfRequestSetting::netRepSize ( ) const

overridevirtual

Returns the size of the message.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestSetting::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

overridevirtual

Unserializes the message from the network buffer.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestSetting::setToNet ( )

overridevirtual

Serializes the message to the network buffer.

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRequestSetting::printDataToString ( DtString &  str )

overridevirtual

Adds the name of the setting being requested to the string.

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfRequestSetting::creator ( )

static

Creator function; returns a new instance of this class.

Member Data Documentation

std::string DtIfRequestSetting::mySettingName

protected

---

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

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