Electronics and Software
Engineering Innovation
BMeasure-lib  1.0.0
Public Member Functions | List of all members
BMeasureApi::BMeasure Class Reference

#include <BMeasureB.h>

Inheritance diagram for BMeasureApi::BMeasure:
BoapMc1Comms BMeasureApi::BMeasureUnit BMeasureApi::BMeasureUnit1

Public Member Functions

 BMeasure (Bool threaded=0, BUInt reqSize=512)
 
BError getNodeInfo (NodeInfo &nodeInfo)
 Get node information. More...
 
BError login (const BString &userid, const BString &password)
 Provides user/password information for secure connection. More...
 
BError logout ()
 Logs out. More...
 
BError changePassword (const BString &userid, const BString &oldPassword, const BString &newPassword)
 Changes the users password. More...
 
void factoryReset (const Bool &bootLoader, const Bool &resetConfig)
 Factory reset. More...
 
void sendTime (const BTimeUs &time)
 Sends the current time. More...
 
BError setMode (const Mode &mode)
 Set the current operational mode. More...
 
BError getStatus (NodeStatus &nodeStatus)
 Get the node status. More...
 
void sendStatus (const NodeStatus &nodeStatus)
 Sends the current status. More...
 
BError getInformation (Information &info)
 
BError getInfoBlock (InfoBlock &infoBlock)
 
BError getChannelConfig (const BUInt32 &channelNumber, ChannelConfig &channelConfig)
 
BError setChannelConfig (const BUInt32 &channelNumber, const ChannelConfig &channelConfig)
 
BError setChannelConfigFull (const BUInt64 &key, const BUInt32 &channelNumber, const ChannelConfig &channelConfig)
 
BError getConfig (Configuration &config)
 Return units configuration. More...
 
BError setConfig (const Configuration &config)
 Set units configuration. More...
 
BError getMeasurementConfig (const Bool &saved, MeasurementConfig &measurementConfig)
 Get measurement config. More...
 
BError setMeasurementConfig (const Bool &save, const MeasurementConfig &measurementConfig)
 Set measurement config. More...
 
BError sendDataEnable (const BUInt8 &sendSet)
 Enable the sending of different data streams. More...
 
BError measure (const DataType &dataType, DataBlock &dataBlock)
 Performs a single sample measurement. More...
 
void sendInfo (const InfoBlock &infoBlock)
 Sends an info block. More...
 
void sendData (const DataBlock &dataBlock)
 Sends a data block. More...
 
void sendChannelConfig (const ChannelConfig &channelConfig)
 Sends a ChannelConfig block. More...
 
BError getAwgConfig (const Bool &saved, AwgConfig &awgConfig)
 Get AWG Configuration. More...
 
BError setAwgConfig (const Bool &save, const AwgConfig &awgConfig)
 Configure AWG. More...
 
BError setAwgWaveform (const BUInt32 &chan, const BUInt32 &pos, const FileData &dataBlock)
 Configure AWG Arbitrary waveform. More...
 
BError setAnalogueOut (const BUInt32 &chan, const BFloat32 &value)
 Set analogue output value. More...
 
BError setDigital (const BUInt32 &bits)
 Set digital bits. More...
 
BError getDigital (BUInt32 &bits)
 Get digital bits. More...
 
BError setRelay (const BUInt32 &relayNum, const Bool &state)
 Set relay. More...
 
BError getSwitch (const BUInt32 &switchNum, Bool &state)
 Get digital bits. More...
 
BError alarmsClear (const BUInt32 &bits)
 Clear alarms. More...
 
BError filesysInfo (const BString &path, FilesysInfo &filesysInfo)
 
BError filesysDelete (const BString &path, const FilesysDeleteType &deleteType)
 
BError fileList (const BString &path, const BUInt32 &pos, FileInfo &fileInfo)
 
BError fileOpen (const BString &name, const BString &mode, BUInt32 &handle)
 
BError fileRead (const BUInt32 &handle, const BUInt32 &pos, const BUInt32 &len, FileData &data)
 
BError fileWrite (const BUInt32 &handle, const BUInt32 &pos, const FileData &data)
 
BError fileClose (const BUInt32 &handle)
 
BError fileDelete (const BString &name)
 
