#include <WsfPProxyStructType.hpp>

Inheritance diagram for WsfPProxyStructType:

Collaboration diagram for WsfPProxyStructType:

[legend]

Classes
struct	AttrData
class	Builder

Public Types
using	NameToIndexMap = std::map<std::string, int>
	Map an attribute name to the index.

Public Member Functions
	~WsfPProxyStructType () override
bool	IsUnset (void *aValuePtr) const override
void	SetUnset (void *aValuePtr) const override
bool	IsInherited (void *aValuePtr) const override
void	SetInherited (void *aValuePtr, bool aIsInherited) const override
bool	IsOfBasicType (const std::string &aTypeName) const override
WsfParseStruct *	GetParseStruct ()
void	ClearUnset (void *aValuePtr) const override
WsfPProxyType *	GetContainedType (size_t aIndex) const override
WsfPProxyValue	GetAtIndex (void *aDataPtr, size_t aIndex) const override
size_t	GetAttrCount (void *aPtr) const override
void	Initialize ()
void	Construct (void *aValuePtr) const override
void	Destroy (void *aValuePtr) const override
size_t	MemoryUsage (void *aDataPtr) const override
void	ConstructAttr (const AttrData &aAttr, void *aValuePtr) const
void	DestroyInstance (WsfPProxyStructValue aInstance) const
void	CopyInstance (WsfPProxyStructValue &aDest, WsfPProxyStructValue &aSrc, int copyFlags) const
WsfPProxyStructValue	GetInstance (WsfPProxyStructHeader *aHeader) const
void	Copy (void aDest, void aSrc, int copyFlags) const override
WsfPProxyValue	GetMemberValue (void *aPtr, size_t aIndex) const
WsfPProxyValue	GetAttr (void *aPtr, const std::string &aName) const override
bool	SwapAttr (void *aPtr, const WsfPProxyKey &aKey, WsfPProxyValue &aValue) const override
size_t	GetMemberCount () const
std::string	GetNameAtIndex (size_t aIndex) const override
size_t	GetMemberIndex (const std::string &aName) const override
bool	IsTypeOf (const WsfPProxyType *aOtherType) const override
WsfPProxyStructValue	GetDefaultValue () const
virtual bool	IsInitialized () const
Public Member Functions inherited from WsfPProxyType
	WsfPProxyType (WsfProxy::ValueKind aKind)
virtual	~WsfPProxyType ()
const std::string &	GetTypeName () const
size_t	GetDataSize () const
bool	IsBasicType () const
bool	IsStruct () const
bool	IsList () const
bool	IsObjectMap () const
virtual WsfPProxyHash	Hash (void *aDataPtr) const

Public Attributes
ptrdiff_t	mStructSize
	Size in bytes of the actual structure.
WsfPProxyStructType *	mBasePtr
	Pointer to base struct.
std::vector< AttrData >	mLocalAttributes
	Attributes for this struct, not including base classes.
std::vector< AttrData >	mAttrData
std::vector< size_t >	mDynamicAttributes
	Indices of attributes that are not in the real struct.
NameToIndexMap	mNameToIndex
std::vector< std::string >	mAllNames
WsfPProxyStructValue	mDefaultStruct
bool	mInitialized
bool	mEmbedded
WsfParseStruct *	mParseStructPtr
Public Attributes inherited from WsfPProxyType
int	mTypeFlags
int	mTypeKind
int	mTypeStoredKind
size_t	mDataSize
std::string	mTypeName

Member Typedef Documentation

◆ NameToIndexMap

using WsfPProxyStructType::NameToIndexMap = std::map<std::string, int>

Map an attribute name to the index.

Constructor & Destructor Documentation

◆ ~WsfPProxyStructType()

WsfPProxyStructType::~WsfPProxyStructType ( )

override

References mDefaultStruct.

Member Function Documentation

◆ ClearUnset()

void WsfPProxyStructType::ClearUnset ( void * aValuePtr ) const

overridevirtual

Reimplemented from WsfPProxyType.

References WsfPProxyStructHeader::mStructFlags.

◆ Construct()

void WsfPProxyStructType::Construct ( void * aValuePtr ) const

overridevirtual

Implements WsfPProxyType.

