Robox Library for Cpp: BCC/31 module 1.0.0
RLibCpp BCC/31 protocol implementation
Classes | Public Types | Public Member Functions | List of all members
CanNmtReadItem Class Reference

The data for a CANopen NMT item. More...

#include <client.h>

Classes

class  Vector
 Class to handle with lists of CanNmtReadItem. More...
 

Public Types

enum  StatusCodes { scStop = 4 , scOperational = 5 , scPreoperational = 127 }
 Status codes. More...
 
enum  StatusFlagss {
  flagWsNotPresent = 0x01 , flagWsNotPhysicallyPresent = 0x02 , flagLastRTRFailed = 0x04 , flagWsForcedPresence = 0x08 ,
  flagConfigurationInProgress = 0x10 , flagConfigurationAborted = 0x20 , flagShorterPDO = 0x80
}
 Status flags. More...
 

Public Member Functions

uint16_t wsID () const
 Get the workstation ID.
 
void setWsID (uint16_t value)
 Set the workstation ID.
 
StatusCodes statusCode () const
 Get the status code.
 
void setStatusCode (StatusCodes value)
 Set the status code.
 
StatusFlagss statusFlags () const
 Get the status flags.
 
void setStatusFlags (StatusFlagss value)
 Set the status flags.
 

Detailed Description

The data for a CANopen NMT item.

Member Enumeration Documentation

◆ StatusCodes

Status codes.

Enumerator
scStop 

Stop.

scOperational 

Operational.

scPreoperational 

Preoperational.

◆ StatusFlagss

Status flags.

Enumerator
flagWsNotPresent 

Not present ws.

flagWsNotPhysicallyPresent 

Not physically present ws(even if forced presence)

flagLastRTRFailed 

Last RTR for APDO failed.

flagWsForcedPresence 

Ws forced presence.

flagConfigurationInProgress 

Configuration in progress.

flagConfigurationAborted 

Configuration aborted.

flagShorterPDO 

Ws sent PDO shorter than programmed.

Member Function Documentation

◆ setStatusCode()

void setStatusCode ( StatusCodes value)

Set the status code.

Parameters
valueThe value to set

◆ setStatusFlags()

void setStatusFlags ( StatusFlagss value)

Set the status flags.

Parameters
valueThe value to set

◆ setWsID()

void setWsID ( uint16_t value)

Set the workstation ID.

Parameters
valueThe value to set

◆ statusCode()

StatusCodes statusCode ( ) const

Get the status code.

Returns
The parameter value

◆ statusFlags()

StatusFlagss statusFlags ( ) const

Get the status flags.

Returns
The parameter value

◆ wsID()

ushort wsID ( ) const

Get the workstation ID.

Returns
The parameter value