Result of a single write within a WriteMultiple operation. More...

#include <blocks.h>

Collaboration diagram for profinet::blocks::WriteMultipleResult:

Public Member Functions
bool	Success () const
	Whether this individual write succeeded.

Public Attributes
std::uint16_t	seqNum = 0
	Sequence number of this write within the batch.

std::uint32_t	api = 0
	API number.

std::uint16_t	slot = 0
	Slot number.

std::uint16_t	subslot = 0
	Subslot number.

std::uint16_t	index = 0
	Record data index written.

std::uint32_t	status = 0
	PNIO status code (0 = success).

std::uint16_t	additionalValue1 = 0
	Additional status value 1 (device-specific).

std::uint16_t	additionalValue2 = 0
	Additional status value 2 (device-specific).

Detailed Description

Result of a single write within a WriteMultiple operation.

Definition at line 449 of file blocks.h.

Member Function Documentation

◆ Success()

bool profinet::blocks::WriteMultipleResult::Success ( ) const

inline

Whether this individual write succeeded.

Returns: True if Status == 0.

Definition at line 477 of file blocks.h.

References status.

Referenced by TEST_F().

Here is the caller graph for this function:

Member Data Documentation

◆ additionalValue1

std::uint16_t profinet::blocks::WriteMultipleResult::additionalValue1 = 0

Additional status value 1 (device-specific).

Definition at line 470 of file blocks.h.

◆ additionalValue2

std::uint16_t profinet::blocks::WriteMultipleResult::additionalValue2 = 0

Additional status value 2 (device-specific).

Definition at line 473 of file blocks.h.

◆ api

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

API number.

Definition at line 455 of file blocks.h.

◆ index

std::uint16_t profinet::blocks::WriteMultipleResult::index = 0

Record data index written.

Definition at line 464 of file blocks.h.

◆ seqNum

std::uint16_t profinet::blocks::WriteMultipleResult::seqNum = 0

Sequence number of this write within the batch.

Definition at line 452 of file blocks.h.

◆ slot

std::uint16_t profinet::blocks::WriteMultipleResult::slot = 0

Slot number.

Definition at line 458 of file blocks.h.

◆ status

std::uint32_t profinet::blocks::WriteMultipleResult::status = 0

PNIO status code (0 = success).

Definition at line 467 of file blocks.h.

Referenced by Success(), and TEST_F().

◆ subslot

std::uint16_t profinet::blocks::WriteMultipleResult::subslot = 0

Subslot number.

Definition at line 461 of file blocks.h.

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

include/profinet/blocks.h

Public Member Functions

Public Attributes