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

The data for the SystemInfo More...

#include <client.h>

Inheritance diagram for SystemInfoData:
OperationData ErrorData

Public Types

enum  ManufactureTypes {
  manufGeneric = RVar::DevInfo::manufGeneric , manufRoboxStd = RVar::DevInfo::manufRoboxStd , manufRoboxCustom = RVar::DevInfo::manufRoboxCustom , manufMotorola = RVar::DevInfo::manufMotorola ,
  manufParker = RVar::DevInfo::manufParker
}
 Devices' mmanufactures. More...
 
enum  ModelTypes {
  mGeneric = RVar::DevInfo::mGeneric , mVirtual = RVar::DevInfo::mVirtual , mRoboxRbxm = RVar::DevInfo::mRoboxRbxm , mRoboxRbxe = RVar::DevInfo::mRoboxRbxe ,
  mRoboxRpm = RVar::DevInfo::mRoboxRpm , mRoboxURbx = RVar::DevInfo::mRoboxURbx , mRoboxCanSin = RVar::DevInfo::mRoboxCanSin , mRoboxRbxmG2 = RVar::DevInfo::mRoboxRbxmG2 ,
  mRoboxPpcHiDrive = RVar::DevInfo::mRoboxPpcHiDrive , mRoboxNiosEthercat = RVar::DevInfo::mRoboxNiosEthercat , mRoboxURmc = RVar::DevInfo::mRoboxURmc , mRoboxImd20 = RVar::DevInfo::mRoboxImd20 ,
  mRoboxCanSinRte = RVar::DevInfo::mRoboxCanSinRte , mRoboxRmcG2 = RVar::DevInfo::mRoboxRmcG2 , mRoboxRbxmP2020 = RVar::DevInfo::mRoboxRbxmP2020 , mRoboxURmc2 = RVar::DevInfo::mRoboxURmc2 ,
  mRoboxURmc3 = RVar::DevInfo::mRoboxURmc3 , mRoboxImd30 = RVar::DevInfo::mRoboxImd30 , mRoboxURio = RVar::DevInfo::mRoboxURio , mParkerGeneric = RVar::DevInfo::mParkerGeneric ,
  mRoboxEthIpPnetBoard = RVar::DevInfo::mRoboxEthIpPnetBoard , mRoboxRP1 = RVar::DevInfo::mRoboxRP1 , mRoboxRP2 = RVar::DevInfo::mRoboxRP2
}
 Devices' models. More...
 
enum  OsTypes {
  osGeneric = RVar::DevInfo::osGeneric , osOSF16 = RVar::DevInfo::osOSF16 , osOSF16Integrated = RVar::DevInfo::osOSF16Integrated , osOSF32 = RVar::DevInfo::osOSF32 ,
  osOSF32Integrated = RVar::DevInfo::osOSF32Integrated , osDeviceDsp56 = RVar::DevInfo::osDeviceDsp56 , osDeviceCansin = RVar::DevInfo::osDeviceCansin , osEprom = RVar::DevInfo::osEprom ,
  osDeviceNiosEthercat = RVar::DevInfo::osDeviceNiosEthercat , osDeviceImd = RVar::DevInfo::osDeviceImd , osDeviceParkerGeneric = RVar::DevInfo::osDeviceParkerGeneric , osBoardEthIpPNet_EthIp = RVar::DevInfo::osBoardEthIpPNet_EthIp ,
  osBoardEthIpPNet_PNet = RVar::DevInfo::osBoardEthIpPNet_PNet
}
 Operating system types. More...
 
enum  FirmwareTypes {
  firmwGeneric = RVar::DevInfo::firmwGeneric , firmwRrt16 = RVar::DevInfo::firmwRrt16 , firmwRrt16Integrated = RVar::DevInfo::firmwRrt16Integrated , firmwRhll16 = RVar::DevInfo::firmwRhll16 ,
  firmwRhll16Integrated = RVar::DevInfo::firmwRhll16Integrated , firmwRhll32 = RVar::DevInfo::firmwRhll32 , firmwDevSpecific = RVar::DevInfo::firmwDevSpecific , firmwRrt32 = RVar::DevInfo::firmwRrt32 ,
  firmwRte = RVar::DevInfo::firmwRte
}
 Firmware types. More...
 
enum  TaskBinTypes { tbNone = 0 , tbClassic = 1 , tbPlusPlus16 = 2 , tbPlusPlus32 = 3 }
 Types of TaskBin. More...
 
