Arp::System::Nm::IPayload Class Reference

Interface for Paylo objects More...

#include <IPayload.hpp>

Inheritance diagram for Arp::System::Nm::IPayload:

Public Member Functions
virtual PayloadTypeIdType	GetId () const =0
	Returns the PayloadTypeId More...
virtual const String	GetName () const =0
	Returns the PayloadTypeName More...
virtual const RawPayloadType &	GetAsRawPayloadType () const =0
	Returns a reference to the raw payload object More...
virtual const String	ToString () const =0
	Get a human readable string representation More...

Detailed Description

Interface for Paylo objects

Member Function Documentation

GetAsRawPayloadType()

virtual const RawPayloadType & Arp::System::Nm::IPayload::GetAsRawPayloadType ( ) const

pure virtual

Returns a reference to the raw payload object

The reference object must not be destroyed while the reference is used!

Implemented in Arp::System::Nm::SpecializedPayload< PayloadType >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToNotRegisteredPayload > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToUnregisteredPayload > >, Arp::System::Nm::SpecializedPayload< StringPayload >, Arp::System::Nm::SpecializedPayload< SystemManagerStatePayload >, Arp::System::Nm::SpecializedPayload< SystemStartupPayload >, Arp::System::Nm::SpecializedPayload< AckConfPayload >, Arp::System::Nm::SpecializedPayload< AddAlarmPayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload >, Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload >, Arp::System::Nm::SpecializedPayload< NetworkConfigurationChangedPayload >, Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload2 >, Arp::System::Nm::SpecializedPayload< InterfaceAddressPayload >, Arp::System::Nm::SpecializedPayload< MessageWithStationNamePayload >, Arp::System::Nm::SpecializedPayload< PnStationStatePayload >, Arp::System::Nm::SpecializedPayload< MessageWithArchiveNamePayload >, Arp::System::Nm::SpecializedPayload< StorageFileFormatMigrationPayload >, Arp::System::Nm::SpecializedPayload< StorageFileIntegrityCheckPayload >, Arp::System::Nm::SpecializedPayload< PlcStateChangedPayload >, Arp::System::Nm::SpecializedPayload< SecurityNotificationPayload >, and Arp::System::Nm::GenericPayload.

GetId()

virtual PayloadTypeIdType Arp::System::Nm::IPayload::GetId ( ) const

pure virtual

Returns the PayloadTypeId

Implemented in Arp::System::Nm::SpecializedPayload< PayloadType >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToNotRegisteredPayload > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToUnregisteredPayload > >, Arp::System::Nm::SpecializedPayload< StringPayload >, Arp::System::Nm::SpecializedPayload< SystemManagerStatePayload >, Arp::System::Nm::SpecializedPayload< SystemStartupPayload >, Arp::System::Nm::SpecializedPayload< AckConfPayload >, Arp::System::Nm::SpecializedPayload< AddAlarmPayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload >, Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload >, Arp::System::Nm::SpecializedPayload< NetworkConfigurationChangedPayload >, Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload2 >, Arp::System::Nm::SpecializedPayload< InterfaceAddressPayload >, Arp::System::Nm::SpecializedPayload< MessageWithStationNamePayload >, Arp::System::Nm::SpecializedPayload< PnStationStatePayload >, Arp::System::Nm::SpecializedPayload< MessageWithArchiveNamePayload >, Arp::System::Nm::SpecializedPayload< StorageFileFormatMigrationPayload >, Arp::System::Nm::SpecializedPayload< StorageFileIntegrityCheckPayload >, Arp::System::Nm::SpecializedPayload< PlcStateChangedPayload >, Arp::System::Nm::SpecializedPayload< SecurityNotificationPayload >, and Arp::System::Nm::GenericPayload.

GetName()

virtual const String Arp::System::Nm::IPayload::GetName ( ) const

pure virtual

Returns the PayloadTypeName

Implemented in Arp::System::Nm::SpecializedPayload< PayloadType >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToNotRegisteredPayload > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToUnregisteredPayload > >, Arp::System::Nm::SpecializedPayload< StringPayload >, Arp::System::Nm::SpecializedPayload< SystemManagerStatePayload >, Arp::System::Nm::SpecializedPayload< SystemStartupPayload >, Arp::System::Nm::SpecializedPayload< AckConfPayload >, Arp::System::Nm::SpecializedPayload< AddAlarmPayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload >, Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload >, Arp::System::Nm::SpecializedPayload< NetworkConfigurationChangedPayload >, Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload2 >, Arp::System::Nm::SpecializedPayload< InterfaceAddressPayload >, Arp::System::Nm::SpecializedPayload< MessageWithStationNamePayload >, Arp::System::Nm::SpecializedPayload< PnStationStatePayload >, Arp::System::Nm::SpecializedPayload< MessageWithArchiveNamePayload >, Arp::System::Nm::SpecializedPayload< StorageFileFormatMigrationPayload >, Arp::System::Nm::SpecializedPayload< StorageFileIntegrityCheckPayload >, Arp::System::Nm::SpecializedPayload< PlcStateChangedPayload >, Arp::System::Nm::SpecializedPayload< SecurityNotificationPayload >, and Arp::System::Nm::GenericPayload.

ToString()

virtual const String Arp::System::Nm::IPayload::ToString ( ) const

pure virtual

Get a human readable string representation

Implemented in Arp::System::Nm::GenericPayload, Arp::System::Nm::SpecializedPayload< PayloadType >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToNotRegisteredPayload > >, Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< NmSubscribeToUnregisteredPayload > >, Arp::System::Nm::SpecializedPayload< StringPayload >, Arp::System::Nm::SpecializedPayload< SystemManagerStatePayload >, Arp::System::Nm::SpecializedPayload< SystemStartupPayload >, Arp::System::Nm::SpecializedPayload< AckConfPayload >, Arp::System::Nm::SpecializedPayload< AddAlarmPayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload >, Arp::System::Nm::SpecializedPayload< EthernetLinkStatePayload >, Arp::System::Nm::SpecializedPayload< NetworkConfigurationChangedPayload >, Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >, Arp::System::Nm::SpecializedPayload< AlarmPayload2 >, Arp::System::Nm::SpecializedPayload< InterfaceAddressPayload >, Arp::System::Nm::SpecializedPayload< MessageWithStationNamePayload >, Arp::System::Nm::SpecializedPayload< PnStationStatePayload >, Arp::System::Nm::SpecializedPayload< MessageWithArchiveNamePayload >, Arp::System::Nm::SpecializedPayload< StorageFileFormatMigrationPayload >, Arp::System::Nm::SpecializedPayload< StorageFileIntegrityCheckPayload >, Arp::System::Nm::SpecializedPayload< PlcStateChangedPayload >, and Arp::System::Nm::SpecializedPayload< SecurityNotificationPayload >.

---

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

• Arp/System/Nm/IPayload.hpp