eip::ForwardOpenRequest Class Reference

#include <forward_open_request.h>

Inheritance diagram for eip::ForwardOpenRequest:

List of all members.

Public Member Functions
virtual Reader &	deserialize (Reader &reader, size_t length)
virtual Reader &	deserialize (Reader &reader)
virtual size_t	getLength () const
Path &	getPath ()
virtual Writer &	serialize (Writer &writer) const
EIP_DWORD	setOriginToTargetParams (EIP_UINT size, bool variable, EIP_BYTE priority, EIP_BYTE type, bool shared)
EIP_DWORD	setTargetToOriginParams (EIP_UINT size, bool variable, EIP_BYTE priority, EIP_BYTE type, bool shared)
Static Public Member Functions
static EIP_DWORD	calcConnectionParams (EIP_UINT size, bool variable, EIP_BYTE priority, EIP_BYTE type, bool shared)
Public Attributes
EIP_BYTE	conn_type
EIP_UINT	connection_sn
EIP_DWORD	o_to_t_conn_params
EIP_UDINT	o_to_t_connection_id
EIP_UDINT	o_to_t_rpi
EIP_UDINT	originator_sn
EIP_UINT	originator_vendor_id
EIP_DWORD	t_to_o_conn_params
EIP_UDINT	t_to_o_connection_id
EIP_UDINT	t_to_o_rpi
EIP_USINT	timeout_multiplyer
EIP_BYTE	timeout_tick_size
EIP_USINT	timeout_ticks
Private Attributes
Path	path_

---

Detailed Description

Class to encapsulate a ForwardOpenRequest data. Note that this is currently only LARGE forward open, but could be easily changed to support both.

Definition at line 66 of file forward_open_request.h.

---

Member Function Documentation

static EIP_DWORD eip::ForwardOpenRequest::calcConnectionParams	(	EIP_UINT	size,
		bool	variable,
		EIP_BYTE	priority,
		EIP_BYTE	type,
		bool	shared
	)		[inline, static]

Helper to calculate connection parameters

Parameters:

size	Maximum size of the messages in the connection in byte
variable	if set to true, variable message sizes
priority	Priority value for the connection
type	Connection type / class info
shared	If set to true, then a shared connection

Definition at line 92 of file forward_open_request.h.

virtual Reader& eip::ForwardOpenRequest::deserialize	(	Reader &	reader,
		size_t	length
	)		[inline, virtual]

Not implemented. Never expect to have to receive this type of message.

Definition at line 183 of file forward_open_request.h.

virtual Reader& eip::ForwardOpenRequest::deserialize

(

Reader &

reader

)

[inline, virtual]

Not implemented. Never expect to have to receive this type of message.

Definition at line 191 of file forward_open_request.h.

virtual size_t eip::ForwardOpenRequest::getLength

(

)

const [inline, virtual]

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

Returns:

Total length in bytes to be serialized

Definition at line 132 of file forward_open_request.h.

Path& eip::ForwardOpenRequest::getPath

(

)

[inline]

Get the path in the given message router request

Returns:

reference to the current Path

Definition at line 123 of file forward_open_request.h.

virtual Writer& eip::ForwardOpenRequest::serialize

(

Writer &

writer

)

const [inline, virtual]

Serialize data into the given buffer

Parameters:

writer

Writer to use for serialization

Returns:

the writer again

Exceptions:

std::length_error

if the buffer is too small for the header data

Definition at line 157 of file forward_open_request.h.

EIP_DWORD eip::ForwardOpenRequest::setOriginToTargetParams	(	EIP_UINT	size,
		bool	variable,
		EIP_BYTE	priority,
		EIP_BYTE	type,
		bool	shared
	)		[inline]

Shortcut to set the origin to target parameters.

Definition at line 102 of file forward_open_request.h.

EIP_DWORD eip::ForwardOpenRequest::setTargetToOriginParams	(	EIP_UINT	size,
		bool	variable,
		EIP_BYTE	priority,
		EIP_BYTE	type,
		bool	shared
	)		[inline]

Shortcut to set the target to origin params.

Definition at line 112 of file forward_open_request.h.

---

Member Data Documentation

EIP_BYTE eip::ForwardOpenRequest::conn_type

Definition at line 82 of file forward_open_request.h.

EIP_UINT eip::ForwardOpenRequest::connection_sn

Definition at line 74 of file forward_open_request.h.

EIP_DWORD eip::ForwardOpenRequest::o_to_t_conn_params

Definition at line 79 of file forward_open_request.h.

EIP_UDINT eip::ForwardOpenRequest::o_to_t_connection_id

Definition at line 72 of file forward_open_request.h.

EIP_UDINT eip::ForwardOpenRequest::o_to_t_rpi

Definition at line 78 of file forward_open_request.h.

EIP_UDINT eip::ForwardOpenRequest::originator_sn

Definition at line 76 of file forward_open_request.h.

EIP_UINT eip::ForwardOpenRequest::originator_vendor_id

Definition at line 75 of file forward_open_request.h.

Path eip::ForwardOpenRequest::path_ [private]

Definition at line 197 of file forward_open_request.h.

EIP_DWORD eip::ForwardOpenRequest::t_to_o_conn_params

Definition at line 81 of file forward_open_request.h.

EIP_UDINT eip::ForwardOpenRequest::t_to_o_connection_id

Definition at line 73 of file forward_open_request.h.

EIP_UDINT eip::ForwardOpenRequest::t_to_o_rpi

Definition at line 80 of file forward_open_request.h.

EIP_USINT eip::ForwardOpenRequest::timeout_multiplyer

Definition at line 77 of file forward_open_request.h.

EIP_BYTE eip::ForwardOpenRequest::timeout_tick_size

Definition at line 70 of file forward_open_request.h.

EIP_USINT eip::ForwardOpenRequest::timeout_ticks

Definition at line 71 of file forward_open_request.h.

---

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

• forward_open_request.h