Arp::Plc::Domain::Commons::DcgResultInfo Class Reference

This class is used to return the result of a PLC operation concerning download-changes (Dcg). More...

#include <DcgResultInfo.hpp>

Inheritance diagram for Arp::Plc::Domain::Commons::DcgResultInfo:

Public Member Functions
	DcgResultInfo (void)
	The default constructor creates an empty instance.
DcgResult	GetResult (void) const
	Returns the download-changes result as DcgResult.
String	GetMessage (void) const
	Returns the reason message when the operations was refused. More...
void	Serialize (RscWriter &writer) const
	Serializes this instance for RSC communication. More...
void	Deserialize (RscReader &reader)
	Deserializes this instance for RSC communication. More...
Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
	RscSerializable (void)=default
	The default constructor.

Static Public Member Functions
static DcgResultInfo	CreateEmpty (void)
	Creates an empty result of a PLC operation, which was not executed during download-changes.
static DcgResultInfo	CreateSuccess (void)
	Creates a successful result of a PLC operation, which was executed during download-changes.
static DcgResultInfo	CreateRefused (const String &refusedReason)
	Creates a result info of a PLC operation during download-changes, indicating that the operations was refused. More...
static size_t	GetFieldCount (void)
	Gets the number of fields of this class, used by RSC serialization. More...

Detailed Description

This class is used to return the result of a PLC operation concerning download-changes (Dcg).

Member Function Documentation

CreateRefused()

DcgResultInfo Arp::Plc::Domain::Commons::DcgResultInfo::CreateRefused ( const String &  refusedReason )

static

Creates a result info of a PLC operation during download-changes, indicating that the operations was refused.

It is valid for any Plc operation to refuse a change operation, e.g. the new project configuration contains modifications that are not changeable by the component. So that the PLC manager does not handle this result info as an error, but informs the caller, that the download-changes transaction was not processed and the original project configuration remains.

Parameters

refusedReason

The refused reason, that will be used for notifications and logging.

Deserialize()

void Arp::Plc::Domain::Commons::DcgResultInfo::Deserialize

(

RscReader &

reader

)

Deserializes this instance for RSC communication.

Parameters

reader

The RSC reader to deserialize this instance from.

GetFieldCount()

size_t Arp::Plc::Domain::Commons::DcgResultInfo::GetFieldCount ( void  )

static

Gets the number of fields of this class, used by RSC serialization.

Returns

The number of fields of this class.

GetMessage()

String Arp::Plc::Domain::Commons::DcgResultInfo::GetMessage

(

void

)

const

Returns the reason message when the operations was refused.

This value might be empty.

Serialize()

void Arp::Plc::Domain::Commons::DcgResultInfo::Serialize

(

RscWriter &

writer

)

const

Serializes this instance for RSC communication.

Parameters

writer

The RSC writer to serialize this instance to.

---

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

• Arp/Plc/Domain/Commons/DcgResultInfo.hpp
• Arp/Plc/Domain/Commons/DcgResultInfo.cpp