Arp::Io::ProfinetStack::Controller::Services::ArDataResult Class Reference

Container for a combination of an error code and a value which is a result for a read operation to a single setting. More...

#include <ArDataResult.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::ArDataResult:

Public Member Functions
	ArDataResult (void)
	Constructs an ArDataResult instance.
	ArDataResult (ArDataAccessError errorCode, const RscVariant< 512 > &value)
	Constructs an ArDataResult instance.
void	Serialize (RscWriter &writer) const
	Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
void	Deserialize (RscReader &reader)
	Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
void	Serialize (JRscWriter &writer) const
	Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter. More...
void	Deserialize (JRscReader &reader)
	Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader. More...
Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
	RscSerializable (void)=default
	The default constructor.

Static Public Member Functions
static size_t	GetFieldCount (void)
	Returns the count of fields More...

Public Attributes
ArDataAccessError	ErrorCode = static_cast<ArDataAccessError>(0)
	An error code which describes the reason why a setting could not be read with The error codes can be interpreted with the help of the enumeration Arp.Io.ProfinetStack.Controller.Services.ArDataAccessError.
RscVariant< 512 >	Value
	The value for the requested setting which can be RscType::Void and otherwise is of the simple type the setting has. More...

Detailed Description

Container for a combination of an error code and a value which is a result for a read operation to a single setting.

The structure is used as result by Arp.Io.ProfinetStack.Controller.Services.IArDataService.GetAttributeValue A sequence of instances of this structure is used as result by Arp.Io.ProfinetStack.Controller.Services.IArDataService.GetAttributeValues.

Member Function Documentation

Deserialize() [1/2]

void Arp::Io::ProfinetStack::Controller::Services::ArDataResult::Deserialize

(

JRscReader &

reader

)

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

Parameters

reader

Reference to RscReader.

Deserialize() [2/2]

void Arp::Io::ProfinetStack::Controller::Services::ArDataResult::Deserialize

(

RscReader &

reader

)

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

Parameters

reader

Reference to RscReader.

GetFieldCount()

size_t Arp::Io::ProfinetStack::Controller::Services::ArDataResult::GetFieldCount ( void  )

static

Returns the count of fields

Returns

Count of fields.

The field count is used for serialization via Rsc

Serialize() [1/2]

void Arp::Io::ProfinetStack::Controller::Services::ArDataResult::Serialize

(

JRscWriter &

writer

)

const

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

Parameters

writer

Reference to RscWriter

Serialize() [2/2]

void Arp::Io::ProfinetStack::Controller::Services::ArDataResult::Serialize

(

RscWriter &

writer

)

const

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

Parameters

writer

Reference to RscWriter

Member Data Documentation

Value

RscVariant<512> Arp::Io::ProfinetStack::Controller::Services::ArDataResult::Value

The value for the requested setting which can be

RscType::Void

and otherwise is of the simple type the setting has.

Please note that this property is

RscType::Void

whenever the member Arp.Io.ProfinetStack.Controller.Services.ArDataResult.ErrorCode indicates an error which means it is not Arp.Io.ProfinetStack.Controller.Services.ArDataAccessError.None.

---

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

• Arp/Io/ProfinetStack/Controller/Services/ArDataResult.hpp
• Arp/Io/ProfinetStack/Controller/Services/ArDataResult.cpp