References WsfPProxyStructHeader::cSF_EXPANDED_FMT, WsfPProxyStructHeader::mStructFlags, and WsfPProxyStructHeader::mStructPtr.

◆ ConstructAttr()

void WsfPProxyStructType::ConstructAttr	(	const AttrData &	aAttr,
		void *	aValuePtr ) const

References WsfPProxyType::Construct(), and WsfPProxyStructType::AttrData::mTypePtr.

◆ Copy()

void WsfPProxyStructType::Copy	(	void *	aDest,
		void *	aSrc,
		int	copyFlags ) const

overridevirtual

Implements WsfPProxyType.

References WsfProxy::cCOPY_BASE, WsfPProxyStructHeader::cSF_INSTANTIATION_MASK, Destroy(), GetInstance(), WsfPProxyStructValue::GetStruct(), IsTypeOf(), WsfPProxyStructHeader::mBasePath, WsfPProxyStructHeader::mStructFlags, and WsfPProxyStructHeader::mStructPtr.

◆ CopyInstance()

void WsfPProxyStructType::CopyInstance	(	WsfPProxyStructValue &	aDest,
		WsfPProxyStructValue &	aSrc,
		int	copyFlags ) const

References WsfPProxyValue::ClearUnset(), WsfPProxyType::Copy(), WsfPProxyStructHeader::cSF_CONSTRUCTED, WsfPProxyStructValue::GetHeader(), WsfPProxyStructValue::GetMember(), WsfPProxyStructValue::GetMemberCount(), WsfPProxyStructValue::GetMemberType(), WsfPProxyValue::IsUnset(), WsfPProxyStructHeader::mStructFlags, and WsfPProxyValue::SetUnset().

◆ Destroy()

void WsfPProxyStructType::Destroy ( void * aValuePtr ) const

overridevirtual

Implements WsfPProxyType.

References DestroyInstance(), and WsfPProxyStructHeader::mStructDataPtr.

Referenced by Copy().

◆ DestroyInstance()

void WsfPProxyStructType::DestroyInstance ( WsfPProxyStructValue aInstance ) const

References WsfPProxyStructHeader::Destroying(), DestroyInstance(), WsfPProxyStructValue::GetHeader(), WsfPProxyStructValue::GetMemberData(), WsfPProxyStructValue::GetStruct(), mAttrData, and mDynamicAttributes.

Referenced by Destroy(), and DestroyInstance().

◆ GetAtIndex()

WsfPProxyValue WsfPProxyStructType::GetAtIndex	(	void *	aDataPtr,
		size_t	aIndex ) const

inlineoverridevirtual

Reimplemented from WsfPProxyType.

References GetMemberValue().

Referenced by WsfPProxyVisitor::Visit().

◆ GetAttr()

WsfPProxyValue WsfPProxyStructType::GetAttr	(	void *	aPtr,
		const std::string &	aName ) const

overridevirtual

Implements WsfPProxyType.

References WsfPProxyStructHeader::cSF_CONSTRUCTED, GetMemberIndex(), WsfPProxyStructHeader::GetStart(), WsfPProxyType::IsStruct(), mAttrData, WsfPProxyStructHeader::mStructFlags, and WsfPProxyType::WsfPProxyType().

◆ GetAttrCount()

size_t WsfPProxyStructType::GetAttrCount ( void * aPtr ) const

overridevirtual

Reimplemented from WsfPProxyType.

References mAttrData.

◆ GetContainedType()

WsfPProxyType * WsfPProxyStructType::GetContainedType ( size_t aIndex ) const

inlineoverridevirtual

Reimplemented from WsfPProxyType.

References mAttrData, and WsfPProxyType::WsfPProxyType().

◆ GetDefaultValue()

WsfPProxyStructValue WsfPProxyStructType::GetDefaultValue ( ) const

inline

References mDefaultStruct.

Referenced by WsfPProxyRegistry::BuildBasicRootFromBasicTypes().

◆ GetInstance()

WsfPProxyStructValue WsfPProxyStructType::GetInstance ( WsfPProxyStructHeader * aHeader ) const

inline

Referenced by Copy(), and MemoryUsage().

◆ GetMemberCount()

size_t WsfPProxyStructType::GetMemberCount ( ) const

inline

References mAttrData.