enum  DevAttribFlags { devAttrHasRemVars = RVar::DevInfo::devAttrHasRemVars , devAttrHasX86Vars = RVar::DevInfo::devAttrHasX86Vars , devAttrBccTranslation = RVar::DevInfo::devAttrBccTranslation }
 Device attributes flags. More...
 
enum  SysLibTypes { sLibGeneric = 0 , sLibRbxLib = 1 }
 System library types. More...
 
enum  BiosTypes { biosNone = 0 , biosRobox = 1 }
 Bios types. More...
 
enum  LanguageTypes {
  langNeutral = 0 , langGerman = 0x07 , langEnglish = 0x09 , langSpanish = 0x0a ,
  langFrench = 0x0c , langItalian = 0x10 , langPortuguese = 0x16 , langRussian = 0x19
}
 Language types. More...
 
enum  XplLanguages { xplLangNone = 0x00000000 , xplLangRpl = 0x00000001 , xplLangGcodeRs274 = 0x00000002 }
 Xpl languages. More...
 

Public Member Functions

 SystemInfoData ()
 Class constructor.
 
bool equals (const SystemInfoData &other)
 Check if this object equals the specifed one other
 
SystemInfoDataoperator= (const SystemInfoData &other)
 Copy this object from the specified one other
 
ManufactureTypes manufacturer () const
 Get the hardware constructor. [OUT].
 
void setManufacturer (ManufactureTypes value)
 Set the hardware constructor. [OUT].
 
ModelTypes model () const
 Get the hardware model. [OUT].
 
void setModel (ModelTypes value)
 Set the hardware model. [OUT].
 
OsTypes osType () const
 Get the operating system type. [OUT].
 
void setOsType (OsTypes value)
 Set the operating system type. [OUT].
 
uint32_t osVersion () const
 Get the operating system version (nvMake format). [OUT].
 
void setOsVersion (uint32_t value)
 Set the operating system version (nvMake format). [OUT].
 
FirmwareTypes firmwareType () const
 Get the firwmare type. [OUT].
 
void setFirmwareType (FirmwareTypes value)
 Set the firwmare type. [OUT].
 
uint32_t firmwareVersion () const
 Get the firwmare version (nvMake format) [OUT].
 
void setFirmwareVersion (uint32_t value)
 Set the firwmare version (nvMake format) [OUT].
 
uint32_t firmwareExtensions () const
 Get the firwmare extensions mask [OUT].
 
void setFirmwareExtensions (uint32_t value)
 Set the firwmare extensions mask [OUT].
 
RLibCpp::Tool::String userSoftwareName () const
 Get the user software name [OUT].
 
void setUserSoftwareName (RLibCpp::Tool::String value)
 Set the user software name [OUT].
 
uint32_t userSoftwareVersion () const
 Get the user software version (nvMake format) [OUT].
 
void setUserSoftwareVersion (uint32_t value)
 Set the user software version (nvMake format) [OUT].
 
DevAttribFlags attributes () const
 Get the attributes [OUT].
 
void setAttributes (DevAttribFlags value)
 Set the attributes [OUT].
 
TaskBinTypes taskbinType () const
 Get the taskbin framework type [OUT].
 
void setTaskbinType (TaskBinTypes value)
 Set the taskbin framework type [OUT].
 
uint32_t taskbinVersion () const
 Get the taskbin framework version (nvMake format) [OUT].
 
void setTaskbinVersion (uint32_t value)
 Set the taskbin framework version (nvMake format) [OUT].
 
uint32_t varSetID () const
 Get the current remote variables set identifier [OUT].
 
void setVarSetID (uint32_t value)
 Set the current remote variables set identifier [OUT].
 
SysLibTypes sysLibType () const
 Get the system library type [OUT].
 
void setSysLibType (SysLibTypes value)
 Set the system library type [OUT].
 
uint32_t sysLibVersion () const
 Get the system library version (nvMake format) [OUT].
 
void setSysLibVersion (uint32_t value)
 Set the system library version (nvMake format) [OUT].
 
BiosTypes biosType () const
 Get the BIOS type [OUT].
 
void setBiosType (BiosTypes value)
 Set the BIOS type [OUT].
 
