Arp::Plc::Domain::Services Namespace Reference

Namespace for services of the PLC domain More...

Classes
class	IPlcConfigService
	Allows to read and write parameters of the PLC config. More...
class	IPlcInfoService
	Provides informations about the Plc (realtime) project. More...
class	IPlcManagerService
	Use this service to control the PLC of the controller. More...
class	IPlcManagerService2
	The DownloadChange extension of the Arp.Plc.Domain.Services.IPlcManagerService. More...
class	PlcConfigItem
	A config item. More...
class	PlcConfigResult
	The result of a IPlcConfigService operation. More...

Enumerations
enum class	ConfigErrorCode : int32 {   None = 0 , UnspecifiedError = 1 , UnknownItem = 2 , IncompatibleType = 3 ,   InvalidParameter = 4 , FileIoError = 5 }
	The result code of a IPlcConfigService operation. More...
enum class	ConformanceCheckKind : int32 { None = 0 , Signed = 1 , SignedWithTimestamp = 2 }
	The kind of conformance check that is used in the signature verification part of the integrity check. More...
enum class	IntegrityCheckMode : int32 { None = 0 , Disabled = 1 , Warning = 2 , Error = 3 }
	The mode of the integrity check. More...
enum class	PlcConfigId : int32 { None = 0 , IntegrityCheckMode = 1 , ConformanceCheckKind = 2 , PlcRestartAfterWatchdogEnabled = 3 }
	Collects all identifiers of the Plc config which are available by the IPlcConfigService. More...
enum class	PlcInfoId : int32 { None = 0 , ProjectName = 1 , AuthorizeDataAccess = 2 , ProjectIntegrityStatus = 3 }
	Collects all identifiers of Plc informations to be read by IPlcInfoService. More...

Functions
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, ConfigErrorCode value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, ConfigErrorCode &value)
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, ConformanceCheckKind value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, ConformanceCheckKind &value)
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, IntegrityCheckMode value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, IntegrityCheckMode &value)
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, PlcConfigId value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, PlcConfigId &value)
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, PlcInfoId value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, PlcInfoId &value)

Detailed Description

Namespace for services of the PLC domain

Enumeration Type Documentation

ConfigErrorCode

enum class Arp::Plc::Domain::Services::ConfigErrorCode : int32

strong

The result code of a IPlcConfigService operation.

Enumerator
None	Success.
UnspecifiedError	Unspecified error.
UnknownItem	Unknown config id.
IncompatibleType	The type of the value is wrong.
InvalidParameter	The value is invalid.
FileIoError	The config item could not be saved. Further details can be found in the error message.

ConformanceCheckKind

enum class Arp::Plc::Domain::Services::ConformanceCheckKind : int32

strong

The kind of conformance check that is used in the signature verification part of the integrity check.

Enumerator
None	The signature verification is disabled.
Signed	The signed timestamp is used for signature verification. If there is no signed timestamp, the system timestamp is used for signature verification.
SignedWithTimestamp	There must be a signed timestamp which is used for signature verification.

IntegrityCheckMode

enum class Arp::Plc::Domain::Services::IntegrityCheckMode : int32

strong

The mode of the integrity check.

Enumerator
None	Not initialized.
Disabled	The integrity check is disabled.
Warning	The integrity check is enabled but the result is ignored.
Error	The integrity check is enabled and the PLC will not be loaded on failure.

PlcConfigId

enum class Arp::Plc::Domain::Services::PlcConfigId : int32

strong

Collects all identifiers of the Plc config which are available by the IPlcConfigService.

Enumerator
None	Not initialized.
IntegrityCheckMode	Indicates in which mode the integrity check operates.
ConformanceCheckKind	The kind of conformance check that is used in the signature verification part of the integrity check.
PlcRestartAfterWatchdogEnabled	Indicates whether an automatic Plc restart after system watchdog is enabled.

PlcInfoId

enum class Arp::Plc::Domain::Services::PlcInfoId : int32

strong

Collects all identifiers of Plc informations to be read by IPlcInfoService.

Enumerator
None	Not initialized.
ProjectName	The name of the actual project/application.
AuthorizeDataAccess	Indicates whether access to variables in GDS shall be authorized.
ProjectIntegrityStatus	Indicates whether the project integrity is valid.