profinet::UploadRetrievalItem Struct Reference

Upload/Retrieval alarm item (USI 0x8200, 0x8201). More...

#include <alarms.h>

Collaboration diagram for profinet::UploadRetrievalItem:

Public Member Functions
std::string	UsiName () const
	Human-readable name for this item's USI.
bool	IsUpload () const
	Whether this is an upload record.
bool	IsRetrieval () const
	Whether this is an iParameter retrieval record.

Public Attributes
Usi	userStructureId = Usi::Upload
	User Structure Identifier for this item.
BlockType	blockType
	Nested block type.
std::uint16_t	blockLength = 0
	Nested block length.
std::uint16_t	blockVersion = 0
	Nested block version.
std::uint32_t	urRecordIndex = 0
	Record index the upload/retrieval refers to.
std::uint32_t	urRecordLength = 0
	Record length in bytes.

Detailed Description

Upload/Retrieval alarm item (USI 0x8200, 0x8201).

Both USI_UPLOAD and USI_IPARAMETER are parsed into this type (not into IParameterItem below, which the parser never actually produces).

Definition at line 157 of file alarms.h.

Member Function Documentation

IsRetrieval()

bool profinet::UploadRetrievalItem::IsRetrieval ( ) const

inline

Whether this is an iParameter retrieval record.

Returns

True if UserStructureId is USI_IPARAMETER.

Definition at line 193 of file alarms.h.

References profinet::IParameter, and userStructureId.

IsUpload()

bool profinet::UploadRetrievalItem::IsUpload ( ) const

inline

Whether this is an upload record.

Returns

True if UserStructureId is USI_UPLOAD.

Definition at line 186 of file alarms.h.

References profinet::Upload, and userStructureId.

UsiName()

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

inline

Human-readable name for this item's USI.

Returns

The USI name (see GetUsiName()).

Definition at line 179 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::UploadRetrievalItem::blockLength = 0

Nested block length.

Definition at line 166 of file alarms.h.

blockType

BlockType profinet::UploadRetrievalItem::blockType

Nested block type.

Definition at line 163 of file alarms.h.

blockVersion

std::uint16_t profinet::UploadRetrievalItem::blockVersion = 0

Nested block version.

Definition at line 169 of file alarms.h.

urRecordIndex

std::uint32_t profinet::UploadRetrievalItem::urRecordIndex = 0

Record index the upload/retrieval refers to.

Definition at line 172 of file alarms.h.

urRecordLength

std::uint32_t profinet::UploadRetrievalItem::urRecordLength = 0

Record length in bytes.

Definition at line 175 of file alarms.h.

userStructureId

Usi profinet::UploadRetrievalItem::userStructureId = Usi::Upload

User Structure Identifier for this item.

Definition at line 160 of file alarms.h.

Referenced by IsRetrieval(), IsUpload(), and UsiName().

---

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

• include/profinet/alarms.h