WsfBMTypeWrapper< tWrappedType, tPointerType > Class Template Reference

#include <WsfBMGenericTypeWrapper.hpp>

Inheritance diagram for WsfBMTypeWrapper< tWrappedType, tPointerType >:

Collaboration diagram for WsfBMTypeWrapper< tWrappedType, tPointerType >:

Public Types
typedef tPointerType	tType
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfBMTypeWrapper (const std::string &script_class_name)
	WsfBMTypeWrapper (const std::string &script_class_name, tPointerType data_to_wrap)
virtual WsfBMTypeWrapper *	Clone () const
virtual const char *	GetScriptClassName () const
virtual tType	GetRawPtr () const
virtual bool	IsValidRef () 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::string	m_script_class_name
tPointerType	m_wrapped_ptr

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

Member Typedef Documentation

tType

template<typename tWrappedType, typename tPointerType>

typedef tPointerType WsfBMTypeWrapper< tWrappedType, tPointerType >::tType

Constructor & Destructor Documentation

WsfBMTypeWrapper() [1/2]

template<typename tWrappedType, typename tPointerType>

WsfBMTypeWrapper< tWrappedType, tPointerType >::WsfBMTypeWrapper ( const std::string & script_class_name )

inline

References m_script_class_name.

Referenced by Clone().

WsfBMTypeWrapper() [2/2]

template<typename tWrappedType, typename tPointerType>

WsfBMTypeWrapper< tWrappedType, tPointerType >::WsfBMTypeWrapper ( const std::string & script_class_name, tPointerType data_to_wrap )

inline

References m_script_class_name, and m_wrapped_ptr.

Member Function Documentation

Clone()

template<typename tWrappedType, typename tPointerType>

virtual WsfBMTypeWrapper * WsfBMTypeWrapper< tWrappedType, tPointerType >::Clone ( ) const

inlinevirtual

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

Implements WsfObject.

Reimplemented in WsfBMAssignmentMessage, WsfBMAssignmentStatusMessage, WsfBMAssignmentTrackMessage, WsfBMCueMessage, WsfBMStatusMessage, WsfBMTrackMessage, and WsfBMWeaponTable.

References WsfBMTypeWrapper().

GetRawPtr()

template<typename tWrappedType, typename tPointerType>

virtual tType WsfBMTypeWrapper< tWrappedType, tPointerType >::GetRawPtr ( ) const

inlinevirtual

References m_wrapped_ptr.

GetScriptClassName()

template<typename tWrappedType, typename tPointerType>

virtual const char * WsfBMTypeWrapper< tWrappedType, tPointerType >::GetScriptClassName ( ) const

inlinevirtual

Reimplemented in WsfBMAssignmentMessage, WsfBMAssignmentStatusMessage, WsfBMAssignmentTrackMessage, WsfBMCueMessage, WsfBMStatusMessage, and WsfBMTrackMessage.

References m_script_class_name.

IsValidRef()

template<typename tWrappedType, typename tPointerType>

virtual bool WsfBMTypeWrapper< tWrappedType, tPointerType >::IsValidRef ( ) const

inlinevirtual

References m_wrapped_ptr.

Member Data Documentation

m_script_class_name

template<typename tWrappedType, typename tPointerType>

std::string WsfBMTypeWrapper< tWrappedType, tPointerType >::m_script_class_name

protected

Referenced by GetScriptClassName(), WsfBMTypeWrapper(), and WsfBMTypeWrapper().

m_wrapped_ptr

template<typename tWrappedType, typename tPointerType>

tPointerType WsfBMTypeWrapper< tWrappedType, tPointerType >::m_wrapped_ptr

protected

Referenced by GetRawPtr(), IsValidRef(), WsfBMUnmanagedTypeWrapper< tWrappedType >::SetData(), WsfBMTypeWrapper(), and WsfBMUnmanagedTypeWrapper< tWrappedType >::WsfBMUnmanagedTypeWrapper().

---

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

• WsfBMGenericTypeWrapper.hpp