Public Member Functions | Protected Attributes
EC_DataStruct Class Reference

Base class for all EtherCAT register area data structs. More...

#include <ethercat_datastruct.h>

Inheritance diagram for EC_DataStruct:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual unsigned char * dump (unsigned char *a_buffer) const =0
 Dump the data struct into an array (EtherCAT Little Endian)
 EC_DataStruct (size_t a_data_length)
 Constructor.
size_t length () const
 Return length of data array expressed as a number of bytes.
virtual ~EC_DataStruct ()
 Destructor.

Protected Attributes

size_t m_data_length
 Length of data array expressed as a number of bytes.

Detailed Description

Base class for all EtherCAT register area data structs.

The main purpose of this class is to serialize and deserialize data.

Definition at line 41 of file ethercat_datastruct.h.


Constructor & Destructor Documentation

EC_DataStruct::EC_DataStruct ( size_t  a_data_length) [inline]

Constructor.

Parameters:
a_data_lengthdata length expressed as a number of bytes

Definition at line 47 of file ethercat_datastruct.h.

virtual EC_DataStruct::~EC_DataStruct ( ) [inline, virtual]

Destructor.

Definition at line 53 of file ethercat_datastruct.h.


Member Function Documentation

virtual unsigned char* EC_DataStruct::dump ( unsigned char *  a_buffer) const [pure virtual]

Dump the data struct into an array (EtherCAT Little Endian)

Parameters:
a_bufferwhere data should be dumped
Returns:
pointer just beyond the array

Implemented in EC_SyncMan, EC_FMMU, EC_SIIControlStatus, EC_ALStatus, EC_ALControl, EC_FixedStationAddress, EC_DLInformation, EC_CoE_Hdr, EC_MbxMsgHdr, and EC_Telegram.

size_t EC_DataStruct::length ( ) const [inline]

Return length of data array expressed as a number of bytes.

Returns:
the number of bytes

Definition at line 62 of file ethercat_datastruct.h.


Member Data Documentation

size_t EC_DataStruct::m_data_length [protected]

Length of data array expressed as a number of bytes.

Definition at line 75 of file ethercat_datastruct.h.


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


ros_ethercat_eml
Author(s): Tom Panis, Klaas Gadeyne, Bob Koninckx, Austin Hendrix, Manos Nikolaidis
autogenerated on Thu Aug 27 2015 14:47:07