Public Member Functions | Protected Member Functions | Protected Attributes
EC_Frame Class Reference

EtherCAT Frame base class. More...

#include <ethercat_frame.h>

Inheritance diagram for EC_Frame:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual int build (const unsigned char *a_buffer)
 Build and check frame starting from byte array.
virtual unsigned char * dump (unsigned char *a_buffer) const
 Dump the contents of a frame into an byte array.
EC_Telegramget_telegram () const
 Get first telegram.
size_t length (void) const
 return the length of the whole frame

Protected Member Functions

virtual size_t body_length (void) const
 Return the length of the body.
virtual bool check_header (const unsigned char *a_buffer) const =0
 Check if received header in byte array complies to the frame data.
virtual unsigned char * dump_header (unsigned char *a_buffer) const =0
 Dump the header.
 EC_Frame ()
 Constructor.
 EC_Frame (const EC_Frame &a_frame)
 EC_Frame (EC_Telegram *a_telegram)
virtual size_t header_length (void) const =0
 Return the length of the header.

Protected Attributes

EC_Telegramm_telegram
 Pointer to the first EtherCAT.

Detailed Description

EtherCAT Frame base class.

Todo:
This interface is not complete, eg. currently there is no way to add/remove telegrams to a frame. Note however that this EtherCAT feature is rarely used AFAIS.

Definition at line 94 of file ethercat_frame.h.


Constructor & Destructor Documentation

EC_Frame::EC_Frame ( ) [protected]

Constructor.

EC_Frame::EC_Frame ( const EC_Frame a_frame) [protected]
EC_Frame::EC_Frame ( EC_Telegram a_telegram) [protected]

Member Function Documentation

virtual size_t EC_Frame::body_length ( void  ) const [protected, virtual]

Return the length of the body.

virtual int EC_Frame::build ( const unsigned char *  a_buffer) [virtual]

Build and check frame starting from byte array.

Implements EtherCAT_Frame.

virtual bool EC_Frame::check_header ( const unsigned char *  a_buffer) const [protected, pure virtual]

Check if received header in byte array complies to the frame data.

Implemented in EC_Ethernet_Frame.

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

Dump the contents of a frame into an byte array.

Implements EtherCAT_Frame.

virtual unsigned char* EC_Frame::dump_header ( unsigned char *  a_buffer) const [protected, pure virtual]

Dump the header.

Implemented in EC_Ethernet_Frame.

EC_Telegram* EC_Frame::get_telegram ( ) const [inline, virtual]

Get first telegram.

Implements EtherCAT_Frame.

Definition at line 112 of file ethercat_frame.h.

virtual size_t EC_Frame::header_length ( void  ) const [protected, pure virtual]

Return the length of the header.

Implemented in EC_Ethernet_Frame.

size_t EC_Frame::length ( void  ) const [inline, virtual]

return the length of the whole frame

Returns:
the length of the whole frame in bytes

Implements EtherCAT_Frame.

Definition at line 100 of file ethercat_frame.h.


Member Data Documentation

Pointer to the first EtherCAT.

Definition at line 124 of file ethercat_frame.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 Jul 4 2019 20:01:50