profinet::MaintenanceItem Struct Reference

Maintenance alarm item (USI 0x8100). More...

#include <alarms.h>

Collaboration diagram for profinet::MaintenanceItem:

Public Member Functions
std::string	UsiName () const
	Human-readable name for this item's USI.
bool	MaintenanceRequired () const
	Whether maintenance is required.
bool	MaintenanceDemanded () const
	Whether maintenance is demanded (more urgent than required).

Public Attributes
Usi	userStructureId = Usi::Maintenance
	User Structure Identifier for this item.
BlockType	blockType = BlockType::Unknown
	Nested block type.
std::uint16_t	blockLength = 0
	Nested block length.
std::uint16_t	blockVersion = 0
	Nested block version.
std::uint32_t	maintenanceStatus = 0
	Maintenance status bitmask.

Detailed Description

Maintenance alarm item (USI 0x8100).

Definition at line 115 of file alarms.h.

Member Function Documentation

MaintenanceDemanded()

bool profinet::MaintenanceItem::MaintenanceDemanded ( ) const

inline

Whether maintenance is demanded (more urgent than required).

Returns

True if the MaintenanceDemanded bit (0x02) is set.

Definition at line 148 of file alarms.h.

References maintenanceStatus.

MaintenanceRequired()

bool profinet::MaintenanceItem::MaintenanceRequired ( ) const

inline

Whether maintenance is required.

Returns

True if the MaintenanceRequired bit (0x01) is set.

Definition at line 141 of file alarms.h.

References maintenanceStatus.

UsiName()

std::string profinet::MaintenanceItem::UsiName ( ) const

inline

Human-readable name for this item's USI.

Returns

The USI name (see GetUsiName()).

Definition at line 134 of file alarms.h.

References profinet::GetUsiName(), and userStructureId.

Here is the call graph for this function:

Member Data Documentation

blockLength

std::uint16_t profinet::MaintenanceItem::blockLength = 0

Nested block length.

Definition at line 124 of file alarms.h.

blockType

BlockType profinet::MaintenanceItem::blockType = BlockType::Unknown

Nested block type.

Definition at line 121 of file alarms.h.

blockVersion

std::uint16_t profinet::MaintenanceItem::blockVersion = 0

Nested block version.

Definition at line 127 of file alarms.h.

maintenanceStatus

std::uint32_t profinet::MaintenanceItem::maintenanceStatus = 0

Maintenance status bitmask.

Definition at line 130 of file alarms.h.

Referenced by MaintenanceDemanded(), and MaintenanceRequired().

userStructureId

Usi profinet::MaintenanceItem::userStructureId = Usi::Maintenance

User Structure Identifier for this item.

Definition at line 118 of file alarms.h.

Referenced by UsiName().

---

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

• include/profinet/alarms.h