BError functionUnLock (const BUInt32 &unlocks, const BString &key)
 UnLock/Lock special functions. More...
 
BError getBoardConfig (BoardConfig &config)
 Get the boards configuration. More...
 
BError setBoardConfig (const BoardConfig &config)
 Sets the boards configuration, requires key. More...
 
BError runBoardTest (const BString &test)
 Runs the given board test. More...
 
BError calibrate (const CalibrateInfo &calibInfo)
 Calibrate system. More...
 
void sendMessage (const BUInt32 &source, const BString &message)
 Send text messages. More...
 
BError processRequest ()
 
virtual BError getNodeInfoServe (NodeInfo &nodeInfo)
 
virtual BError loginServe (const BString &userid, const BString &password)
 
virtual BError logoutServe ()
 
virtual BError changePasswordServe (const BString &userid, const BString &oldPassword, const BString &newPassword)
 
virtual void factoryResetServe (const Bool &bootLoader, const Bool &resetConfig)
 
virtual void sendTimeServe (const BTimeUs &time)
 
virtual BError setModeServe (const Mode &mode)
 
virtual BError getStatusServe (NodeStatus &nodeStatus)
 
virtual void sendStatusServe (const NodeStatus &nodeStatus)
 
virtual BError getInformationServe (Information &info)
 
virtual BError getInfoBlockServe (InfoBlock &infoBlock)
 
virtual BError getChannelConfigServe (const BUInt32 &channelNumber, ChannelConfig &channelConfig)
 
virtual BError setChannelConfigServe (const BUInt32 &channelNumber, const ChannelConfig &channelConfig)
 
virtual BError setChannelConfigFullServe (const BUInt64 &key, const BUInt32 &channelNumber, const ChannelConfig &channelConfig)
 
virtual BError getConfigServe (Configuration &config)
 
virtual BError setConfigServe (const Configuration &config)
 
virtual BError getMeasurementConfigServe (const Bool &saved, MeasurementConfig &measurementConfig)
 
virtual BError setMeasurementConfigServe (const Bool &save, const MeasurementConfig &measurementConfig)
 
virtual BError sendDataEnableServe (const BUInt8 &sendSet)
 
virtual BError measureServe (const DataType &dataType, DataBlock &dataBlock)
 
virtual void sendInfoServe (const InfoBlock &infoBlock)
 
virtual void sendDataServe (const DataBlock &dataBlock)
 
virtual void sendChannelConfigServe (const ChannelConfig &channelConfig)
 
virtual BError getAwgConfigServe (const Bool &saved, AwgConfig &awgConfig)
 
virtual BError setAwgConfigServe (const Bool &save, const AwgConfig &awgConfig)
 
virtual BError setAwgWaveformServe (const BUInt32 &chan, const BUInt32 &pos, const FileData &dataBlock)
 
virtual BError setAnalogueOutServe (const BUInt32 &chan, const BFloat32 &value)
 
virtual BError setDigitalServe (const BUInt32 &bits)
 
virtual BError getDigitalServe (BUInt32 &bits)
 
virtual BError setRelayServe (const BUInt32 &relayNum, const Bool &state)
 
virtual BError getSwitchServe (const BUInt32 &switchNum, Bool &state)
 
virtual BError alarmsClearServe (const BUInt32 &bits)
 
virtual BError filesysInfoServe (const BString &path, FilesysInfo &filesysInfo)
 
virtual BError filesysDeleteServe (const BString &path, const FilesysDeleteType &deleteType)
 
virtual BError fileListServe (const BString &path, const BUInt32 &pos, FileInfo &fileInfo)
 
virtual BError fileOpenServe (const BString &name, const BString &mode, BUInt32 &handle)
 
virtual BError fileReadServe (const BUInt32 &handle, const BUInt32 &pos, const BUInt32 &len, FileData &data)
 
virtual BError fileWriteServe (const BUInt32 &handle, const BUInt32 &pos, const FileData &data)
 
virtual BError fileCloseServe (const BUInt32 &handle)
 
virtual BError fileDeleteServe (const BString &name)
 
virtual BError functionUnLockServe (const BUInt32 &unlocks, const BString &key)
 
virtual BError getBoardConfigServe (BoardConfig &config)
 
virtual BError setBoardConfigServe (const BoardConfig &config)
 
