Difference info for a single module (slot). More...

#include <blocks.h>

Collaboration diagram for profinet::blocks::ModuleDiffModule:

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

bool	IsProper () const
	Whether this module matches the expected configuration.

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

Public Attributes
std::uint32_t	api = 0
	API number.

std::uint16_t	slotNumber = 0
	Slot number.

std::uint32_t	moduleIdentNumber = 0
	Actual module ident number found by the device.

std::uint16_t	moduleState = 0
	Module state (see MODULE_STATE_* constants).

std::vector< ModuleDiffSubmodule >	submodules
	Submodules within this module.

Detailed Description

Difference info for a single module (slot).

Definition at line 380 of file blocks.h.

Member Function Documentation

◆ IsProper()

bool profinet::blocks::ModuleDiffModule::IsProper ( ) const

Whether this module matches the expected configuration.

Returns: True if ModuleState == MODULE_STATE_PROPER_MODULE.

Definition at line 549 of file blocks.cpp.

References profinet::MODULE_STATE_PROPER_MODULE, and moduleState.

◆ operator==()

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

default

Compares two ModuleDiffModule for equality.

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

◆ StateName()

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

Human-readable name for ModuleState.

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

Definition at line 545 of file blocks.cpp.

References profinet::GetModuleStateName(), and moduleState.

Here is the call graph for this function:

Member Data Documentation

◆ api

std::uint32_t profinet::blocks::ModuleDiffModule::api = 0

API number.

Definition at line 383 of file blocks.h.

◆ moduleIdentNumber

std::uint32_t profinet::blocks::ModuleDiffModule::moduleIdentNumber = 0

Actual module ident number found by the device.

Definition at line 389 of file blocks.h.

◆ moduleState

std::uint16_t profinet::blocks::ModuleDiffModule::moduleState = 0

Module state (see MODULE_STATE_* constants).

Definition at line 392 of file blocks.h.

Referenced by IsProper(), and StateName().

◆ slotNumber

std::uint16_t profinet::blocks::ModuleDiffModule::slotNumber = 0

Slot number.

Definition at line 386 of file blocks.h.

◆ submodules

std::vector<ModuleDiffSubmodule> profinet::blocks::ModuleDiffModule::submodules

Submodules within this module.

Definition at line 395 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