![]() |
THM1176InstrumentManager 1.1
Qt Object abstraction for Metrolab THM1176
|
THM1176 Instrument Manager class: public interface. More...
#include <CTHM1176InstrumentManager.h>
Public Slots | |
void | SetCurrentInstrument (tResourceName CurrentInstrument) |
Connect a new instrument. | |
void | SetOperatingMode (eTHM1176OperatingMode OperatingMode) |
Set a new operating mode, for example to start measuring. | |
void | SetAveragingParms (sAveraging< uParm > AveragingParms) |
Set the averaging parameters. | |
void | SetTriggerParms (sInputTrigger< uParm > TriggerParms) |
Set the trigger parameters. | |
void | SetOutputSelect (sArbitraryMeasurements OutputSelect) |
Set the output selection parameters. | |
void | SetSleepParm (bool SleepParm) |
Set the sleep parameter. | |
void | SetUnits (eTHM1176Units Units) |
Set the measurement units. | |
void | SetRangeParms (sRange< uParm > RangeParms) |
Set the range parameters. | |
void | SetCommFormat (eCommunicationFormat CommFormat) |
Set the communication format parameters. | |
void | Start (void) |
Initialize the THM1176 Instrument Manager. | |
void | Stop (void) |
Shut down the THM1176 Instrument Manager. | |
Signals | |
void | SendTrigger (void) |
Send a bus trigger to the instrument (both slot and signal). | |
void | SetCalibrationOverride (bool Override) |
Set whether or not to override the check for instruments whose zero offset should not be calibrated. | |
void | NotifyInstrumentList (CResourceList InstrumentList) |
Notify that the list of detected instruments has changed. | |
void | NotifyCurrentInstrument (tResourceName CurrentInstrument) |
Notify that the currently connected instrument has changed. | |
void | NotifyOperatingMode (eTHM1176OperatingMode OperatingMode) |
Notify that the operating mode has changed. | |
void | NotifyMeasurement (CMeasurement Measurement) |
Notify that a new set of measurements is available. | |
void | NotifyErrorList (CErrorList ErrorList) |
Notify that new errors are present. | |
void | NotifyIdentification (sIdentifier Identification) |
Notify that the instrument identification information has changed. | |
void | NotifyRangeList (CFluxList RangeList) |
Notify that the list of valid ranges has changed. | |
void | NotifyUnitsList (CTHM1176UnitsList UnitsList) |
Notify that the list of valid measurement units has changed. | |
void | NotifyDivisorList (CDivisorList DivisorList) |
Notify that the list of divisors associated with each measurement unit for this instrument model has changed. | |
void | NotifyAveragingParmBounds (sAveraging< sBoundedParm > AveragingParmBounds) |
Notify that the bounds on averaging parameters have changed. | |
void | NotifyTriggerParmBounds (sInputTrigger< sBoundedParm > TriggerParmBounds) |
Notify that the bounds on trigger parameters have changed. | |
void | NotifyRangeParmBounds (sRange< sBoundedParm > RangeParmBounds) |
Notify that the bounds on range parameters have changed. | |
void | NotifyAveragingParms (sAveraging< uParm > AveragingParms) |
Notify that the averaging parameters have changed. | |
void | NotifyTriggerParms (sInputTrigger< uParm > TriggerParms) |
Notify that the trigger parameters have changed. | |
void | NotifyOutputSelect (sArbitraryMeasurements OutputSelect) |
Notify that the output selection parameters have changed. | |
void | NotifySleepParm (bool SleepParm) |
Notify that the sleep parameter has changed. | |
void | NotifyUnits (eTHM1176Units Units) |
Notify that the measurement units have changed. | |
void | NotifyRangeParms (sRange< uParm > RangeParms) |
Notify that the range parameters have changed. | |
void | NotifyCommFormat (eCommunicationFormat CommFormat) |
Notify that the communication format parameters have changed. | |
void | StartInstrumentScanner (THM1176_RSRC_MGR_CLS *pResourceManager) |
Internal signal to start the Instrument Scanner. | |
void | StopInstrumentScanner (void) |
Internal signal to stop the Instrument Scanner. | |
void | StartInstrumentController (THM1176_RSRC_MGR_CLS *pResourceManager) |
Internal signal to start to Instrument Controller. | |
void | StopInstrumentController (void) |
Internal signal to stop the Instrument Controller. | |
void | RelayCurrentInstrument (tResourceName CurrentInstrument) |
Internal signal to relay the instrument selection to the Instrument Controller. | |
void | RelayOperatingMode (eTHM1176OperatingMode OperatingMode) |
Internal signal to relay the operating mode selection to the Instrument Controller. | |
void | RelayAveragingParms (sAveraging< uParm > AveragingParms) |
Internal signal to relay the averaging parameters to the Instrument Controller. | |
void | RelayTriggerParms (sInputTrigger< uParm > TriggerParms) |
Internal signal to relay the trigger parameters to the Instrument Controller. | |
void | RelayOutputSelect (sArbitraryMeasurements OutputSelect) |
Internal signal to relay the output selection parameters to the Instrument Controller. | |
void | RelaySleepParm (bool SleepParm) |
Internal signal to relay the sleep parameter to the Instrument Controller. | |
void | RelayUnits (eTHM1176Units Units) |
Internal signal to relay the measurement units to the Instrument Controller. | |
void | RelayRangeParms (sRange< uParm > RangeParms) |
Internal signal to relay the range parameters to the Instrument Controller. | |
void | RelayCommFormat (eCommunicationFormat CommFormat) |
Internal signal to relay the communications format to the Instrument Controller. | |
Public Member Functions | |
CTHM1176InstrumentManager (void) | |
Constructor. | |
~CTHM1176InstrumentManager (void) | |
Destructor. | |
CResourceList | GetInstrumentList (void) |
Get the list of connected instruments. | |
tResourceName | GetCurrentInstrument (void) |
Get VISA resource name of currently connected instrument. | |
eTHM1176OperatingMode | GetOperatingMode (void) |
Get the current operating mode. | |
bool | GetIsTHMNullptr (void) |
Get the test result of m_pTHM1176 pointer is Nullptr. | |
CMeasurement | GetMeasurement (void) |
Get the last set of measurements. | |
CErrorList | GetErrorList (void) |
Get the current error list. | |
sIdentifier | GetIdentification (void) |
Get the current instrument's identification information. | |
CFluxList | GetRangeList (void) |
Get list of valid ranges for this instrument model. | |
CTHM1176UnitsList | GetUnitsList (void) |
Get the list of valid measurement units for this instrument model. | |
CDivisorList | GetDivisorList (void) |
Get the list of divisors associated with each measurement unit for this instrument model. | |
sAveraging< sBoundedParm > | GetAveragingParmBounds (void) |
Get the bounds on averaging parameters. | |
sInputTrigger< sBoundedParm > | GetTriggerParmBounds (void) |
Get the bounds on trigger parameters. | |
sRange< sBoundedParm > | GetRangeParmBounds (void) |
Get the bounds on range parameters. | |
sAveraging< uParm > | GetAveragingParms (void) |
Get the averaging parameters. | |
sInputTrigger< uParm > | GetTriggerParms (void) |
Get the trigger parameters. | |
sArbitraryMeasurements | GetOutputSelect (void) |
Get the output selection parameters. | |
bool | GetSleepParm (void) |
Get the sleep parameter. | |
eTHM1176Units | GetUnits (void) |
Get the measurement units. | |
sRange< uParm > | GetRangeParms (void) |
Get the range parameters. | |
eCommunicationFormat | GetCommFormat (void) |
Get the communication format parameters. | |
bool | GetImmediateMeasurementPeriod (const sAveraging< uParm > &rAvg, F64 &rPeriod) |
Get measurement interval for Immediate Trigger, for a given averaging parameter. | |
bool | ConvertTimestamp (const U64 RawTimestamp, CAbsoluteTimestamp &rTimestamp) |
Convert a raw timestamp to UNIX Epoch time and nanoseconds. | |
bool | ReadInformationDates (QDateTime &rManufacturingDate, QDateTime &rCalibrationDate) |
Fetch the intrument's date information. | |
Static Public Attributes | |
static const I32 | THM1176_INST_MGR_ERROR = 5000 |
Additional error code: Instrument Manager Error. | |
static const I32 | THM1176_INST_CTLR_ERROR = 5001 |
Additional error code: Instrument Controller Error. | |
static const I32 | THM1176_INST_SCANNER_ERROR = 5002 |
Additional error code: Instrument Scanner Error. | |
Properties | |
CResourceList | InstrumentList |
List of detected instruments. | |
tResourceName | CurrentInstrument |
Currently connected instrument. | |
eTHM1176OperatingMode | OperatingMode |
Current operating mode. | |
CMeasurement | Measurement |
Last measurement set returned. | |
CErrorList | ErrorList |
Current error list. | |
sIdentifier | Identification |
Identification information of currently connected instrument. | |
CFluxList | RangeList |
List of valid ranges for this instrument model. | |
CTHM1176UnitsList | UnitsList |
List of valid measurement units for this instrument model. | |
CDivisorList | DivisorList |
List of divisors for each measurement unit for this instrument model, to convert "base" units to the selected units. | |
sAveraging< sBoundedParm > | AveragingParmBounds |
Bounds on averaging parameter. | |
sInputTrigger< sBoundedParm > | TriggerParmBounds |
Bounds on trigger parameters. | |
sRange< sBoundedParm > | RangeParmBounds |
Bounds on range parameters. | |
sAveraging< uParm > | AveragingParms |
Current averaging parameters. | |
sInputTrigger< uParm > | TriggerParms |
Current trigger parameters. | |
sArbitraryMeasurements | OutputSelect |
Output selection parameters: select what data elements are returned. | |
bool | SleepParm |
Sleep parameter: true if instrument should sleep after each measurement. | |
eTHM1176Units | Units |
Current measurement units. | |
sRange< uParm > | RangeParms |
Current range parameters. | |
eCommunicationFormat | CommFormat |
Current communication format parameter. | |
THM1176 Instrument Manager class: public interface.
This object manages the public interface of the THM1176 Instrument Manager. It is the only object the user needs to deal with.
Definition at line 538 of file CTHM1176InstrumentManager.h.
|
inline |
Constructor.
Definition at line 656 of file CTHM1176InstrumentManager.h.
|
inline |
Destructor.
Definition at line 695 of file CTHM1176InstrumentManager.h.
|
inline |
Convert a raw timestamp to UNIX Epoch time and nanoseconds.
[in] | RawTimestamp | Raw timestamp returned by instrument. |
[out] | rTimestamp | Timestamp as UNIX Epoch time and nanoseconds. |
Definition at line 794 of file CTHM1176InstrumentManager.h.
sAveraging< sBoundedParm > CTHM1176InstrumentManager::GetAveragingParmBounds | ( | void | ) |
Get the bounds on averaging parameters.
Definition at line 1501 of file CTHM1176InstrumentManager.cpp.
sAveraging< uParm > CTHM1176InstrumentManager::GetAveragingParms | ( | void | ) |
Get the averaging parameters.
Definition at line 1527 of file CTHM1176InstrumentManager.cpp.
eCommunicationFormat CTHM1176InstrumentManager::GetCommFormat | ( | void | ) |
Get the communication format parameters.
Definition at line 1575 of file CTHM1176InstrumentManager.cpp.
tResourceName CTHM1176InstrumentManager::GetCurrentInstrument | ( | void | ) |
Get VISA resource name of currently connected instrument.
Definition at line 1433 of file CTHM1176InstrumentManager.cpp.
CDivisorList CTHM1176InstrumentManager::GetDivisorList | ( | void | ) |
Get the list of divisors associated with each measurement unit for this instrument model.
Definition at line 1493 of file CTHM1176InstrumentManager.cpp.
CErrorList CTHM1176InstrumentManager::GetErrorList | ( | void | ) |
Get the current error list.
Definition at line 1461 of file CTHM1176InstrumentManager.cpp.
sIdentifier CTHM1176InstrumentManager::GetIdentification | ( | void | ) |
Get the current instrument's identification information.
Definition at line 1469 of file CTHM1176InstrumentManager.cpp.
bool CTHM1176InstrumentManager::GetImmediateMeasurementPeriod | ( | const sAveraging< uParm > & | rAvg, |
F64 & | rPeriod ) |
Get measurement interval for Immediate Trigger, for a given averaging parameter.
[in] | rAvg | Averaging setting. |
[out] | rPeriod | Corresponding measurement period, in s. |
Definition at line 1583 of file CTHM1176InstrumentManager.cpp.
CResourceList CTHM1176InstrumentManager::GetInstrumentList | ( | void | ) |
Get the list of connected instruments.
Definition at line 1427 of file CTHM1176InstrumentManager.cpp.
bool CTHM1176InstrumentManager::GetIsTHMNullptr | ( | void | ) |
Get the test result of m_pTHM1176 pointer is Nullptr.
Definition at line 1445 of file CTHM1176InstrumentManager.cpp.
CMeasurement CTHM1176InstrumentManager::GetMeasurement | ( | void | ) |
Get the last set of measurements.
Definition at line 1453 of file CTHM1176InstrumentManager.cpp.
eTHM1176OperatingMode CTHM1176InstrumentManager::GetOperatingMode | ( | void | ) |
Get the current operating mode.
Definition at line 1439 of file CTHM1176InstrumentManager.cpp.
sArbitraryMeasurements CTHM1176InstrumentManager::GetOutputSelect | ( | void | ) |
Get the output selection parameters.
Definition at line 1543 of file CTHM1176InstrumentManager.cpp.
CFluxList CTHM1176InstrumentManager::GetRangeList | ( | void | ) |
Get list of valid ranges for this instrument model.
Definition at line 1477 of file CTHM1176InstrumentManager.cpp.
sRange< sBoundedParm > CTHM1176InstrumentManager::GetRangeParmBounds | ( | void | ) |
Get the bounds on range parameters.
Definition at line 1517 of file CTHM1176InstrumentManager.cpp.
Get the range parameters.
Definition at line 1567 of file CTHM1176InstrumentManager.cpp.
bool CTHM1176InstrumentManager::GetSleepParm | ( | void | ) |
Get the sleep parameter.
Definition at line 1551 of file CTHM1176InstrumentManager.cpp.
sInputTrigger< sBoundedParm > CTHM1176InstrumentManager::GetTriggerParmBounds | ( | void | ) |
Get the bounds on trigger parameters.
Definition at line 1509 of file CTHM1176InstrumentManager.cpp.
sInputTrigger< uParm > CTHM1176InstrumentManager::GetTriggerParms | ( | void | ) |
Get the trigger parameters.
Definition at line 1535 of file CTHM1176InstrumentManager.cpp.
eTHM1176Units CTHM1176InstrumentManager::GetUnits | ( | void | ) |
Get the measurement units.
Definition at line 1559 of file CTHM1176InstrumentManager.cpp.
CTHM1176UnitsList CTHM1176InstrumentManager::GetUnitsList | ( | void | ) |
Get the list of valid measurement units for this instrument model.
Definition at line 1485 of file CTHM1176InstrumentManager.cpp.
|
signal |
Notify that the bounds on averaging parameters have changed.
[in] | AveragingParmBounds | New bounds on averaging parameters |
|
signal |
Notify that the averaging parameters have changed.
[in] | AveragingParms | New value of averaging parameters. |
|
signal |
Notify that the communication format parameters have changed.
[in] | CommFormat | New value of communication format parameters. |
|
signal |
Notify that the currently connected instrument has changed.
[in] | CurrentInstrument | VISA resource name of currently connected instrument. |
|
signal |
Notify that the list of divisors associated with each measurement unit for this instrument model has changed.
[in] | DivisorList | List of divisors for each measurement unit. |
|
signal |
Notify that new errors are present.
[in] | ErrorList | List of errors. |
|
signal |
Notify that the instrument identification information has changed.
[in] | Identification | Instrument identification. |
|
signal |
Notify that the list of detected instruments has changed.
[in] | InstrumentList | List of detected instruments. |
|
signal |
Notify that a new set of measurements is available.
[in] | Measurement | Most recent set of measurements. |
|
signal |
Notify that the operating mode has changed.
[in] | OperatingMode | New operating mode. |
|
signal |
Notify that the output selection parameters have changed.
[in] | OutputSelect | New value of output selection parameters. |
|
signal |
Notify that the list of valid ranges has changed.
[in] | RangeList | New list of ranges. |
|
signal |
Notify that the bounds on range parameters have changed.
[in] | RangeParmBounds | New bounds on range parameters |
Notify that the range parameters have changed.
[in] | RangeParms | New value of range parameters. |
|
signal |
Notify that the sleep parameter has changed.
[in] | SleepParm | New value of sleep parameters. |
|
signal |
Notify that the bounds on trigger parameters have changed.
[in] | TriggerParmBounds | New bounds on trigger parameters |
|
signal |
Notify that the trigger parameters have changed.
[in] | TriggerParms | New value of trigger parameters. |
|
signal |
Notify that the measurement units have changed.
[in] | Units | New measurement units. |
|
signal |
Notify that the list of valid measurement units has changed.
[in] | UnitsList | New ist of valid measurement units. |
bool CTHM1176InstrumentManager::ReadInformationDates | ( | QDateTime & | rManufacturingDate, |
QDateTime & | rCalibrationDate ) |
Fetch the intrument's date information.
[out] | rManufacturingDate | Manufacturing date as QDateTime. |
[out] | rCalibrationDate | Calibration date as QDateTime. |
Definition at line 1596 of file CTHM1176InstrumentManager.cpp.
|
signal |
Internal signal to relay the averaging parameters to the Instrument Controller.
[in] | AveragingParms | Newly selected averaging parameters. |
|
signal |
Internal signal to relay the communications format to the Instrument Controller.
[in] | CommFormat | Newly selected communications format. |
|
signal |
Internal signal to relay the instrument selection to the Instrument Controller.
[in] | CurrentInstrument | VISA resource name for the newly selected instrument. |
|
signal |
Internal signal to relay the operating mode selection to the Instrument Controller.
[in] | OperatingMode | Newly selected operating mode. |
|
signal |
Internal signal to relay the output selection parameters to the Instrument Controller.
[in] | OutputSelect | Newly selected output selection parameters. |
Internal signal to relay the range parameters to the Instrument Controller.
[in] | RangeParms | Newly selected range parameters. |
|
signal |
Internal signal to relay the sleep parameter to the Instrument Controller.
SleepParm | Newly selected sleep parameter. |
|
signal |
Internal signal to relay the trigger parameters to the Instrument Controller.
[in] | TriggerParms | Newly selected trigger parameters. |
|
signal |
Internal signal to relay the measurement units to the Instrument Controller.
[in] | Units | Newly selected measurement units. |
|
signal |
Send a bus trigger to the instrument (both slot and signal).
Note: Invoke this signal as if it were a slot. This will emit a signal to the THM1176 Inastrument Controller, which will actually emit the bus trigger.
|
slot |
Set the averaging parameters.
[in] | AveragingParms | Desired value of averaging parameters. |
Definition at line 1670 of file CTHM1176InstrumentManager.cpp.
|
signal |
Set whether or not to override the check for instruments whose zero offset should not be calibrated.
[in] | Override | Override the check if true. |
Note: Invoke this signal as if it were a slot. This will emit a signal to the THM1176 Inastrument Controller, which will actually set the parameter.
|
slot |
Set the communication format parameters.
[in] | CommFormat | Desired value of communication format parameters. |
Definition at line 1830 of file CTHM1176InstrumentManager.cpp.
|
slot |
Connect a new instrument.
[in] | CurrentInstrument | VISA resource name of instrument to connect. |
Definition at line 1626 of file CTHM1176InstrumentManager.cpp.
|
slot |
Set a new operating mode, for example to start measuring.
[in] | OperatingMode | Desired operting mode. |
Definition at line 1650 of file CTHM1176InstrumentManager.cpp.
|
slot |
Set the output selection parameters.
[in] | OutputSelect | Desired value of output selection parameters. |
Definition at line 1725 of file CTHM1176InstrumentManager.cpp.
Set the range parameters.
[in] | RangeParms | Desired value of range parameters. |
Definition at line 1798 of file CTHM1176InstrumentManager.cpp.
|
slot |
Set the sleep parameter.
[in] | SleepParm | Desired value of sleep parameter. |
Definition at line 1751 of file CTHM1176InstrumentManager.cpp.
|
slot |
Set the trigger parameters.
[in] | TriggerParms | Desired value of trigger parameters. |
Definition at line 1696 of file CTHM1176InstrumentManager.cpp.
|
slot |
Set the measurement units.
[in] | Units | Desired measurement units. |
Definition at line 1770 of file CTHM1176InstrumentManager.cpp.
|
slot |
Initialize the THM1176 Instrument Manager.
Definition at line 1056 of file CTHM1176InstrumentManager.cpp.
|
signal |
Internal signal to start to Instrument Controller.
[in] | pResourceManager | Pointer to VISA Resource Manager. |
|
signal |
Internal signal to start the Instrument Scanner.
[in] | pResourceManager | Pointer to VISA Resource Manager. |
|
slot |
Shut down the THM1176 Instrument Manager.
Definition at line 1181 of file CTHM1176InstrumentManager.cpp.
|
signal |
Internal signal to stop the Instrument Controller.
|
signal |
Internal signal to stop the Instrument Scanner.
|
static |
Additional error code: Instrument Controller Error.
Definition at line 649 of file CTHM1176InstrumentManager.h.
|
static |
Additional error code: Instrument Manager Error.
Definition at line 648 of file CTHM1176InstrumentManager.h.
|
static |
Additional error code: Instrument Scanner Error.
Definition at line 650 of file CTHM1176InstrumentManager.h.
|
read |
Bounds on averaging parameter.
Definition at line 567 of file CTHM1176InstrumentManager.h.
|
readwrite |
Current averaging parameters.
Definition at line 575 of file CTHM1176InstrumentManager.h.
|
readwrite |
Current communication format parameter.
Definition at line 587 of file CTHM1176InstrumentManager.h.
|
readwrite |
Currently connected instrument.
Definition at line 549 of file CTHM1176InstrumentManager.h.
|
read |
List of divisors for each measurement unit for this instrument model, to convert "base" units to the selected units.
Definition at line 565 of file CTHM1176InstrumentManager.h.
|
read |
Current error list.
Definition at line 555 of file CTHM1176InstrumentManager.h.
|
read |
Identification information of currently connected instrument.
Definition at line 559 of file CTHM1176InstrumentManager.h.
|
read |
List of detected instruments.
Definition at line 547 of file CTHM1176InstrumentManager.h.
|
read |
Last measurement set returned.
Definition at line 553 of file CTHM1176InstrumentManager.h.
|
readwrite |
Current operating mode.
Definition at line 551 of file CTHM1176InstrumentManager.h.
|
readwrite |
Output selection parameters: select what data elements are returned.
Definition at line 579 of file CTHM1176InstrumentManager.h.
|
read |
List of valid ranges for this instrument model.
Definition at line 561 of file CTHM1176InstrumentManager.h.
|
read |
Bounds on range parameters.
Definition at line 571 of file CTHM1176InstrumentManager.h.
Current range parameters.
Definition at line 585 of file CTHM1176InstrumentManager.h.
|
readwrite |
Sleep parameter: true if instrument should sleep after each measurement.
Definition at line 581 of file CTHM1176InstrumentManager.h.
|
read |
Bounds on trigger parameters.
Definition at line 569 of file CTHM1176InstrumentManager.h.
|
readwrite |
Current trigger parameters.
Definition at line 577 of file CTHM1176InstrumentManager.h.
|
readwrite |
Current measurement units.
Definition at line 583 of file CTHM1176InstrumentManager.h.
|
read |
List of valid measurement units for this instrument model.
Definition at line 563 of file CTHM1176InstrumentManager.h.