virtual BError runBoardTestServe (const BString &test)
 
virtual BError calibrateServe (const CalibrateInfo &calibInfo)
 
virtual void sendMessageServe (const BUInt32 &source, const BString &message)
 
- Public Member Functions inherited from BoapMc1Comms
 BoapMc1Comms (Bool threaded=0, BUInt reqSize=512)
 
virtual ~BoapMc1Comms ()
 
void setCommsMode (Bool halfDuplex)
 
void setComms (BComms &comms)
 
void setComms (BComms *comms)
 
void setAddress (BUInt16 addressTo, BUInt16 addressFrom)
 
BUInt32 getApiVersion ()
 
BUInt32 setTimeout (BUInt32 timeoutUs)
 
BoapMc1Packet * packetRx ()
 
virtual BError processRx (BTimeout timeoutUs=BTimeoutForever)
 

Additional Inherited Members

- Protected Member Functions inherited from BoapMc1Comms
virtual BError processRequests (BTimeout timeoutUs=BTimeoutForever)
 
virtual BError processRequest (BTimeout timeoutUs=BTimeoutForever)
 
BError packetTx (BDataChunk *chunks, BUInt nChunks, BUInt16 waitCmdReply)
 
BError packetRxData (void *data, BUInt nBytes)
 
BError packetRxEnd ()
 
- Protected Attributes inherited from BoapMc1Comms
Bool othreaded
 
BUInt32 oreqSize
 
BMutex olockCall
 
BMutex olockTx
 
BComms * ocomms
 
BUInt32 oapiVersion
 
Bool ohalfDuplex
 
BUInt32 otimeout
 
BUInt16 oaddressTo
 
BUInt16 oaddressFrom
 
BoapMc1Packet opacketRxBase
 
BoapMc1Packet * opacketRx
 
BoapMc1Packet opacketTxBase
 
BoapMc1Packet * opacketTx
 
BUInt opacketRpcCmd
 
BSemaphore opacketRpcSema
 
BSemaphore opacketRpcDoneSema
 
BoapMc1Error oerror
 

Constructor & Destructor Documentation

◆ BMeasure()

BMeasureApi::BMeasure::BMeasure ( Bool  threaded = 0,
BUInt  reqSize = 512 
)

Member Function Documentation

◆ alarmsClear()

BError BMeasureApi::BMeasure::alarmsClear ( const BUInt32 &  bits)

Clear alarms.

◆ alarmsClearServe()

BError BMeasureApi::BMeasure::alarmsClearServe ( const BUInt32 &  bits)
virtual

◆ calibrate()

BError BMeasureApi::BMeasure::calibrate ( const CalibrateInfo &  calibInfo)

Calibrate system.

◆ calibrateServe()

BError BMeasureApi::BMeasure::calibrateServe ( const CalibrateInfo &  calibInfo)
virtual

◆ changePassword()

BError BMeasureApi::BMeasure::changePassword ( const BString &  userid,
const BString &  oldPassword,
const BString &  newPassword 
)

Changes the users password.

◆ changePasswordServe()

BError BMeasureApi::BMeasure::changePasswordServe ( const BString &  userid,
const BString &  oldPassword,
const BString &  newPassword 
)
virtual

◆ factoryReset()

void BMeasureApi::BMeasure::factoryReset ( const Bool &  bootLoader,
const Bool &  resetConfig 
)

Factory reset.

◆ factoryResetServe()

void BMeasureApi::BMeasure::factoryResetServe ( const Bool &  bootLoader,
const Bool &  resetConfig 
)
virtual

◆ fileClose()

BError BMeasureApi::BMeasure::fileClose ( const BUInt32 &  handle)

◆ fileCloseServe()

BError BMeasureApi::BMeasure::fileCloseServe ( const BUInt32 &  handle)
virtual

◆ fileDelete()

BError BMeasureApi::BMeasure::fileDelete ( const BString &  name)

◆ fileDeleteServe()

BError BMeasureApi::BMeasure::fileDeleteServe ( const BString &  name)
virtual

◆ fileList()

BError BMeasureApi::BMeasure::fileList ( const BString &  path,
const BUInt32 &  pos,
FileInfo &  fileInfo 
)

◆ fileListServe()

