UtPackStruct Class Reference

A struct is a set of fields. More...

#include <UtPackSchema.hpp>

Inheritance diagram for UtPackStruct:

Collaboration diagram for UtPackStruct:

Public Member Functions
	UtPackStruct (UtPackType &aParentType)
void	Read (UtmlObject &aInput, UtPackType &aContainer)
void	Resolve () override
const std::vector< UtPackField > &	GetFields () const
std::vector< UtPackField >	GetAllFields () const
int	GetBitsetSize () const
int	GetBitsetBytes () const
int	GetMessageId () const
	Returns -1 if struct is not a message.
bool	IsMessage () const
bool	IsVirtual () const
const UtPackTypeReference &	GetBaseType () const
Public Member Functions inherited from UtPackType
	UtPackType (const UtPackType &)=delete
UtPackType &	operator= (const UtPackType &)=delete
virtual	~UtPackType ()=default
const std::string &	GetTypeName () const
std::string	GetTypePath () const
	Returns the full path to the type, with '.' as a separator. example: "Track.TrackId".
UtPackType *	FindType (const std::string &aTypeName)
const UtPackType *	FindType (const std::string &aTypeName) const
Encoding	GetEncoding () const
bool	IsStruct () const
bool	IsUnion () const
bool	IsBasicType () const
bool	IsEnum () const
bool	IsList () const
const NestedTypesList &	GetNestedTypes () const

Additional Inherited Members
Public Types inherited from UtPackType
enum	Encoding {   cENC_NONE , cENC_LITTLE_ENDIAN , cENC_VAR_BYTES , cENC_BIT ,   cENC_STRUCT , cENC_LIST }
using	NestedTypesList = std::vector<std::pair<std::string, std::unique_ptr<UtPackType>>>
Protected Member Functions inherited from UtPackType
const UtPackType *	FindTypeP (const std::string &aTypeName) const
	UtPackType (UtPackType *aParentTypePtr)
const UtPackType *	GetRootType () const
UtPackType *	GetRootType ()
UtPackSchema *	GetSchema () const
void	Read (UtmlObject &aInput)
void	ReadNestedTypes (UtmlObject &aInput)
Protected Attributes inherited from UtPackType
Encoding	mEncoding
UtPackType *	mParentType
std::string	mTypeName
NestedTypesList	mNestedTypes

Detailed Description

A struct is a set of fields.

Constructor & Destructor Documentation

UtPackStruct()

UtPackStruct::UtPackStruct

(

UtPackType &

aParentType

)

References UtPackType::UtPackType().

Referenced by GetAllFields().

Member Function Documentation

GetAllFields()

std::vector< UtPackField > UtPackStruct::GetAllFields

(

)

const

References GetBaseType(), UtPackTypeReference::GetType(), and UtPackStruct().

GetBaseType()

const UtPackTypeReference & UtPackStruct::GetBaseType ( ) const

inline

Referenced by GetAllFields().

GetBitsetBytes()

int UtPackStruct::GetBitsetBytes ( ) const

inline

GetBitsetSize()

int UtPackStruct::GetBitsetSize ( ) const

inline

GetFields()

const std::vector< UtPackField > & UtPackStruct::GetFields ( ) const

inline

GetMessageId()

int UtPackStruct::GetMessageId ( ) const

inline

Returns -1 if struct is not a message.

Referenced by UtPackSerializer::Initialize().

IsMessage()

bool UtPackStruct::IsMessage ( ) const

inline

Referenced by UtPackSerializer::Initialize().

IsVirtual()

bool UtPackStruct::IsVirtual ( ) const

inline

Referenced by UtPackSerializer::Initialize().

Read()

void UtPackStruct::Read	(	UtmlObject &	aInput,
		UtPackType &	aContainer )

References UtPackField::GetBitIndex(), UtmlObject::GetObject(), UtmlObject::GetObjectCount(), UtmlObject::GetType(), UtPackField::IsOptional(), UtmlObject::PropertyValue(), UtPackField::Read(), UtPackType::Read(), and UtPackType::UtPackType().

Resolve()

void UtPackStruct::Resolve ( )

overridevirtual

Reimplemented from UtPackType.

References UtPackType::GetTypePath(), and UtPackType::Resolve().

---

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

• UtPackSchema.hpp
• UtPackSchema.cpp