Referenced by WsfPProxyStructValue::GetMemberCount(), WsfPProxyVisitor::Visit(), and WsfPProxyVisitor::VisitNodes().

◆ GetMemberIndex()

size_t WsfPProxyStructType::GetMemberIndex ( const std::string & aName ) const

inlineoverridevirtual

Reimplemented from WsfPProxyType.

References mNameToIndex.

Referenced by WsfPProxy::FindAttributeIndex(), GetAttr(), and WsfPProxyStructValue::GetMemberType().

◆ GetMemberValue()

WsfPProxyValue WsfPProxyStructType::GetMemberValue	(	void *	aPtr,
		size_t	aIndex ) const

References WsfPProxyStructHeader::cSF_CONSTRUCTED, WsfPProxyStructHeader::GetStart(), WsfPProxyType::IsStruct(), mAttrData, WsfPProxyStructHeader::mStructFlags, and WsfPProxyType::WsfPProxyType().

Referenced by GetAtIndex(), and SwapAttr().

◆ GetNameAtIndex()

std::string WsfPProxyStructType::GetNameAtIndex ( size_t aIndex ) const

overridevirtual

Reimplemented from WsfPProxyType.

References mAllNames.

◆ GetParseStruct()

WsfParseStruct * WsfPProxyStructType::GetParseStruct ( )

inline

References mParseStructPtr.

Referenced by WsfPProxySatisfy::Satisfy().

◆ Initialize()

void WsfPProxyStructType::Initialize ( )

References WsfProxy::cPOLYMORPHIC, mAttrData, mBasePtr, WsfPProxyType::mDataSize, mInitialized, mStructSize, and WsfPProxyType::mTypeFlags.

Referenced by WsfPProxyRegistry::InitializeStruct().

◆ IsInherited()

bool WsfPProxyStructType::IsInherited ( void * aValuePtr ) const

inlineoverridevirtual

Implements WsfPProxyType.

References WsfPProxyStructHeader::cSF_INHERITED, and WsfPProxyStructHeader::mStructFlags.

◆ IsInitialized()

virtual bool WsfPProxyStructType::IsInitialized ( ) const

inlinevirtual

References mInitialized.

Referenced by WsfPProxyRegistry::InitializeStruct().

◆ IsOfBasicType()

bool WsfPProxyStructType::IsOfBasicType ( const std::string & aTypeName ) const

inlineoverridevirtual

Reimplemented from WsfPProxyType.

References mBasePtr, and WsfPProxyType::mTypeName.

Referenced by WsfPM_Platform::GetTypeObjectMap(), and WsfPProxyNode::IsA_PredefinedStructTypeOf().

◆ IsTypeOf()

bool WsfPProxyStructType::IsTypeOf ( const WsfPProxyType * aOtherType ) const

inlineoverridevirtual

Reimplemented from WsfPProxyType.

References mBasePtr, and WsfPProxyType::WsfPProxyType().

Referenced by Copy().

◆ IsUnset()

bool WsfPProxyStructType::IsUnset ( void * aValuePtr ) const

overridevirtual

Implements WsfPProxyType.

References WsfPProxyStructHeader::cSF_UNSET, and WsfPProxyStructHeader::mStructFlags.

◆ MemoryUsage()

size_t WsfPProxyStructType::MemoryUsage ( void * aDataPtr ) const

overridevirtual

Implements WsfPProxyType.

References WsfPProxyValue::GetAtIndex(), WsfPProxyValue::GetDataPtr(), WsfPProxyStructValue::GetHeader(), GetInstance(), WsfPProxyStructValue::GetMemberCount(), WsfPProxyStructHeader::GetStart(), WsfPProxyValue::GetType(), WsfPProxyStructHeader::mBasePath, WsfPProxyPath::MemoryUsage(), and WsfPProxyType::MemoryUsage().

◆ SetInherited()

void WsfPProxyStructType::SetInherited	(	void *	aValuePtr,
		bool	aIsInherited ) const

inlineoverridevirtual

Implements WsfPProxyType.

References WsfPProxyStructHeader::cSF_INHERITED, and WsfPProxyStructHeader::mStructFlags.

◆ SetUnset()

void WsfPProxyStructType::SetUnset ( void * aValuePtr ) const

inlineoverridevirtual

Implements WsfPProxyType.

