Arp Namespace Reference

Root namespace for the PLCnext API More...

Namespaces
namespace	Device
	Namespace for device abstraction components
namespace	Hardware
	Namespace for hardware abstraction components
namespace	Io
	Namespace for I/O subsystems
namespace	Plc
	Namespace for classes related to the PLC functionality
namespace	Services
	Namespace for service components
namespace	System
	Namespace of system functions of PLCnext

Classes
class	ConstraintHandler

Functions
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (ComponentCategory value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, ComponentCategory &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (DurationUnit value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, DurationUnit &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (Arp::System::Commons::ExceptionTypeId value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, Arp::System::Commons::ExceptionTypeId &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (FileAccess value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, FileAccess &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (FileMode value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, FileMode &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (SeekOrigin value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, SeekOrigin &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (PollMode value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, PollMode &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (ShutdownMode value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, ShutdownMode &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (SocketError value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, SocketError &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (KeyPairType value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, KeyPairType &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (SecurityConfigurationError value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, SecurityConfigurationError &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (SecurityListType value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, SecurityListType &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (ThreadState value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, ThreadState &value)
ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, Endianness value)
ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, Endianness &value)
template<class T >
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (T value)
	Deprecated! This helper function returns the string of the specified enum entry. More...
template<class T >
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, T &value)
	Deprecated! This helper function tries to return the enum entry of the specified string. More...
template<class T >
class	ARP_DEPRECATED ("Use Arp::Enum<T> instead.") EnumStrings
	Deprecated! The class implements an adapter for enums to define the string literals of the enum entries. More...
bool	SecureStrIsNullOrEmpty (const char *str, size_t maxSize)
size_t	SecureStrnlen (const char *str, size_t maxSize)
void	SecureStrcpy (char *dest, size_t destMaxSize, const char *src)
void	SecureStrncpy (char *dest, size_t destMaxSize, const char *src, size_t count)
template<typename T >
auto	format_cast (T &&value)
auto	format_cast (int8 value)
auto	format_cast (uint8 value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (NotificationRegistrationStatus value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, NotificationRegistrationStatus &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (Severity value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, Severity &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (SystemManagerState value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, SystemManagerState &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (EthernetLinkState value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, EthernetLinkState &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (PciDeviceState value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, PciDeviceState &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (PnStationType value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, PnStationType &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (StorageFileFormatMigrationResult value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, StorageFileFormatMigrationResult &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (Operation value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, Operation &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (UmAuthenticationResult value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, UmAuthenticationResult &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (RecordType value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, RecordType &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (SinkType value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, SinkType &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (TriggerConditionOperation value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, TriggerConditionOperation &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (PlcStartKind value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, PlcStartKind &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (PlcState value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, PlcState &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (Arp::Plc::Commons::Esm::ExceptionTypeId value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, Arp::Plc::Commons::Esm::ExceptionTypeId &value)
template<>
ARP_CXX_SYMBOL_EXPORT const char *	GetEnumString (ArDataAccessError value)
template<>
ARP_CXX_SYMBOL_EXPORT bool	TryGetEnumValue (const char *name, ArDataAccessError &value)

Detailed Description

Root namespace for the PLCnext API

Function Documentation

ARP_DEPRECATED()

template<class T >

class Arp::ARP_DEPRECATED

(

"Use Arp::Enum<T> instead."

)

Deprecated! The class implements an adapter for enums to define the string literals of the enum entries.

Template Parameters

T	The type of the enum.

This class is deprecated! Use Arp::Enum<T> instead.

Deprecated! Returns the string of the specified enum entry.

Parameters

key	The enum entry of enmum T to get the associated string from.

Returns

The string literal of the as argument passed enum entry.

This class is deprecated! Use Arp::Enum<T> instead.

Deprecated! Tries to return the enum entry of the specified string.

Parameters

name	The string to get the associated enum entry of enum T from.
value	The enum entry of enum T associated to the argument passed name .

Returns

true on success, otherwise false.

This class is deprecated! Use Arp::Enum<T> instead.

GetEnumString()

template<class T >

ARP_CXX_SYMBOL_EXPORT const char * Arp::GetEnumString

(

T

value

)

Deprecated! This helper function returns the string of the specified enum entry.

Template Parameters

T	The type of the enum.

Parameters

value

The enum entry of enum T to get the associated string from.

Returns

The string literal of the as argument passed enum entry.

Deprecated:

Use Arp::Enum<T> instead.

TryGetEnumValue()

template<class T >

ARP_CXX_SYMBOL_EXPORT bool Arp::TryGetEnumValue	(	const char *	name,
		T &	value
	)

Deprecated! This helper function tries to return the enum entry of the specified string.

Template Parameters

T	The type of the enum.

Parameters

name	The string to get the associated enum entry of enum T from.
value	The enum entry of enum T associated to the argument passed name .

Returns

true on success, otherwise false.

Deprecated:

Use Arp::Enum<T> instead.