BError BMeasureApi::BMeasure::fileListServe ( const BString &  path,
const BUInt32 &  pos,
FileInfo &  fileInfo 
)
virtual

◆ fileOpen()

BError BMeasureApi::BMeasure::fileOpen ( const BString &  name,
const BString &  mode,
BUInt32 &  handle 
)

◆ fileOpenServe()

BError BMeasureApi::BMeasure::fileOpenServe ( const BString &  name,
const BString &  mode,
BUInt32 &  handle 
)
virtual

◆ fileRead()

BError BMeasureApi::BMeasure::fileRead ( const BUInt32 &  handle,
const BUInt32 &  pos,
const BUInt32 &  len,
FileData &  data 
)

◆ fileReadServe()

BError BMeasureApi::BMeasure::fileReadServe ( const BUInt32 &  handle,
const BUInt32 &  pos,
const BUInt32 &  len,
FileData &  data 
)
virtual

◆ filesysDelete()

BError BMeasureApi::BMeasure::filesysDelete ( const BString &  path,
const FilesysDeleteType &  deleteType 
)

◆ filesysDeleteServe()

BError BMeasureApi::BMeasure::filesysDeleteServe ( const BString &  path,
const FilesysDeleteType &  deleteType 
)
virtual

◆ filesysInfo()

BError BMeasureApi::BMeasure::filesysInfo ( const BString &  path,
FilesysInfo &  filesysInfo 
)

◆ filesysInfoServe()

BError BMeasureApi::BMeasure::filesysInfoServe ( const BString &  path,
FilesysInfo &  filesysInfo 
)
virtual

◆ fileWrite()

BError BMeasureApi::BMeasure::fileWrite ( const BUInt32 &  handle,
const BUInt32 &  pos,
const FileData &  data 
)

◆ fileWriteServe()

BError BMeasureApi::BMeasure::fileWriteServe ( const BUInt32 &  handle,
const BUInt32 &  pos,
const FileData &  data 
)
virtual

◆ functionUnLock()

BError BMeasureApi::BMeasure::functionUnLock ( const BUInt32 &  unlocks,
const BString &  key 
)

UnLock/Lock special functions.

◆ functionUnLockServe()

BError BMeasureApi::BMeasure::functionUnLockServe ( const BUInt32 &  unlocks,
const BString &  key 
)
virtual

◆ getAwgConfig()

BError BMeasureApi::BMeasure::getAwgConfig ( const Bool &  saved,
AwgConfig &  awgConfig 
)

Get AWG Configuration.

◆ getAwgConfigServe()

BError BMeasureApi::BMeasure::getAwgConfigServe ( const Bool &  saved,
AwgConfig &  awgConfig 
)
virtual

◆ getBoardConfig()

BError BMeasureApi::BMeasure::getBoardConfig ( BoardConfig &  config)

Get the boards configuration.

◆ getBoardConfigServe()

BError BMeasureApi::BMeasure::getBoardConfigServe ( BoardConfig &  config)
virtual

◆ getChannelConfig()

BError BMeasureApi::BMeasure::getChannelConfig ( const BUInt32 &  channelNumber,
ChannelConfig &  channelConfig 
)

◆ getChannelConfigServe()

BError BMeasureApi::BMeasure::getChannelConfigServe ( const BUInt32 &  channelNumber,
ChannelConfig &  channelConfig 
)
virtual

◆ getConfig()

BError BMeasureApi::BMeasure::getConfig ( Configuration &  config)

Return units configuration.

◆ getConfigServe()

BError BMeasureApi::BMeasure::getConfigServe ( Configuration &  config)
virtual

◆ getDigital()

BError BMeasureApi::BMeasure::getDigital ( BUInt32 &  bits)

Get digital bits.

◆ getDigitalServe()

BError BMeasureApi::BMeasure::getDigitalServe ( BUInt32 &  bits)
virtual

◆ getInfoBlock()

BError BMeasureApi::BMeasure::getInfoBlock ( InfoBlock &  infoBlock)

◆ getInfoBlockServe()

BError BMeasureApi::BMeasure::getInfoBlockServe ( InfoBlock &  infoBlock)
virtual

◆ getInformation()

BError BMeasureApi::BMeasure::getInformation ( Information &  info)

◆ getInformationServe()