uint32_t biosVersion () const
 Get the BIOS version (nvMake format [OUT].
 
void setBiosVersion (uint32_t value)
 Set the BIOS version (nvMake format) [OUT].
 
uint32_t rpeVersion () const
 Get the RPE extension version (nvMake format) [OUT].
 
void setRpeVersion (uint32_t value)
 Set the RPE extension version (nvMake format) [OUT].
 
LanguageTypes language () const
 Get the current language code [OUT].
 
void setLanguage (LanguageTypes value)
 Set the current language code [OUT].
 
uint32_t xplVersion () const
 Get the XPL extension version (nvMake format). [OUT].
 
void setXplVersion (uint32_t value)
 Set the XPL extension version (nvMake format). [OUT].
 
XplLanguages xplLangs () const
 Get the XPL enabled languages. [OUT].
 
void setXplLangs (XplLanguages value)
 Set the XPL enabled languages. [OUT].
 
uint16_t ibTx () const
 Get the interlock on transmit. [OUT].
 
void setIbTx (uint16_t value)
 Set the interlock on transmit. [OUT].
 
uint16_t ibRx () const
 Get the interlock on receive. [OUT].
 
void setIbRx (uint16_t value)
 Set the interlock on receive. [OUT].
 
- Public Member Functions inherited from OperationData
void setState (uint64_t senderId, ActivityStates state, uint64_t data=0)
 Set the activity state.
 
void setProgress (uint64_t senderId, int32_t min, int32_t max, int32_t cur)
 Set the activity progress.
 
- Public Member Functions inherited from ErrorData
 ErrorData ()
 Class contructor.
 
void setErrorFromMessage (Message *src)
 Set error information from a source message.
 
void clearError ()
 Clear the error information.
 
void setError (Message::ErrCodes errCode)
 Set the error information.
 
void setError (Message::ErrCodes errCode, uint16_t errExtra)
 Set the error information.
 
Message::ErrCodes nackErrCode () const
 Get the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.
 
uint16_t nackErrExtra () const
 Get the optional error extra data of the last NACK message received from the remote device.
 

Additional Inherited Members

- Public Attributes inherited from OperationData
Signal3< uint64_t, ActivityStates, uint64_t > stateChanged
 Signal emitted when the state of the operation changes.
 
Signal4< uint64_t, int32_t, int32_t, int32_t > progressChanged
 Signal emitted when the progress of the operation changes.
 
- Protected Member Functions inherited from ErrorData
void setNackErrCode (Message::ErrCodes value)
 Set the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.
 
void setNackErrExtra (uint16_t value)
 Set the optional error extra data of the last NACK message received from the remote device.
 
uint16_t nackErrFlags () const
 Get the error information validity flags.
 
void setNackErrFlags (uint16_t value)
 Set the error information validity flags.
 

Detailed Description

The data for the SystemInfo

For more information about these data and values look at the BCC / 31 Protocol Documentation, message bccSysInfo.

See also
Client.systemInfo(ClientStruct::SystemInfoData&)

Member Enumeration Documentation

◆ BiosTypes

enum BiosTypes

Bios types.

Enumerator
biosNone 

No Bios.

biosRobox 

Robox bios.

◆ DevAttribFlags

Device attributes flags.

Enumerator
devAttrHasRemVars 

Device supports remote variables.

devAttrHasX86Vars 

Device supports x86 variables.

devAttrBccTranslation 

Device supports BCC translations.

◆ FirmwareTypes

Firmware types.

Enumerator
firmwGeneric 

Generic firmware.

firmwRrt16 

Rrt 16.

firmwRrt16Integrated 

Rrt 16 integrated.

firmwRhll16 

Rhll 16.

firmwRhll16Integrated 

Rhll 16 integrated.

firmwRhll32 

Rhll 32.

firmwDevSpecific 

Device specific.

firmwRrt32 

Rrt 32.

firmwRte 

Rte.

◆ LanguageTypes

Language types.

Enumerator
langNeutral 

Neutral language.

langGerman 

German.

langEnglish 

English.

langSpanish 

Spanish.

langFrench 

French.

langItalian 

Italian.

langPortuguese 

Portuguese.

langRussian 

Russian.

◆ ManufactureTypes

Devices' mmanufactures.

Enumerator
manufGeneric 

Generic, no specific one.

manufRoboxStd 

Robox standard device.

manufRoboxCustom 

Robox custom device.

manufMotorola 

Motorola.

manufParker 

Parker.

◆ ModelTypes

enum ModelTypes

Devices' models.

Enumerator
mGeneric 

Generic model.

mVirtual 

Virtual device.

mRoboxRbxm 

Robox Rbxm.

mRoboxRbxe 

Robox Rbxe.

mRoboxRpm 

Robox Rpm.

mRoboxURbx 

Robox uRbx.

mRoboxCanSin 

Robox CanSin.

mRoboxRbxmG2 

Robox Rbxm G2.

mRoboxPpcHiDrive 

Robox PPC HiDrive.

mRoboxNiosEthercat 

Robox Nios Ethercat.

mRoboxURmc 

Robox uRmc.

mRoboxImd20 

Robox Imd20.

mRoboxCanSinRte 

Robox CanSin Rte.

mRoboxRmcG2 

Robox Rmc G2.

mRoboxRbxmP2020 

Robox Rbxm P2020.

mRoboxURmc2 

Robox uRmc 2.

mRoboxURmc3 

Robox uRmc 3.

mRoboxImd30 

Robox Imd 30.

mRoboxURio 

Robox uRio.

mParkerGeneric 

Parker.

mRoboxEthIpPnetBoard 

Modulo EthIP/PNet board.

mRoboxRP1 

Robox RP-1.

mRoboxRP2 

Robox RP-2.

◆ OsTypes

enum OsTypes

Operating system types.

Enumerator
osGeneric 

Generic.

osOSF16 

OSF 16.

osOSF16Integrated 

OSF 16 integrated.

osOSF32 

OSF 32.

osOSF32Integrated 

OSF 32 integrated.

osDeviceDsp56 

Dsp 56 device.

osDeviceCansin 

Can sin device.

osEprom 

Eprom.

osDeviceNiosEthercat 

Nios EtherCAT device.

osDeviceImd 

Imd device.

osDeviceParkerGeneric 

Parker generic device.

osBoardEthIpPNet_EthIp 

EthIP/PNET board - EthernetIP Interface.

osBoardEthIpPNet_PNet 

EthIP/PNET board - Profinet Interface.

◆ SysLibTypes

System library types.

Enumerator
sLibGeneric 

Generic system library.

sLibRbxLib 

Rbx system library.

◆ TaskBinTypes

Types of TaskBin.

Enumerator
tbNone 

None task bin.

tbClassic 

Classic task bin.

tbPlusPlus16 

++16 task bin

tbPlusPlus32 

++32 task bin

◆ XplLanguages

Xpl languages.

Enumerator
xplLangNone 

No languages.

xplLangRpl 

RPL Language.

xplLangGcodeRs274 

G-Code Rs274 Language.

Constructor & Destructor Documentation

◆ SystemInfoData()

Class constructor.

Member Function Documentation

◆ attributes()

DevAttribFlags attributes ( ) const

Get the attributes [OUT].

Returns
The parameter value

◆ biosType()

BiosTypes biosType ( ) const

Get the BIOS type [OUT].

Returns
The parameter value

◆ biosVersion()

uint32_t biosVersion ( ) const

Get the BIOS version (nvMake format [OUT].

Returns
The parameter value

◆ equals()

bool equals ( const SystemInfoData & other)

Check if this object equals the specifed one other

Parameters
otherThe object to be compared
Returns
True if the other content equals this object content

◆ firmwareExtensions()

uint32_t firmwareExtensions ( ) const

Get the firwmare extensions mask [OUT].

Returns
The parameter value

◆ firmwareType()

FirmwareTypes firmwareType ( ) const

Get the firwmare type. [OUT].

Returns
The parameter value

◆ firmwareVersion()

uint32_t firmwareVersion ( ) const

Get the firwmare version (nvMake format) [OUT].

Returns
The parameter value

◆ ibRx()

uint16_t ibRx ( ) const

Get the interlock on receive. [OUT].

Returns
The parameter value

◆ ibTx()

uint16_t ibTx ( ) const

Get the interlock on transmit. [OUT].

Returns
The parameter value

◆ language()

LanguageTypes language ( ) const

Get the current language code [OUT].

Returns
The parameter value

◆ manufacturer()

ManufactureTypes manufacturer ( ) const

Get the hardware constructor. [OUT].

Returns
The parameter value

◆ model()

ModelTypes model ( ) const

Get the hardware model. [OUT].

Returns
The parameter value

◆ operator=()

SystemInfoData & operator= ( const SystemInfoData & other)

Copy this object from the specified one other

Parameters
otherThe source object
Returns
A referece to this object

◆ osType()

OsTypes osType ( ) const

Get the operating system type. [OUT].

Returns
The parameter value

◆ osVersion()

uint32_t osVersion ( ) const

Get the operating system version (nvMake format). [OUT].

Returns
The parameter value

◆ rpeVersion()

uint32_t rpeVersion ( ) const

Get the RPE extension version (nvMake format) [OUT].

Returns
The parameter value

◆ setAttributes()

void setAttributes ( DevAttribFlags value)

Set the attributes [OUT].

Parameters
valueThe value to set

◆ setBiosType()

void setBiosType ( BiosTypes value)

Set the BIOS type [OUT].

Parameters
valueThe value to set

◆ setBiosVersion()

void setBiosVersion ( uint32_t value)

Set the BIOS version (nvMake format) [OUT].

Parameters
valueThe value to set

◆ setFirmwareExtensions()

void setFirmwareExtensions ( uint32_t value)

Set the firwmare extensions mask [OUT].

Parameters
valueThe value to set

◆ setFirmwareType()

void setFirmwareType ( FirmwareTypes value)

Set the firwmare type. [OUT].

Parameters
valueThe value to set

◆ setFirmwareVersion()

void setFirmwareVersion ( uint32_t value)

Set the firwmare version (nvMake format) [OUT].

Parameters
valueThe value to set

◆ setIbRx()

void setIbRx ( uint16_t value)

Set the interlock on receive. [OUT].

Parameters
valueThe value to set

◆ setIbTx()

void setIbTx ( uint16_t value)

Set the interlock on transmit. [OUT].

Parameters
valueThe value to set

◆ setLanguage()

void setLanguage ( LanguageTypes value)

Set the current language code [OUT].

Parameters
valueThe value to set

◆ setManufacturer()

void setManufacturer ( ManufactureTypes value)

Set the hardware constructor. [OUT].

Parameters
valueThe value to set

◆ setModel()

void setModel ( ModelTypes value)

Set the hardware model. [OUT].

Parameters
valueThe value to set

◆ setOsType()

void setOsType ( OsTypes value)

Set the operating system type. [OUT].

Parameters
valueThe value to set

◆ setOsVersion()

void setOsVersion ( uint32_t value)

Set the operating system version (nvMake format). [OUT].

Parameters
valueThe value to set

◆ setRpeVersion()

void setRpeVersion ( uint32_t value)

Set the RPE extension version (nvMake format) [OUT].

Parameters
valueThe value to set

◆ setSysLibType()

void setSysLibType ( SysLibTypes value)

Set the system library type [OUT].

Parameters
valueThe value to set

◆ setSysLibVersion()

void setSysLibVersion ( uint32_t value)

Set the system library version (nvMake format) [OUT].

Parameters
valueThe value to set

◆ setTaskbinType()

void setTaskbinType ( TaskBinTypes value)

Set the taskbin framework type [OUT].

Parameters
valueThe value to set

◆ setTaskbinVersion()

void setTaskbinVersion ( uint32_t value)

Set the taskbin framework version (nvMake format) [OUT].

Parameters
valueThe value to set

◆ setUserSoftwareName()

void setUserSoftwareName ( RLibCpp::Tool::String value)

Set the user software name [OUT].

Parameters
valueThe value to set

◆ setUserSoftwareVersion()

void setUserSoftwareVersion ( uint32_t value)

Set the user software version (nvMake format) [OUT].

Parameters
valueThe value to set

◆ setVarSetID()

void setVarSetID ( uint32_t value)

Set the current remote variables set identifier [OUT].

Parameters
valueThe value to set

◆ setXplLangs()

void setXplLangs ( XplLanguages value)

Set the XPL enabled languages. [OUT].

Parameters
valueThe value to set

◆ setXplVersion()

void setXplVersion ( uint32_t value)

Set the XPL extension version (nvMake format). [OUT].

Parameters
valueThe value to set

◆ sysLibType()

SysLibTypes sysLibType ( ) const

Get the system library type [OUT].

Returns
The parameter value

◆ sysLibVersion()

uint32_t sysLibVersion ( ) const

Get the system library version (nvMake format) [OUT].

Returns
The parameter value

◆ taskbinType()

TaskBinTypes taskbinType ( ) const

Get the taskbin framework type [OUT].

Returns
The parameter value

◆ taskbinVersion()

uint32_t taskbinVersion ( ) const

Get the taskbin framework version (nvMake format) [OUT].

Returns
The parameter value

◆ userSoftwareName()

String userSoftwareName ( ) const

Get the user software name [OUT].

Returns
The parameter value

◆ userSoftwareVersion()

uint32_t userSoftwareVersion ( ) const

Get the user software version (nvMake format) [OUT].

Returns
The parameter value

◆ varSetID()

uint32_t varSetID ( ) const

Get the current remote variables set identifier [OUT].

Returns
The parameter value

◆ xplLangs()

XplLanguages xplLangs ( ) const

Get the XPL enabled languages. [OUT].

Returns
The parameter value

◆ xplVersion()

uint32_t xplVersion ( ) const

Get the XPL extension version (nvMake format). [OUT].

Returns
The parameter value