Public Member Functions | Public Attributes | List of all members
eip::SequencedAddressItem Class Reference

#include <sequenced_address_item.h>

Inheritance diagram for eip::SequencedAddressItem:
Inheritance graph
[legend]

Public Member Functions

virtual Readerdeserialize (Reader &reader)
 
virtual Readerdeserialize (Reader &reader, size_t length)
 
virtual size_t getLength () const
 
 SequencedAddressItem (EIP_UDINT connection=0, EIP_UDINT sequence=0)
 
virtual Writerserialize (Writer &writer) const
 

Public Attributes

EIP_UDINT connection_id
 
EIP_UDINT sequence_num
 

Detailed Description

Data structure for data portion of the session registration command and response

Definition at line 46 of file sequenced_address_item.h.

Constructor & Destructor Documentation

◆ SequencedAddressItem()

eip::SequencedAddressItem::SequencedAddressItem ( EIP_UDINT  connection = 0,
EIP_UDINT  sequence = 0 
)
inline

Definition at line 52 of file sequenced_address_item.h.

Member Function Documentation

◆ deserialize() [1/2]

virtual Reader& eip::SequencedAddressItem::deserialize ( Reader reader)
inlinevirtual

Deserialize data from the given reader without length information

Parameters
readerReader to use for deserialization
Returns
the reader again
Exceptions
std::length_errorif the buffer is overrun while deserializing

Implements eip::serialization::Serializable.

Definition at line 91 of file sequenced_address_item.h.

◆ deserialize() [2/2]

virtual Reader& eip::SequencedAddressItem::deserialize ( Reader reader,
size_t  length 
)
inlinevirtual

Extra length information is not relevant in this context. Same as deserialize(reader)

Implements eip::serialization::Serializable.

Definition at line 80 of file sequenced_address_item.h.

◆ getLength()

virtual size_t eip::SequencedAddressItem::getLength ( ) const
inlinevirtual

Get the length of serialized data that would be produced if serialized

Returns
Total length in bytes to be serialized

Implements eip::serialization::Serializable.

Definition at line 59 of file sequenced_address_item.h.

◆ serialize()

virtual Writer& eip::SequencedAddressItem::serialize ( Writer writer) const
inlinevirtual

Serialize data into the given buffer

Parameters
writerWriter to use for serialization
Returns
the writer again
Exceptions
std::length_errorif the buffer is too small for the header data

Implements eip::serialization::Serializable.

Definition at line 70 of file sequenced_address_item.h.

Member Data Documentation

◆ connection_id

EIP_UDINT eip::SequencedAddressItem::connection_id

Definition at line 49 of file sequenced_address_item.h.

◆ sequence_num

EIP_UDINT eip::SequencedAddressItem::sequence_num

Definition at line 50 of file sequenced_address_item.h.


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


odva_ethernetip
Author(s): Kareem Shehata
autogenerated on Wed Mar 2 2022 00:38:56