profinet::diagnosis::DiagnosisData Struct Reference

Complete diagnosis data for one slot/subslot. More...

#include <diagnosis.h>

Collaboration diagram for profinet::diagnosis::DiagnosisData:

Public Member Functions
bool	HasErrors () const
	Whether any diagnosis entries were found.
bool	HasMaintenanceRequired () const
	Whether any entry has its maintenance-required flag set.
bool	HasMaintenanceDemanded () const
	Whether any entry has its maintenance-demanded flag set.
std::vector< const AnyChannelDiagnosis * >	GetByChannel (std::uint16_t channel) const
	Find every entry for a specific channel number.
bool	operator== (const DiagnosisData &) const =default
	Compares two DiagnosisData for equality.

Public Attributes
std::uint32_t	api = 0
	API number.
std::uint16_t	slot = 0
	Slot number.
std::uint16_t	subslot = 0
	Subslot number.
std::vector< AnyChannelDiagnosis >	entries
	Parsed diagnosis entries.
Bytes	rawData
	Raw, undecoded source data.

Detailed Description

Complete diagnosis data for one slot/subslot.

Definition at line 281 of file diagnosis.h.

Member Function Documentation

GetByChannel()

std::vector< const AnyChannelDiagnosis * > profinet::diagnosis::DiagnosisData::GetByChannel ( std::uint16_t  channel ) const

inline

Find every entry for a specific channel number.

Parameters

channel

Channel number to filter by.

Returns

Pointers to matching entries (valid as long as this DiagnosisData is alive).

Definition at line 336 of file diagnosis.h.

References entries.

HasErrors()

bool profinet::diagnosis::DiagnosisData::HasErrors ( ) const

inline

Whether any diagnosis entries were found.

Returns

True if Entries is non-empty.

Definition at line 300 of file diagnosis.h.

References entries.

HasMaintenanceDemanded()

bool profinet::diagnosis::DiagnosisData::HasMaintenanceDemanded ( ) const

inline

Whether any entry has its maintenance-demanded flag set.

Returns

True if at least one entry's Properties.MaintenanceDemanded is set.

Definition at line 321 of file diagnosis.h.

References entries.

HasMaintenanceRequired()

bool profinet::diagnosis::DiagnosisData::HasMaintenanceRequired ( ) const

inline

Whether any entry has its maintenance-required flag set.

Returns

True if at least one entry's Properties.MaintenanceRequired is set.

Definition at line 307 of file diagnosis.h.

References entries.

operator==()

bool profinet::diagnosis::DiagnosisData::operator== ( const DiagnosisData &  ) const

default

Compares two DiagnosisData for equality.

Two DiagnosisData are equal when all scalar configuration fields are equal.

Member Data Documentation

api

std::uint32_t profinet::diagnosis::DiagnosisData::api = 0

API number.

Definition at line 284 of file diagnosis.h.

Referenced by profinet::diagnosis::ParseDiagnosisBlock(), profinet::diagnosis::ParseDiagnosisSimple(), and profinet::rpc::RPCCon::ReadDiagnosis().

entries

std::vector<AnyChannelDiagnosis> profinet::diagnosis::DiagnosisData::entries

Parsed diagnosis entries.

Definition at line 293 of file diagnosis.h.

Referenced by GetByChannel(), HasErrors(), HasMaintenanceDemanded(), HasMaintenanceRequired(), profinet::diagnosis::ParseDiagnosisBlock(), profinet::diagnosis::ParseDiagnosisSimple(), profinet::rpc::RPCCon::ReadAllDiagnosis(), and profinet::rpc::RPCCon::ReadDiagnosis().

rawData

Bytes profinet::diagnosis::DiagnosisData::rawData

Raw, undecoded source data.

Definition at line 296 of file diagnosis.h.

Referenced by profinet::diagnosis::ParseDiagnosisBlock(), profinet::diagnosis::ParseDiagnosisSimple(), and profinet::rpc::RPCCon::ReadDiagnosis().

slot

std::uint16_t profinet::diagnosis::DiagnosisData::slot = 0

Slot number.

Definition at line 287 of file diagnosis.h.

Referenced by profinet::diagnosis::ParseDiagnosisBlock(), profinet::diagnosis::ParseDiagnosisSimple(), and profinet::rpc::RPCCon::ReadDiagnosis().

subslot

std::uint16_t profinet::diagnosis::DiagnosisData::subslot = 0

Subslot number.

Definition at line 290 of file diagnosis.h.

Referenced by profinet::diagnosis::ParseDiagnosisBlock(), profinet::diagnosis::ParseDiagnosisSimple(), and profinet::rpc::RPCCon::ReadDiagnosis().

---

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

• include/profinet/diagnosis.h