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

DtRadioMessageFilter objects can be installed into the DtRadioMessageListener. More...

Public Member Functions

 DtRadioMessageFilter (const char *pName=NULL)
virtual ~DtRadioMessageFilter ()
virtual bool init ()
virtual bool permitMessage (const DtVrfSignalMessageParams *pMsgParams, DtVrfObjectMessageConstPtr &msgSharedPtr, const DtRadioMessageListener &radioMsgListener) const
 Returns true if filter permits message.
bool enabled () const
 status accessor/mutator
virtual void setEnabled (bool bIsEnabled)
 status accessor/mutator
const std::string & name () const
 Name accessor/mutator.
void setName (const std::string &sName)
 Name accessor/mutator.

Static Public Member Functions

static DtRadioMessageFiltercreate (const char *pName=NULL)
 statics

Protected Attributes

bool myEnabled
std::string myName

Private Member Functions

 DtRadioMessageFilter (const DtRadioMessageFilter &orig)
 Not implemented.
const DtRadioMessageFilteroperator= (const DtRadioMessageFilter &orig)
 Not implemented.

Detailed Description

DtRadioMessageFilter objects can be installed into the DtRadioMessageListener.

This is an interface class. Developers can create derived classes that filter DtVrfObjectMessages based on the developer's criteria. These objects are installed into the DtRadioMessageListener to control when DtVrfObjectMessages are forwarded to the VRF GUI application.

Constructor & Destructor Documentation

DtRadioMessageFilter::DtRadioMessageFilter ( const DtRadioMessageFilter orig)
private

Not implemented.

DtRadioMessageFilter::DtRadioMessageFilter ( const char *  pName = NULL)
virtual DtRadioMessageFilter::~DtRadioMessageFilter ( )
virtual

Member Function Documentation

const DtRadioMessageFilter& DtRadioMessageFilter::operator= ( const DtRadioMessageFilter orig)
private

Not implemented.

bool DtRadioMessageFilter::enabled ( ) const
inline

status accessor/mutator

References myEnabled.

virtual void DtRadioMessageFilter::setEnabled ( bool  bIsEnabled)
virtual

status accessor/mutator

virtual bool DtRadioMessageFilter::init ( )
virtual
const std::string & DtRadioMessageFilter::name ( ) const
inline

Name accessor/mutator.

References myName.

void DtRadioMessageFilter::setName ( const std::string &  sName)
inline

Name accessor/mutator.

References myName.

virtual bool DtRadioMessageFilter::permitMessage ( const DtVrfSignalMessageParams pMsgParams,
DtVrfObjectMessageConstPtr msgSharedPtr,
const DtRadioMessageListener radioMsgListener 
) const
virtual

Returns true if filter permits message.

static DtRadioMessageFilter* DtRadioMessageFilter::create ( const char *  pName = NULL)
static

statics

static creator

Member Data Documentation

bool DtRadioMessageFilter::myEnabled
protected

Referenced by enabled().

std::string DtRadioMessageFilter::myName
protected

Referenced by name(), and setName().


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)