BError BMeasureApi::BMeasure::getInformationServe ( Information &  info)
virtual

◆ getMeasurementConfig()

BError BMeasureApi::BMeasure::getMeasurementConfig ( const Bool &  saved,
MeasurementConfig &  measurementConfig 
)

Get measurement config.

◆ getMeasurementConfigServe()

BError BMeasureApi::BMeasure::getMeasurementConfigServe ( const Bool &  saved,
MeasurementConfig &  measurementConfig 
)
virtual

◆ getNodeInfo()

BError BMeasureApi::BMeasure::getNodeInfo ( NodeInfo &  nodeInfo)

Get node information.

◆ getNodeInfoServe()

BError BMeasureApi::BMeasure::getNodeInfoServe ( NodeInfo &  nodeInfo)
virtual

◆ getStatus()

BError BMeasureApi::BMeasure::getStatus ( NodeStatus &  nodeStatus)

Get the node status.

◆ getStatusServe()

BError BMeasureApi::BMeasure::getStatusServe ( NodeStatus &  nodeStatus)
virtual

◆ getSwitch()

BError BMeasureApi::BMeasure::getSwitch ( const BUInt32 &  switchNum,
Bool &  state 
)

Get digital bits.

◆ getSwitchServe()

BError BMeasureApi::BMeasure::getSwitchServe ( const BUInt32 &  switchNum,
Bool &  state 
)
virtual

◆ login()

BError BMeasureApi::BMeasure::login ( const BString &  userid,
const BString &  password 
)

Provides user/password information for secure connection.

◆ loginServe()

BError BMeasureApi::BMeasure::loginServe ( const BString &  userid,
const BString &  password 
)
virtual

◆ logout()

BError BMeasureApi::BMeasure::logout ( )

Logs out.

◆ logoutServe()

BError BMeasureApi::BMeasure::logoutServe ( )
virtual

◆ measure()

BError BMeasureApi::BMeasure::measure ( const DataType &  dataType,
DataBlock &  dataBlock 
)

Performs a single sample measurement.

◆ measureServe()

BError BMeasureApi::BMeasure::measureServe ( const DataType &  dataType,
DataBlock &  dataBlock 
)
virtual

◆ processRequest()

BError BMeasureApi::BMeasure::processRequest ( )

◆ runBoardTest()

BError BMeasureApi::BMeasure::runBoardTest ( const BString &  test)

Runs the given board test.

◆ runBoardTestServe()

BError BMeasureApi::BMeasure::runBoardTestServe ( const BString &  test)
virtual

◆ sendChannelConfig()

void BMeasureApi::BMeasure::sendChannelConfig ( const ChannelConfig &  channelConfig)

Sends a ChannelConfig block.

◆ sendChannelConfigServe()

void BMeasureApi::BMeasure::sendChannelConfigServe ( const ChannelConfig &  channelConfig)
virtual

◆ sendData()

void BMeasureApi::BMeasure::sendData ( const DataBlock &  dataBlock)

Sends a data block.

◆ sendDataEnable()

BError BMeasureApi::BMeasure::sendDataEnable ( const BUInt8 &  sendSet)

Enable the sending of different data streams.

◆ sendDataEnableServe()

BError BMeasureApi::BMeasure::sendDataEnableServe ( const BUInt8 &  sendSet)
virtual

◆ sendDataServe()

void BMeasureApi::BMeasure::sendDataServe ( const DataBlock &  dataBlock)
virtual

Reimplemented in BMeasureApi::BMeasureUnit.

◆ sendInfo()

void BMeasureApi::BMeasure::sendInfo ( const InfoBlock &  infoBlock)

Sends an info block.

◆ sendInfoServe()

void BMeasureApi::BMeasure::sendInfoServe ( const InfoBlock &  infoBlock)
virtual

◆ sendMessage()

void BMeasureApi::BMeasure::sendMessage ( const BUInt32 &  source,
const BString &  message 
)

Send text messages.

◆ sendMessageServe()

void BMeasureApi::BMeasure::sendMessageServe ( const BUInt32 &  source,
const BString &  message 
)
virtual

Reimplemented in BMeasureApi::BMeasureUnit1.

◆ sendStatus()

void BMeasureApi::BMeasure::sendStatus ( const NodeStatus &  nodeStatus)

