PLCnext API Documentation 25.0.2.69
AlarmInfo.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
10#include <vector>
11
12// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
13
15{
16
17using namespace Arp;
18using namespace Arp::Base::Rsc::Commons;
19using namespace Arp::Base::Rsc::Commons::Services;
20
25class ARP_EXPORT AlarmInfo : public RscSerializable
26{
27public: // construction/destruction
28 AlarmInfo(void);
29 AlarmInfo(boolean newAlarmReceived, uint32 id, uint16 blockType, uint16 blockLength, uint16 blockVersion, uint16 alarmType, uint32 api, uint16 slot, uint16 subslot, uint32 moduleId, uint32 submoduleId, uint16 alarmSpecifier, uint16 userStructId, const std::vector<byte>& alarmInfoItem);
30
31public: // Properties
35 boolean NewAlarmReceived = false;
36
40 uint32 Id = 0;
41
45 uint16 BlockType = 0;
46
50 uint16 BlockLength = 0;
51
55 uint16 BlockVersion = 0;
56
60 uint16 AlarmType = 0;
61
65 uint32 Api = 0;
66
70 uint16 Slot = 0;
71
75 uint16 Subslot = 0;
76
80 uint32 ModuleId = 0;
81
85 uint32 SubmoduleId = 0;
86
90 uint16 AlarmSpecifier = 0;
91
95 uint16 UserStructId = 0;
96
100 std::vector<byte> AlarmInfoItem;
101
102public: // Rsc operations
103 void Serialize(RscWriter& writer)const;
104 void Deserialize(RscReader& reader);
105 static size_t GetFieldCount(void);
106};
107
108} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Any custom struct type which is intended to be marshalled in a Rsc serialization context,...
Definition: RscSerializable.hpp:35
Reads marshaled data of RSC services.
Definition: RscReader.hpp:34
Writes marshalled data of RSC services.
Definition: RscWriter.hpp:34
This structure contains all information about a received alarm. For more information read the PROFINE...
Definition: AlarmInfo.hpp:26
AlarmInfo(void)
Constructs an AlarmInfo instance.
std::vector< byte > AlarmInfoItem
Alarm info item
Definition: AlarmInfo.hpp:100
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:33
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:29
Namespace for Profinet I/O controller services
Root namespace for the PLCnext API