WsfBMAuxDataZoneAttachment Class Reference

#include <WsfBMAuxDataZoneAttachment.hpp>

Inheritance diagram for WsfBMAuxDataZoneAttachment:

Collaboration diagram for WsfBMAuxDataZoneAttachment:

Classes
class	tAttachment

Public Types
enum	eAttachmentType { E_PLATFORM , E_GLOBAL }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfBMAuxDataZoneAttachment ()
WsfBMAuxDataZoneAttachment *	Clone () const override
const char *	GetScriptClassName () const override
virtual void	AddZoneAttachment (const eAttachmentType attach_type, const double priority, const std::string &zone_name, const il::eZoneType zone_type)
virtual std::size_t	GetZoneAttachmentCount () const
virtual void	GetNthZoneAttachment (const std::size_t nth_zone, eAttachmentType &attach_type, double &priority, std::string &zone_name, il::eZoneType &zone_type) const
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
virtual bool	ProcessInput (UtInput &aInput)
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Protected Attributes
std::vector< tAttachment >	m_zones

Additional Inherited Members
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Member Enumeration Documentation

eAttachmentType

enum WsfBMAuxDataZoneAttachment::eAttachmentType

Enumerator
E_PLATFORM
E_GLOBAL

Constructor & Destructor Documentation

WsfBMAuxDataZoneAttachment()

WsfBMAuxDataZoneAttachment::WsfBMAuxDataZoneAttachment

(

)

Referenced by Clone().

Member Function Documentation

AddZoneAttachment()

void WsfBMAuxDataZoneAttachment::AddZoneAttachment ( const eAttachmentType attach_type, const double priority, const std::string & zone_name, const il::eZoneType zone_type )

virtual

References m_zones.

Clone()

WsfBMAuxDataZoneAttachment * WsfBMAuxDataZoneAttachment::Clone ( ) const

overridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References WsfBMAuxDataZoneAttachment().

GetNthZoneAttachment()

void WsfBMAuxDataZoneAttachment::GetNthZoneAttachment ( const std::size_t nth_zone, eAttachmentType & attach_type, double & priority, std::string & zone_name, il::eZoneType & zone_type ) const

virtual

References m_zones.

GetScriptClassName()

const char * WsfBMAuxDataZoneAttachment::GetScriptClassName ( ) const

inlineoverride

References WSF_BM_AUX_DATA_ZONE_ATTACH_SCRIPT_TYPE_NAME.

GetZoneAttachmentCount()

std::size_t WsfBMAuxDataZoneAttachment::GetZoneAttachmentCount ( ) const

virtual

References m_zones.

Member Data Documentation

m_zones

std::vector<tAttachment> WsfBMAuxDataZoneAttachment::m_zones

protected

Referenced by AddZoneAttachment(), GetNthZoneAttachment(), and GetZoneAttachmentCount().

---

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

• WsfBMAuxDataZoneAttachment.hpp
• WsfBMAuxDataZoneAttachment.cpp