Arp::Plc::Commons::Meta::DataInfo Class Reference

Provides detailed informations for the respective data object. More...

#include <DataInfo.hpp>

Inheritance diagram for Arp::Plc::Commons::Meta::DataInfo:

Public Member Functions
	DataInfo (void)=default
	Constructs an DataInfo instance. More...
	DataInfo (const DataInfo &arg)=default
	Copy constructor. More...
	DataInfo (DataInfo &&arg)=default
	Move constructor. More...
	DataInfo (const DataTag &dataTag)
	Constructs an DataInfo instance. More...
	DataInfo (const DataTag &dataTag, const ArrayDimension &arrayDimension)
	Constructs an DataInfo instance. More...
	DataInfo (const DataTag &dataTag, const ArrayDimensions &arrayDimensions)
	Constructs an DataInfo instance. More...
DataInfo &	operator= (const DataInfo &arg)=default
	Copy assignment operator. More...
DataInfo &	operator= (DataInfo &&arg)=default
	~DataInfo (void)=default
	Destructs this instance and frees all resources. More...
bool	IsEmpty (void) const
	Determines if this instance is empty. More...
DataTypeEnum &	GetDataType (void)
	The data type of this instance. More...
const DataTypeEnum &	GetDataType (void) const
	The data type of this instance. More...
DataTag &	GetDataTag (void)
	Gets the DataTag . More...
const DataTag &	GetDataTag (void) const
	Gets the DataTag . More...
TypeIdentifier &	GetTypeIdentifier (void)
	Get type name and namspace. More...
const TypeIdentifier &	GetTypeIdentifier (void) const
	Get type name and namspace. More...
ArrayDimensions &	GetArrayDimensions (void)
	List of array dimensions information More...
const ArrayDimensions &	GetArrayDimensions (void) const
	List of array dimensions information More...
bool	IsBackgroundDomain (void) const
	Only for internal using. More...
size_t	GetTypeSize (ITypeNavigator &typeNavigator) const
size_t	GetBaseDataTypeSize (ITypeNavigator &typeNavigator) const
size_t	GetDataSize (ITypeNavigator &typeNavigator) const
size_t	GetDataAlignment (ITypeNavigator &typeNavigator) const
size_t	GetVariableSize (ITypeNavigator &typeNavigator) const
size_t	GetVariableAlignment (ITypeNavigator &typeNavigator) const
TypeInfo	GetTypeInfo (ITypeNavigator &typeNavigator) const
void	Serialize (RscWriter &writer) const override
	Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
void	Deserialize (RscReader &reader) override
	Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
virtual	~IRscSerializable ()=default
	default destructor More...

Static Public Member Functions
static size_t	GetFieldCount (void)
Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t	GetFieldCount (void)
	Returns the count of fields of the struct type More...

Static Public Attributes
static const DataInfo	Empty

Friends
class	Arp::Plc::Meta::Internal::DataBrowser

Detailed Description

Provides detailed informations for the respective data object.

Constructor & Destructor Documentation

DataInfo() [1/6]

Arp::Plc::Commons::Meta::DataInfo::DataInfo ( void  )

default

Constructs an DataInfo instance.

DataInfo() [2/6]

Arp::Plc::Commons::Meta::DataInfo::DataInfo ( const DataInfo &  arg )

default

Copy constructor.

DataInfo() [3/6]

Arp::Plc::Commons::Meta::DataInfo::DataInfo ( DataInfo &&  arg )

default

Move constructor.

DataInfo() [4/6]

Arp::Plc::Commons::Meta::DataInfo::DataInfo

(

const DataTag &

dataTag

)

Constructs an DataInfo instance.

DataInfo() [5/6]

Arp::Plc::Commons::Meta::DataInfo::DataInfo	(	const DataTag &	dataTag,
		const ArrayDimension &	arrayDimension
	)

Constructs an DataInfo instance.

DataInfo() [6/6]

Arp::Plc::Commons::Meta::DataInfo::DataInfo	(	const DataTag &	dataTag,
		const ArrayDimensions &	arrayDimensions
	)

Constructs an DataInfo instance.

~DataInfo()

Arp::Plc::Commons::Meta::DataInfo::~DataInfo ( void  )

default

Destructs this instance and frees all resources.

Member Function Documentation

Deserialize()

void Arp::Plc::Commons::Meta::DataInfo::Deserialize ( RscReader &  reader )

overridevirtual

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters

reader

Reference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

GetArrayDimensions() [1/2]

ArrayDimensions & Arp::Plc::Commons::Meta::DataInfo::GetArrayDimensions ( void  )

inline

List of array dimensions information

Returns

Dimensions object.

GetArrayDimensions() [2/2]

const ArrayDimensions & Arp::Plc::Commons::Meta::DataInfo::GetArrayDimensions ( void  ) const

inline

List of array dimensions information

Returns

Dimensions object.

GetDataTag() [1/2]

const DataTag & Arp::Plc::Commons::Meta::DataInfo::GetDataTag ( void  )

inline

Gets the DataTag .

Returns

DataTag.

GetDataTag() [2/2]

const DataTag& Arp::Plc::Commons::Meta::DataInfo::GetDataTag

(

void

)

const

Gets the DataTag .

Returns

DataTag.

GetDataType() [1/2]

const DataTypeEnum & Arp::Plc::Commons::Meta::DataInfo::GetDataType ( void  )

inline

The data type of this instance.

Returns

DataType.

GetDataType() [2/2]

const DataTypeEnum& Arp::Plc::Commons::Meta::DataInfo::GetDataType

(

void

)

const

The data type of this instance.

Returns

DataType.

GetTypeIdentifier() [1/2]

const TypeIdentifier & Arp::Plc::Commons::Meta::DataInfo::GetTypeIdentifier ( void  )

inline

Get type name and namspace.

Returns

TypeIdentifier object.

GetTypeIdentifier() [2/2]

const TypeIdentifier& Arp::Plc::Commons::Meta::DataInfo::GetTypeIdentifier

(

void

)

const

Get type name and namspace.

Returns

TypeIdentifier object.

IsBackgroundDomain()

bool Arp::Plc::Commons::Meta::DataInfo::IsBackgroundDomain ( void  ) const

inline

Only for internal using.

Returns

true if this instance relates to the background domain, otherwise false.

IsEmpty()

bool Arp::Plc::Commons::Meta::DataInfo::IsEmpty ( void  ) const

inline

Determines if this instance is empty.

Returns

true if this instance is empty, otherwiese false.

operator=()

DataInfo& Arp::Plc::Commons::Meta::DataInfo::operator= ( const DataInfo &  arg )

default

Copy assignment operator.

summary>Move assignment operator

Serialize()

void Arp::Plc::Commons::Meta::DataInfo::Serialize ( RscWriter &  writer ) const

overridevirtual

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters

writer

Reference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

---

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

• Arp/Plc/Commons/Meta/DataInfo.hpp