WsfXIO_PublishKey Class Reference

#include <WsfXIO_PublishKey.hpp>

Inheritance diagram for WsfXIO_PublishKey:

Collaboration diagram for WsfXIO_PublishKey:

Classes
class	Field

Public Member Functions
	WsfXIO_PublishKey (const Field &a1=Field(), const Field &a2=Field(), const Field &a3=Field(), const Field &a4=Field())
bool	operator< (const WsfXIO_PublishKey &aKey) const
Field &	operator[] (int aIndex)
const Field &	operator[] (int aIndex) const
template<typename T>
void	Serialize (T &aBuff)
bool	HasWildcards () const
std::string	ToString () const
bool	Match (const WsfXIO_PublishKey &aKey) const

Static Public Member Functions
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
static UtScriptClass *	GetScriptClass ()

Static Public Attributes
static const int	cMAX_FIELDS = 4

Protected Attributes
Field	mFields [cMAX_FIELDS]

Static Protected Attributes
static UtScriptClass *	sScriptClassPtr = nullptr

Detailed Description

Defines the unique identifier for a publication. Contains up to 4 fields. Each field can be either a string or an integer. See WsfXIO_Publisher.

Constructor & Destructor Documentation

WsfXIO_PublishKey()

WsfXIO_PublishKey::WsfXIO_PublishKey ( const Field & a1 = Field(), const Field & a2 = Field(), const Field & a3 = Field(), const Field & a4 = Field() )

inline

References mFields.

Referenced by Match(), operator<(), WsfXIO_PublishFilter::operator==(), WsfXIO_PublishFilter::WsfXIO_PublishFilter(), and WsfXIO_PublishFilter::WsfXIO_PublishFilter().

Member Function Documentation

CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfXIO_PublishKey::CreateScriptClass ( const std::string & aClassName, UtScriptTypes * aScriptTypesPtr )

static

Create the 'class' object for the script system. This is invoked once by WsfScriptManager to create the 'class' object that defines the interface to instances of this class from the script system.

References sScriptClassPtr.

GetScriptClass()

UtScriptClass * WsfXIO_PublishKey::GetScriptClass ( )

inlinestatic

References sScriptClassPtr.

Referenced by WsfXIO_ScriptClass::Callee::HandleCallback().

HasWildcards()

bool WsfXIO_PublishKey::HasWildcards ( ) const

inline

References mFields.

Referenced by WsfXIO_Publisher::Unpublish().

Match()

bool WsfXIO_PublishKey::Match ( const WsfXIO_PublishKey & aKey ) const

inline

References cMAX_FIELDS, mFields, and WsfXIO_PublishKey().

Referenced by WsfXIO_PublishFilter::operator==().

operator<()

bool WsfXIO_PublishKey::operator< ( const WsfXIO_PublishKey & aKey ) const

inline

References mFields, and WsfXIO_PublishKey().

operator[]() [1/2]

Field & WsfXIO_PublishKey::operator[] ( int aIndex )

inline

References mFields.

operator[]() [2/2]

const Field & WsfXIO_PublishKey::operator[] ( int aIndex ) const

inline

References mFields.

Serialize()

template<typename T>

void WsfXIO_PublishKey::Serialize ( T & aBuff )

inline

References mFields.

ToString()

std::string WsfXIO_PublishKey::ToString ( ) const

inline

References mFields.

Referenced by WsfXIO_PublishKey::Field::Field(), and WsfXIO_PublishKey::Field::Field().

Member Data Documentation

cMAX_FIELDS

const int WsfXIO_PublishKey::cMAX_FIELDS = 4

static

Referenced by Match().

mFields

Field WsfXIO_PublishKey::mFields[cMAX_FIELDS]

protected

Referenced by HasWildcards(), Match(), operator<(), operator[](), operator[](), Serialize(), ToString(), and WsfXIO_PublishKey().

sScriptClassPtr

UtScriptClass * WsfXIO_PublishKey::sScriptClassPtr = nullptr

staticprotected

Referenced by CreateScriptClass(), and GetScriptClass().

---

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

• WsfXIO_PublishKey.hpp
• WsfXIO_PublishKey.cpp
• WsfXIO_Simulation.cpp