Sends the current status.

◆ sendStatusServe()

void BMeasureApi::BMeasure::sendStatusServe ( const NodeStatus &  nodeStatus)
virtual

◆ sendTime()

void BMeasureApi::BMeasure::sendTime ( const BTimeUs &  time)

Sends the current time.

◆ sendTimeServe()

void BMeasureApi::BMeasure::sendTimeServe ( const BTimeUs &  time)
virtual

◆ setAnalogueOut()

BError BMeasureApi::BMeasure::setAnalogueOut ( const BUInt32 &  chan,
const BFloat32 &  value 
)

Set analogue output value.

◆ setAnalogueOutServe()

BError BMeasureApi::BMeasure::setAnalogueOutServe ( const BUInt32 &  chan,
const BFloat32 &  value 
)
virtual

◆ setAwgConfig()

BError BMeasureApi::BMeasure::setAwgConfig ( const Bool &  save,
const AwgConfig &  awgConfig 
)

Configure AWG.

◆ setAwgConfigServe()

BError BMeasureApi::BMeasure::setAwgConfigServe ( const Bool &  save,
const AwgConfig &  awgConfig 
)
virtual

◆ setAwgWaveform()

BError BMeasureApi::BMeasure::setAwgWaveform ( const BUInt32 &  chan,
const BUInt32 &  pos,
const FileData &  dataBlock 
)

Configure AWG Arbitrary waveform.

◆ setAwgWaveformServe()

BError BMeasureApi::BMeasure::setAwgWaveformServe ( const BUInt32 &  chan,
const BUInt32 &  pos,
const FileData &  dataBlock 
)
virtual

◆ setBoardConfig()

BError BMeasureApi::BMeasure::setBoardConfig ( const BoardConfig &  config)

Sets the boards configuration, requires key.

◆ setBoardConfigServe()

BError BMeasureApi::BMeasure::setBoardConfigServe ( const BoardConfig &  config)
virtual

◆ setChannelConfig()

BError BMeasureApi::BMeasure::setChannelConfig ( const BUInt32 &  channelNumber,
const ChannelConfig &  channelConfig 
)

◆ setChannelConfigFull()

BError BMeasureApi::BMeasure::setChannelConfigFull ( const BUInt64 &  key,
const BUInt32 &  channelNumber,
const ChannelConfig &  channelConfig 
)

◆ setChannelConfigFullServe()

BError BMeasureApi::BMeasure::setChannelConfigFullServe ( const BUInt64 &  key,
const BUInt32 &  channelNumber,
const ChannelConfig &  channelConfig 
)
virtual

◆ setChannelConfigServe()

BError BMeasureApi::BMeasure::setChannelConfigServe ( const BUInt32 &  channelNumber,
const ChannelConfig &  channelConfig 
)
virtual

◆ setConfig()

BError BMeasureApi::BMeasure::setConfig ( const Configuration &  config)

Set units configuration.

◆ setConfigServe()

BError BMeasureApi::BMeasure::setConfigServe ( const Configuration &  config)
virtual

◆ setDigital()

BError BMeasureApi::BMeasure::setDigital ( const BUInt32 &  bits)

Set digital bits.

◆ setDigitalServe()

BError BMeasureApi::BMeasure::setDigitalServe ( const BUInt32 &  bits)
virtual

◆ setMeasurementConfig()

BError BMeasureApi::BMeasure::setMeasurementConfig ( const Bool &  save,
const MeasurementConfig &  measurementConfig 
)

Set measurement config.

◆ setMeasurementConfigServe()

BError BMeasureApi::BMeasure::setMeasurementConfigServe ( const Bool &  save,
const MeasurementConfig &  measurementConfig 
)
virtual

◆ setMode()

BError BMeasureApi::BMeasure::setMode ( const Mode &  mode)

Set the current operational mode.

◆ setModeServe()

BError BMeasureApi::BMeasure::setModeServe ( const Mode &  mode)
virtual

◆ setRelay()

BError BMeasureApi::BMeasure::setRelay ( const BUInt32 &  relayNum,
const Bool &  state 
)

Set relay.

◆ setRelayServe()

BError BMeasureApi::BMeasure::setRelayServe ( const BUInt32 &  relayNum,
const Bool &  state 
)
virtual
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.15