Arp::Plc::Commons::Meta::StructNavigator Class Reference

Navigates the children of a struct More...

#include <StructNavigator.hpp>

Classes
class	Enumerator
	IEnumerator of DataInfos of a struct More...

Public Types
using	Ptr = std::shared_ptr< StructNavigator >
	std::shared_ptr to StructNavigator

Public Member Functions
	StructNavigator (const TypeIdentifier &typeId, ITypeNavigator &typeNavigator, bool isChanging)
	Constructs an StructNavigator instance. More...
	StructNavigator (const StructNavigator &arg)=default
	Copy constructor.
	StructNavigator (StructNavigator &&arg)=default
	Move constructor.
StructNavigator &	operator= (const StructNavigator &arg)=default
	Copy assignment operator.
StructNavigator &	operator= (StructNavigator &&arg)=default
	Move assignment operator.
	~StructNavigator (void)=default
	Destructs this instance and frees all resources.
Enumerator	GetEnumerator (const byte *address)
	Gets an IEnumerator based on an address More...
Enumerator	GetEnumerator (const DataInfo &dataInfo)
	Gets an IEnumerator based on a DataInfo object More...
size_t	GetOffset (const String &fieldName)
	Gets the offset of a field in the struct More...

Detailed Description

Navigates the children of a struct

Constructor & Destructor Documentation

StructNavigator()

Arp::Plc::Commons::Meta::StructNavigator::StructNavigator	(	const TypeIdentifier &	typeId,
		ITypeNavigator &	typeNavigator,
		bool	isChanging
	)

Constructs an StructNavigator instance.

Parameters

typeId	TypeIdentifier of the navigated struct
typeNavigator	Reference to the ITypeNavigator to get infoprmation about the type
isChanging	true, if the background domain should be used, otherwise uses the foreground domain

Member Function Documentation

GetEnumerator() [1/2]

StructNavigator::Enumerator Arp::Plc::Commons::Meta::StructNavigator::GetEnumerator ( const byte *  address )

inline

Gets an IEnumerator based on an address

Parameters

address

Address of the struct to navigate

Returns

IEnumerator of DataInfos over the struct's children

GetEnumerator() [2/2]

StructNavigator::Enumerator Arp::Plc::Commons::Meta::StructNavigator::GetEnumerator ( const DataInfo &  dataInfo )

inline

Gets an IEnumerator based on a DataInfo object

Parameters

dataInfo

DataInfo of the struct to navigate

Returns

IEnumerator of DataInfos over the struct's children

GetOffset()

size_t Arp::Plc::Commons::Meta::StructNavigator::GetOffset

(

const String &

fieldName

)

Gets the offset of a field in the struct

Parameters

fieldName

name of the field

Returns

Offset of the field inside the struct

---

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

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