Difference info for a single submodule. More...

#include <blocks.h>

Collaboration diagram for profinet::blocks::ModuleDiffSubmodule:

Public Member Functions
std::string	StateName () const
	Human-readable name for SubmoduleState.

bool	IsOk () const
	Whether this submodule matches the expected configuration.

bool	operator== (const ModuleDiffSubmodule &) const =default
	Compares two ModuleDiffSubmodule for equality.

Public Attributes
std::uint16_t	subslotNumber = 0
	Subslot number.

std::uint32_t	submoduleIdentNumber = 0
	Actual submodule ident number found by the device.

std::uint16_t	submoduleState = 0
	Submodule state (see SUBMODULE_STATE_* constants).

Detailed Description

Difference info for a single submodule.

Definition at line 352 of file blocks.h.

Member Function Documentation

◆ IsOk()

bool profinet::blocks::ModuleDiffSubmodule::IsOk ( ) const

Whether this submodule matches the expected configuration.

Returns: True if SubmoduleState == SUBMODULE_STATE_OK.

Definition at line 540 of file blocks.cpp.

References profinet::SUBMODULE_STATE_OK, and submoduleState.

◆ operator==()

bool profinet::blocks::ModuleDiffSubmodule::operator== ( const ModuleDiffSubmodule & ) const

default

Compares two ModuleDiffSubmodule for equality.

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

◆ StateName()

std::string profinet::blocks::ModuleDiffSubmodule::StateName ( ) const

Human-readable name for SubmoduleState.

Returns: The state name, e.g. "OK".

Definition at line 536 of file blocks.cpp.

References profinet::GetSubmoduleStateName(), and submoduleState.

Here is the call graph for this function:

Member Data Documentation

◆ submoduleIdentNumber

std::uint32_t profinet::blocks::ModuleDiffSubmodule::submoduleIdentNumber = 0

Actual submodule ident number found by the device.

Definition at line 358 of file blocks.h.

◆ submoduleState

std::uint16_t profinet::blocks::ModuleDiffSubmodule::submoduleState = 0

Submodule state (see SUBMODULE_STATE_* constants).

Definition at line 361 of file blocks.h.

Referenced by IsOk(), and StateName().

◆ subslotNumber

std::uint16_t profinet::blocks::ModuleDiffSubmodule::subslotNumber = 0

Subslot number.

Definition at line 355 of file blocks.h.

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

include/profinet/blocks.h
src/blocks.cpp

Public Member Functions

Public Attributes