VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtIfRequestSetting Class Reference

class DtIfRequestSetting: More...

Inheritance diagram for DtIfRequestSetting:
Inheritance graph
[legend]

Public Member Functions

 DtIfRequestSetting ()
 default constructor
 DtIfRequestSetting (const DtIfRequestSetting &orig)
 copy constructor
const DtIfRequestSettingoperator= (const DtIfRequestSetting &orig)
 assignment operator
virtual ~DtIfRequestSetting ()
 destructor
virtual int type () const
 returns DtIfRequestSettingMessageType
virtual DtSimInterfaceContentclone () const
 clone
virtual int netRepSize () const
 Returns the size of the message.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Unserializes the message from the network buffer.
virtual bool setToNet ()
 Serializes the message to the network buffer.
virtual void printDataToString (DtString &str)
 Adds the name of the setting being requested to the string.
virtual std::string settingName () const
 The name of the settings object to request.
virtual void setSettingName (const std::string &settingName)
 The name of the settings object to request.
- Public Member Functions inherited from DtSimInterfaceContent
virtual ~DtSimInterfaceContent ()
virtual bool update (const DtSimInterfaceContent *data)
virtual char * netRep ()
virtual void setUseSessionId (bool yesNo)
virtual bool useSessionId () const

Static Public Member Functions

static DtSimInterfaceContentcreator ()
 Creator function; returns a new instance of this class.
- Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContentcreateInterfaceContent (int type)
static void addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactoryfactory ()

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 DtSimInterfaceContentoperator= (const DtSimInterfaceContent &orig)
virtual char * createNetworkBuffer ()
- Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactorymyFactory

Detailed Description

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

Constructor & Destructor Documentation

DtIfRequestSetting::DtIfRequestSetting ( )

default constructor

DtIfRequestSetting::DtIfRequestSetting ( const DtIfRequestSetting orig)

copy constructor

virtual DtIfRequestSetting::~DtIfRequestSetting ( )
virtual

destructor

Member Function Documentation

const DtIfRequestSetting& DtIfRequestSetting::operator= ( const DtIfRequestSetting orig)

assignment operator

virtual int DtIfRequestSetting::type ( ) const
virtual

returns DtIfRequestSettingMessageType

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfRequestSetting::clone ( ) const
virtual

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
virtual

Returns the size of the message.

Reimplemented from DtSimInterfaceContent.

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

Unserializes the message from the network buffer.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestSetting::setToNet ( )
virtual

Serializes the message to the network buffer.

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRequestSetting::printDataToString ( DtString str)
virtual

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:

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)