Electronics and Software
Engineering Innovation
BMeasure-lib  0.8.4
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...
 
void factoryReset (const BInt32 &bootLoader, const BInt32 &resetConfig)
 Factory reset. More...
 
BError getStatus (NodeStatus &nodeStatus)
 Get the node status. More...
 
void sendStatus (const NodeStatus &nodeStatus)
 Sends the current status. More...
 
void sendTime (const BTimeUs &time)
 Sends the current time. More...
 
BError setMode (const Mode &mode)
 Set the current operational mode. More...
 
BError setSecureMode (const SecureMode &secureMode)
 Set the security mode. More...
 
BError setSecureKey (const BString &key)
 Set the security key. More...
 
BError login (const BString &user, const BString &password)
 Provides user/password information for secure connection. 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 (MeasurementConfig &measurementConfig)
 Get measurement config. More...
 
BError setMeasurementConfig (const MeasurementConfig &measurementConfig)
 Set measurement config. More...
 
BError getMeasurement (MeasurementConfig &measurementConfig)
 Get measurement config. More...
 
BError setMeasurement (const MeasurementConfig &measurementConfig)
 Set measurement config. More...
 
BError sendDataEnable (const DataSend &sendType)
 Enable the sending of data. More...
 
void sendInfo (const InfoBlock &infoBlock)
 Sends an info block. More...
 
void sendData (const DataBlock &dataBlock)
 Sends a data block. More...
 
BError measure (DataBlock &dataBlock)
 Performs a single measurement. More...
 
BError getAwgConfig (AwgConfig &awgConfig)
 Get AWG Configuration. More...
 
BError setAwgConfig (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 BInt32 &state)
 Set relay. More...
 
BError getSwitch (const BUInt32 &switchNum, BInt32 &state)
 Get digital bits. 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 (BTimeout timeoutUs=BTimeoutForever)
 
virtual BError getNodeInfoServe (NodeInfo &nodeInfo)
 
virtual void factoryResetServe (const BInt32 &bootLoader, const BInt32 &resetConfig)
 
virtual BError getStatusServe (NodeStatus &nodeStatus)
 
virtual void sendStatusServe (const NodeStatus &nodeStatus)
 
virtual void sendTimeServe (const BTimeUs &time)
 
virtual BError setModeServe (const Mode &mode)
 
virtual BError setSecureModeServe (const SecureMode &secureMode)
 
virtual BError setSecureKeyServe (const BString &key)
 
virtual BError loginServe (const BString &user, const BString &password)
 
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 (MeasurementConfig &measurementConfig)
 
virtual BError setMeasurementConfigServe (const MeasurementConfig &measurementConfig)
 
virtual BError getMeasurementServe (MeasurementConfig &measurementConfig)
 
virtual BError setMeasurementServe (const MeasurementConfig &measurementConfig)
 
virtual BError sendDataEnableServe (const DataSend &sendType)
 
virtual void sendInfoServe (const InfoBlock &infoBlock)
 
virtual void sendDataServe (const DataBlock &dataBlock)
 
virtual BError measureServe (DataBlock &dataBlock)
 
virtual BError getAwgConfigServe (AwgConfig &awgConfig)
 
virtual BError setAwgConfigServe (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 BInt32 &state)
 
virtual BError getSwitchServe (const BUInt32 &switchNum, BInt32 &state)
 
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)
 
BoapMc1PacketpacketRx ()
 
virtual BError processRx (BTimeout timeoutUs=BTimeoutForever)
 

Additional Inherited Members

