Public Types | Public Member Functions | Public Attributes | List of all members
segData Class Reference

#include <SDOSegmented.h>

Public Types

enum  SDOStatusFlag { SDO_SEG_FREE = 0, SDO_SEG_WAITING = 3, SDO_SEG_COLLECTING = 2, SDO_SEG_PROCESSING = 1 }
 

Public Member Functions

void resetTransferData ()
 
 segData ()
 
 ~segData ()
 

Public Attributes

std::vector< unsigned char > data
 
unsigned int numTotalBytes
 
int objectID
 
int objectSubID
 
int statusFlag
 
bool toggleBit
 

Detailed Description

This class is used to collect data that is uploaded to the master in an segmented SDO transfer. Additionally, it includes some administrative functions for this proccess. It can be seen as a SDO segmented collector.

Definition at line 27 of file SDOSegmented.h.

Member Enumeration Documentation

States, that are used to describe the current state of the transmission process of the collected segmented SDO transfer.

Enumerator
SDO_SEG_FREE 

SDO collector is ready for a new transmission

SDO_SEG_WAITING 

SDO collector is waiting for the first bytes to receive

SDO_SEG_COLLECTING 

SDO collector is currently collecting data in a segmented SDO transfer

SDO_SEG_PROCESSING 

collection of data is finished but still has to be processed

Definition at line 34 of file SDOSegmented.h.

Constructor & Destructor Documentation

segData::segData ( )
inline

Definition at line 41 of file SDOSegmented.h.

segData::~segData ( )
inline

Definition at line 48 of file SDOSegmented.h.

Member Function Documentation

void segData::resetTransferData ( )
inline

Clear the SDO segmented collector

Definition at line 53 of file SDOSegmented.h.

Member Data Documentation

std::vector<unsigned char> segData::data

This vector holds the received data byte-wise

Definition at line 96 of file SDOSegmented.h.

unsigned int segData::numTotalBytes

Contains the total number of bytes to be uploaded (if specified by SDO sehmented header)

Definition at line 91 of file SDOSegmented.h.

int segData::objectID

Holds the ID of the currently uploading object

Definition at line 76 of file SDOSegmented.h.

int segData::objectSubID

Holds the Sub-ID of the currently uploading object

Definition at line 81 of file SDOSegmented.h.

int segData::statusFlag

combines different status flags and represents the workflow from 3 to 0: 3: SDORequest sent, waiting for transmission !If you are expecting a Segmented answer, this must be set during the request! 2: SDO process initiated, collecting data 1: finished transmission, waiting for data processing 0: SDO workflow finished, free for new transmission

Definition at line 71 of file SDOSegmented.h.

bool segData::toggleBit

The toggle bit, that has to be alternated in each confirmation response to a received segment.

Definition at line 86 of file SDOSegmented.h.


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


cob_canopen_motor
Author(s): Christian Connette
autogenerated on Wed Apr 7 2021 02:11:53