References WsfPProxyStructHeader::cSF_UNSET, and WsfPProxyStructHeader::mStructFlags.

◆ SwapAttr()

bool WsfPProxyStructType::SwapAttr	(	void *	aPtr,
		const WsfPProxyKey &	aKey,
		WsfPProxyValue &	aValue ) const

overridevirtual

Reimplemented from WsfPProxyType.

References WsfPProxyValue::Copy(), WsfPProxyValue::Delete(), WsfPProxyKey::GetIndex(), GetMemberValue(), WsfPProxyValue::GetType(), WsfPProxyType::IsTypeOf(), WsfPProxyValue::IsValid(), mAttrData, WsfPProxyValue::SetUnset(), and WsfPProxyType::WsfPProxyType().

Member Data Documentation

◆ mAllNames

std::vector<std::string> WsfPProxyStructType::mAllNames

Referenced by WsfPProxyStructValue::GetMemberName(), and GetNameAtIndex().

◆ mAttrData

std::vector<AttrData> WsfPProxyStructType::mAttrData

Byte-offset of attribute ordered by attribute index These are not strictly increasing

Referenced by DestroyInstance(), GetAttr(), GetAttrCount(), GetContainedType(), WsfPProxyStructValue::GetMember(), GetMemberCount(), GetMemberValue(), Initialize(), and SwapAttr().

◆ mBasePtr

WsfPProxyStructType* WsfPProxyStructType::mBasePtr

Pointer to base struct.

Referenced by wizard::ComponentPropertyManager::FindPartIcon(), WsfPProxyNode::GetInheritedTypeNames(), Initialize(), WsfPProxyRegistry::InitializeStruct(), IsOfBasicType(), and IsTypeOf().

◆ mDefaultStruct

WsfPProxyStructValue WsfPProxyStructType::mDefaultStruct

Referenced by WsfPProxyRegistry::CreateDefaultStruct(), GetDefaultValue(), and ~WsfPProxyStructType().

◆ mDynamicAttributes

std::vector<size_t> WsfPProxyStructType::mDynamicAttributes

Indices of attributes that are not in the real struct.

Referenced by DestroyInstance().

◆ mEmbedded

bool WsfPProxyStructType::mEmbedded

◆ mInitialized

bool WsfPProxyStructType::mInitialized

Referenced by Initialize(), and IsInitialized().

◆ mLocalAttributes

std::vector<AttrData> WsfPProxyStructType::mLocalAttributes

Attributes for this struct, not including base classes.

Referenced by WsfPProxyRegistry::InitializeStruct().

◆ mNameToIndex

NameToIndexMap WsfPProxyStructType::mNameToIndex

Referenced by GetMemberIndex().

◆ mParseStructPtr

WsfParseStruct* WsfPProxyStructType::mParseStructPtr

Referenced by GetParseStruct().

◆ mStructSize

ptrdiff_t WsfPProxyStructType::mStructSize

Size in bytes of the actual structure.

Referenced by Initialize().

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

Classes

Public Types

Public Member Functions

Public Attributes

Member Typedef Documentation

◆ NameToIndexMap

Constructor & Destructor Documentation

◆ ~WsfPProxyStructType()

Member Function Documentation

◆ ClearUnset()

◆ Construct()

◆ ConstructAttr()

◆ Copy()

◆ CopyInstance()

◆ Destroy()

◆ DestroyInstance()

◆ GetAtIndex()

◆ GetAttr()

◆ GetAttrCount()

◆ GetContainedType()

◆ GetDefaultValue()

◆ GetInstance()

◆ GetMemberCount()

◆ GetMemberIndex()

◆ GetMemberValue()

◆ GetNameAtIndex()

◆ GetParseStruct()

◆ Initialize()

◆ IsInherited()

◆ IsInitialized()

◆ IsOfBasicType()

◆ IsTypeOf()

◆ IsUnset()

◆ MemoryUsage()

◆ SetInherited()

◆ SetUnset()

◆ SwapAttr()

Member Data Documentation

◆ mAllNames

◆ mAttrData

◆ mBasePtr

◆ mDefaultStruct

◆ mDynamicAttributes

◆ mEmbedded

◆ mInitialized

◆ mLocalAttributes

◆ mNameToIndex

◆ mParseStructPtr

◆ mStructSize