- Protected Member Functions inherited from BoapMc1Comms
virtual BError processRequests (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
 
BCommsocomms
 
BUInt32 oapiVersion
 
Bool ohalfDuplex
 
BUInt32 otimeout
 
BUInt16 oaddressTo
 
BUInt16 oaddressFrom
 
BoapMc1Packet opacketRxBase
 
BoapMc1PacketopacketRx
 
BoapMc1Packet opacketTxBase
 
BoapMc1PacketopacketTx
 
BUInt opacketRpcCmd
 
BSemaphore opacketRpcSema
 
BSemaphore opacketRpcDoneSema
 
BoapMc1Error oerror
 

Constructor & Destructor Documentation

◆ BMeasure()

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

Member Function Documentation

◆ calibrate()

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

Calibrate system.

◆ calibrateServe()

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

◆ factoryReset()

void BMeasureApi::BMeasure::factoryReset ( const BInt32 bootLoader,
const BInt32 resetConfig 
)

Factory reset.

◆ factoryResetServe()

void BMeasureApi::BMeasure::factoryResetServe ( const BInt32 bootLoader,
const BInt32 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 ( AwgConfig awgConfig)

Get AWG Configuration.

◆ getAwgConfigServe()

BError BMeasureApi::BMeasure::getAwgConfigServe ( 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

◆ getMeasurement()

BError BMeasureApi::BMeasure::getMeasurement ( MeasurementConfig measurementConfig)

Get measurement config.

◆ getMeasurementConfig()

BError BMeasureApi::BMeasure::getMeasurementConfig ( MeasurementConfig measurementConfig)

Get measurement config.

◆ getMeasurementConfigServe()

BError BMeasureApi::BMeasure::getMeasurementConfigServe ( MeasurementConfig measurementConfig)
virtual

◆ getMeasurementServe()

BError BMeasureApi::BMeasure::getMeasurementServe ( 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,
BInt32 state 
)

Get digital bits.

◆ getSwitchServe()

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

◆ login()

BError BMeasureApi::BMeasure::login ( const BString user,
const BString password 
)

Provides user/password information for secure connection.

◆ loginServe()

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

◆ measure()

BError BMeasureApi::BMeasure::measure ( DataBlock dataBlock)

Performs a single measurement.

◆ measureServe()

BError BMeasureApi::BMeasure::measureServe ( DataBlock dataBlock)
virtual

◆ processRequest()

BError BMeasureApi::BMeasure::processRequest ( BTimeout  timeoutUs = BTimeoutForever)
virtual

Reimplemented from BoapMc1Comms.

◆ runBoardTest()

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

Runs the given board test.

◆ runBoardTestServe()

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

◆ sendData()

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

Sends a data block.

◆ sendDataEnable()

BError BMeasureApi::BMeasure::sendDataEnable ( const DataSend sendType)

Enable the sending of data.

◆ sendDataEnableServe()

BError BMeasureApi::BMeasure::sendDataEnableServe ( const DataSend sendType)
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 AwgConfig awgConfig)

Configure AWG.

◆ setAwgConfigServe()

BError BMeasureApi::BMeasure::setAwgConfigServe ( 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

◆ setMeasurement()

BError BMeasureApi::BMeasure::setMeasurement ( const MeasurementConfig measurementConfig)

Set measurement config.

◆ setMeasurementConfig()

BError BMeasureApi::BMeasure::setMeasurementConfig ( const MeasurementConfig measurementConfig)

Set measurement config.

◆ setMeasurementConfigServe()

BError BMeasureApi::BMeasure::setMeasurementConfigServe ( const MeasurementConfig measurementConfig)
virtual

◆ setMeasurementServe()

BError BMeasureApi::BMeasure::setMeasurementServe ( 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 BInt32 state 
)

Set relay.

◆ setRelayServe()

BError BMeasureApi::BMeasure::setRelayServe ( const BUInt32 relayNum,
const BInt32 state 
)
virtual

◆ setSecureKey()

BError BMeasureApi::BMeasure::setSecureKey ( const BString key)

Set the security key.

◆ setSecureKeyServe()

BError BMeasureApi::BMeasure::setSecureKeyServe ( const BString key)
virtual

◆ setSecureMode()

BError BMeasureApi::BMeasure::setSecureMode ( const SecureMode secureMode)

Set the security mode.

◆ setSecureModeServe()

BError BMeasureApi::BMeasure::setSecureModeServe ( const SecureMode secureMode)
virtual

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