C++ Instrument Catalog
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
MTL::CInstrumentCatalog Class Reference

#include <InstrumentCatalog.h>

Classes

struct  sError
 
struct  sFCAInformation
 
struct  sInstrumentConfiguration
 
struct  sInstrumentConnection
 
struct  sInstrumentInformation
 
struct  sInstrumentState
 
struct  sInstrumentStatus
 
struct  sLogMessage
 
struct  sMeasurement
 
struct  sMeasurementResults
 
struct  sMeasureProbeSelection
 
struct  sMFC3045SerialPortSettings
 
struct  sNormalization
 
struct  sProbeArrayAngle
 
struct  sProbeArrayInformation
 
struct  sProbeInformation
 
struct  sSearchResult
 

Public Types

enum  eConnectionInterface { eConnectionInterface::kUnknown, eConnectionInterface::kUSB, eConnectionInterface::kEthernet, eConnectionInterface::kSerial }
 
enum  eSerialBaudrate {
  eSerialBaudrate::k2400 = 2400, eSerialBaudrate::k4800 = 4800, eSerialBaudrate::k9600 = 9600, eSerialBaudrate::k19200 = 19200,
  eSerialBaudrate::k28800 = 28800, eSerialBaudrate::k38400 = 38400, eSerialBaudrate::k57600 = 57600, eSerialBaudrate::k115200 = 115200
}
 
enum  eSerialDataBits { eSerialDataBits::k7 = 7, eSerialDataBits::k8 = 8 }
 
enum  eSerialParity { eSerialParity::kNone, eSerialParity::kOdd, eSerialParity::kEven }
 
enum  eSerialStopBits { eSerialStopBits::k1, eSerialStopBits::k2 }
 
enum  eSerialHandshake { eSerialHandshake::kNone, eSerialHandshake::kXonXoff, eSerialHandshake::kHardware }
 
enum  eInstrumentType { eInstrumentType::kMFC3045, eInstrumentType::kPT2026, eInstrumentType::kUnknown }
 
enum  eProbeArrayType { eProbeArrayType::kMFC3048, eProbeArrayType::kMFC9046, eProbeArrayType::kMFC9146, eProbeArrayType::kUnknown }
 
enum  eOperatingMode { eOperatingMode::kIdle, eOperatingMode::kSearch, eOperatingMode::kMeasure }
 
enum  eRepeatMode { eRepeatMode::kSingle, eRepeatMode::kContinuous }
 
enum  eMeasureSelectionMode { eMeasureSelectionMode::kProbeArray, eMeasureSelectionMode::kSingleProbe }
 
enum  eInstrumentState { eInstrumentState::kWaitingForPA, eInstrumentState::kReady, eInstrumentState::kSearching, eInstrumentState::kMeasuring }
 
enum  eRemoteBoxTrigger { eRemoteBoxTrigger::kRemoteBoxTrigger }
 
enum  eRemoteBoxBusyLedState {
  eRemoteBoxBusyLedState::kRemoteBusyLedOff, eRemoteBoxBusyLedState::kRemoteBusyLedMeasuring, eRemoteBoxBusyLedState::kRemoteBusyLedOffEndMeas, eRemoteBoxBusyLedState::kRemoteBusyLedOn,
  eRemoteBoxBusyLedState::kRemoteBusyLedBlinkSlow, eRemoteBoxBusyLedState::kRemoteBusyLedBlinkFast
}
 
enum  eNormalizationAccess { eNormalizationAccess::kReadRAM, eNormalizationAccess::kReadROM, eNormalizationAccess::kWriteRAM, eNormalizationAccess::kWriteROM }
 
enum  eErrorLevel { eErrorLevel::kFatal, eErrorLevel::kError, eErrorLevel::kWarning }
 
enum  eLogLevel { eLogLevel::kCritical, eLogLevel::kDebug, eLogLevel::kInfo, eLogLevel::kWarning }
 
typedef std::time_t tPosixTime
 
typedef std::string tISO8601DateTime
 
typedef std::string tInstrumentLabel
 
typedef std::string tInstrumentUniqueID
 
typedef std::vector< sInstrumentConnectiontInstrumentList
 
typedef std::vector< sMeasurementtMeasurementList
 
typedef F32 tNormalizationCorrection
 
typedef std::vector< tNormalizationCorrectiontNormalizationTable
 

Public Member Functions

 CInstrumentCatalog ()
 

Static Public Member Functions

static std::string l_Dump (const tInstrumentList &rInsList)
 
static std::string l_Dump (const sInstrumentConnection &rInsConnection)
 
static std::string l_Dump (const sMFC3045SerialPortSettings &rSerialSett)
 
static std::string l_Dump (const sInstrumentInformation &rInsInfo)
 
static std::string l_Dump (const sInstrumentConfiguration &rInsConf)
 
static std::string l_Dump (const sProbeArrayInformation &rPAInfo)
 
static std::string l_Dump (const sProbeArrayAngle &rPAAngle)
 
static std::string l_Dump (const sInstrumentState &rInsState)
 
static std::string l_Dump (const sInstrumentStatus &rInsStatus)
 
static std::string l_Dump (const sSearchResult &rSearchResult)
 
static std::string l_Dump (const sMeasurementResults &rMeasResult)
 
static std::string l_Dump (const tISO8601DateTime &rDateTime)
 
static std::string l_Dump (const sNormalization &rNormalization)
 
static std::string l_Dump (const eRemoteBoxBusyLedState &rRBBusyLedState)
 
static std::string l_Dump (const sError &rError)
 
static std::string l_Dump (const sLogMessage &rLogMessage)
 

Static Public Attributes

static constexpr I32 WARNING_ERROR_CODE = 1
 
static constexpr I32 UNDEFINED_ERROR_CODE = 0
 
static constexpr I32 ERROR_CODE = -2
 
static constexpr I32 FATAL_ERROR_CODE = -1
 

Protected Attributes

CVariable< tInstrumentListvInstrumentList
 
CVariable< sInstrumentConnectionvInstrumentCurrent
 
CVariable< sMFC3045SerialPortSettingsvMFC3045SerialPortSettings
 
CVariable< sInstrumentInformationvInstrumentInformation
 
CVariable< sInstrumentConfigurationvInstrumentConfiguration
 
CVariable< sProbeArrayInformationvProbeArrayInformation
 
CVariable< sProbeArrayAnglevProbeArrayAngle
 
CVariable< sInstrumentStatevInstrumentState
 
CVariable< sInstrumentStatusvInstrumentStatus
 
CVariable< eRemoteBoxTriggervRemoteBoxTriggerEvent
 
CVariable< eRemoteBoxBusyLedStatevRemoteBoxBusyLedState
 
CVariable< sSearchResultvSearchResult
 
CVariable< sMeasurementResultsvMeasurementResults
 
CVariable< sNormalizationvNormalizationRequest
 
CVariable< sNormalizationvNormalizationReturned
 
CVariable< sErrorvError
 
CVariable< sLogMessagevLogMessage
 

Friends

class CGUICatalogInterface
 
class CInstrManCatalogInterface
 

Detailed Description

Definition at line 22 of file InstrumentCatalog.h.

Member Typedef Documentation

◆ tInstrumentLabel

Definition at line 30 of file InstrumentCatalog.h.

◆ tInstrumentList

Definition at line 54 of file InstrumentCatalog.h.

◆ tInstrumentUniqueID

Definition at line 31 of file InstrumentCatalog.h.

◆ tISO8601DateTime

Definition at line 28 of file InstrumentCatalog.h.

◆ tMeasurementList

Definition at line 266 of file InstrumentCatalog.h.

◆ tNormalizationCorrection

Definition at line 280 of file InstrumentCatalog.h.

◆ tNormalizationTable

Definition at line 281 of file InstrumentCatalog.h.

◆ tPosixTime

Definition at line 27 of file InstrumentCatalog.h.

Member Enumeration Documentation

◆ eConnectionInterface

Enumerator
kUnknown 
kUSB 
kEthernet 
kSerial 

Definition at line 32 of file InstrumentCatalog.h.

◆ eErrorLevel

Enumerator
kFatal 
kError 
kWarning 

Definition at line 289 of file InstrumentCatalog.h.

◆ eInstrumentState

Enumerator
kWaitingForPA 
kReady 
kSearching 
kMeasuring 

Definition at line 223 of file InstrumentCatalog.h.

◆ eInstrumentType

Enumerator
kMFC3045 
kPT2026 
kUnknown 

Definition at line 101 of file InstrumentCatalog.h.

◆ eLogLevel

Enumerator
kCritical 
kDebug 
kInfo 
kWarning 

Definition at line 317 of file InstrumentCatalog.h.

◆ eMeasureSelectionMode

Enumerator
kProbeArray 
kSingleProbe 

Definition at line 193 of file InstrumentCatalog.h.

◆ eNormalizationAccess

Enumerator
kReadRAM 
kReadROM 
kWriteRAM 
kWriteROM 

Definition at line 274 of file InstrumentCatalog.h.

◆ eOperatingMode

Enumerator
kIdle 
kSearch 
kMeasure 

Definition at line 184 of file InstrumentCatalog.h.

◆ eProbeArrayType

Enumerator
kMFC3048 
kMFC9046 
kMFC9146 
kUnknown 

Definition at line 139 of file InstrumentCatalog.h.

◆ eRemoteBoxBusyLedState

Enumerator
kRemoteBusyLedOff 
kRemoteBusyLedMeasuring 
kRemoteBusyLedOffEndMeas 
kRemoteBusyLedOn 
kRemoteBusyLedBlinkSlow 
kRemoteBusyLedBlinkFast 

Definition at line 242 of file InstrumentCatalog.h.

◆ eRemoteBoxTrigger

Enumerator
kRemoteBoxTrigger 

Definition at line 239 of file InstrumentCatalog.h.

◆ eRepeatMode

Enumerator
kSingle 
kContinuous 

Definition at line 189 of file InstrumentCatalog.h.

◆ eSerialBaudrate

Enumerator
k2400 
k4800 
k9600 
k19200 
k28800 
k38400 
k57600 
k115200 

Definition at line 55 of file InstrumentCatalog.h.

◆ eSerialDataBits

Enumerator
k7 
k8 

Definition at line 65 of file InstrumentCatalog.h.

◆ eSerialHandshake

Enumerator
kNone 
kXonXoff 
kHardware 

Definition at line 76 of file InstrumentCatalog.h.

◆ eSerialParity

Enumerator
kNone 
kOdd 
kEven 

Definition at line 69 of file InstrumentCatalog.h.

◆ eSerialStopBits

Enumerator
k1 
k2 

Definition at line 72 of file InstrumentCatalog.h.

Constructor & Destructor Documentation

◆ CInstrumentCatalog()

MTL::CInstrumentCatalog::CInstrumentCatalog ( )
inline

Definition at line 549 of file InstrumentCatalog.h.

Member Function Documentation

◆ l_Dump() [1/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const eRemoteBoxBusyLedState rRBBusyLedState)
inlinestatic

Definition at line 478 of file InstrumentCatalog.h.

◆ l_Dump() [2/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sError rError)
inlinestatic

Definition at line 489 of file InstrumentCatalog.h.

◆ l_Dump() [3/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sInstrumentConfiguration rInsConf)
inlinestatic

Definition at line 386 of file InstrumentCatalog.h.

◆ l_Dump() [4/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sInstrumentConnection rInsConnection)
inlinestatic

Definition at line 349 of file InstrumentCatalog.h.

◆ l_Dump() [5/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sInstrumentInformation rInsInfo)
inlinestatic

Definition at line 373 of file InstrumentCatalog.h.

◆ l_Dump() [6/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sInstrumentState rInsState)
inlinestatic

Definition at line 418 of file InstrumentCatalog.h.

◆ l_Dump() [7/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sInstrumentStatus rInsStatus)
inlinestatic

Definition at line 435 of file InstrumentCatalog.h.

◆ l_Dump() [8/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sLogMessage rLogMessage)
inlinestatic

Definition at line 498 of file InstrumentCatalog.h.

◆ l_Dump() [9/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sMeasurementResults rMeasResult)
inlinestatic

Definition at line 452 of file InstrumentCatalog.h.

◆ l_Dump() [10/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sMFC3045SerialPortSettings rSerialSett)
inlinestatic

Definition at line 358 of file InstrumentCatalog.h.

◆ l_Dump() [11/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sNormalization rNormalization)
inlinestatic

Definition at line 466 of file InstrumentCatalog.h.

◆ l_Dump() [12/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sProbeArrayAngle rPAAngle)
inlinestatic

Definition at line 409 of file InstrumentCatalog.h.

◆ l_Dump() [13/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sProbeArrayInformation rPAInfo)
inlinestatic

Definition at line 392 of file InstrumentCatalog.h.

◆ l_Dump() [14/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const sSearchResult rSearchResult)
inlinestatic

Definition at line 445 of file InstrumentCatalog.h.

◆ l_Dump() [15/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const tInstrumentList rInsList)
inlinestatic

Definition at line 340 of file InstrumentCatalog.h.

◆ l_Dump() [16/16]

static std::string MTL::CInstrumentCatalog::l_Dump ( const tISO8601DateTime rDateTime)
inlinestatic

Definition at line 460 of file InstrumentCatalog.h.

Friends And Related Function Documentation

◆ CGUICatalogInterface

friend class CGUICatalogInterface
friend

Definition at line 513 of file InstrumentCatalog.h.

◆ CInstrManCatalogInterface

friend class CInstrManCatalogInterface
friend

Definition at line 514 of file InstrumentCatalog.h.

Member Data Documentation

◆ ERROR_CODE

constexpr I32 MTL::CInstrumentCatalog::ERROR_CODE = -2
staticconstexpr

Definition at line 296 of file InstrumentCatalog.h.

◆ FATAL_ERROR_CODE

constexpr I32 MTL::CInstrumentCatalog::FATAL_ERROR_CODE = -1
staticconstexpr

Definition at line 297 of file InstrumentCatalog.h.

◆ UNDEFINED_ERROR_CODE

constexpr I32 MTL::CInstrumentCatalog::UNDEFINED_ERROR_CODE = 0
staticconstexpr

Definition at line 295 of file InstrumentCatalog.h.

◆ vError

CVariable<sError> MTL::CInstrumentCatalog::vError
protected

Definition at line 545 of file InstrumentCatalog.h.

◆ vInstrumentConfiguration

CVariable<sInstrumentConfiguration> MTL::CInstrumentCatalog::vInstrumentConfiguration
protected

Definition at line 528 of file InstrumentCatalog.h.

◆ vInstrumentCurrent

CVariable<sInstrumentConnection> MTL::CInstrumentCatalog::vInstrumentCurrent
protected

Definition at line 523 of file InstrumentCatalog.h.

◆ vInstrumentInformation

CVariable<sInstrumentInformation> MTL::CInstrumentCatalog::vInstrumentInformation
protected

Definition at line 527 of file InstrumentCatalog.h.

◆ vInstrumentList

CVariable<tInstrumentList> MTL::CInstrumentCatalog::vInstrumentList
protected

Definition at line 522 of file InstrumentCatalog.h.

◆ vInstrumentState

CVariable<sInstrumentState> MTL::CInstrumentCatalog::vInstrumentState
protected

Definition at line 533 of file InstrumentCatalog.h.

◆ vInstrumentStatus

CVariable<sInstrumentStatus> MTL::CInstrumentCatalog::vInstrumentStatus
protected

Definition at line 534 of file InstrumentCatalog.h.

◆ vLogMessage

CVariable<sLogMessage> MTL::CInstrumentCatalog::vLogMessage
protected

Definition at line 546 of file InstrumentCatalog.h.

◆ vMeasurementResults

CVariable<sMeasurementResults> MTL::CInstrumentCatalog::vMeasurementResults
protected

Definition at line 540 of file InstrumentCatalog.h.

◆ vMFC3045SerialPortSettings

CVariable<sMFC3045SerialPortSettings> MTL::CInstrumentCatalog::vMFC3045SerialPortSettings
protected

Definition at line 524 of file InstrumentCatalog.h.

◆ vNormalizationRequest

CVariable<sNormalization> MTL::CInstrumentCatalog::vNormalizationRequest
protected

Definition at line 543 of file InstrumentCatalog.h.

◆ vNormalizationReturned

CVariable<sNormalization> MTL::CInstrumentCatalog::vNormalizationReturned
protected

Definition at line 544 of file InstrumentCatalog.h.

◆ vProbeArrayAngle

CVariable<sProbeArrayAngle> MTL::CInstrumentCatalog::vProbeArrayAngle
protected

Definition at line 530 of file InstrumentCatalog.h.

◆ vProbeArrayInformation

CVariable<sProbeArrayInformation> MTL::CInstrumentCatalog::vProbeArrayInformation
protected

Definition at line 529 of file InstrumentCatalog.h.

◆ vRemoteBoxBusyLedState

CVariable<eRemoteBoxBusyLedState> MTL::CInstrumentCatalog::vRemoteBoxBusyLedState
protected

Definition at line 536 of file InstrumentCatalog.h.

◆ vRemoteBoxTriggerEvent

CVariable<eRemoteBoxTrigger> MTL::CInstrumentCatalog::vRemoteBoxTriggerEvent
protected

Definition at line 535 of file InstrumentCatalog.h.

◆ vSearchResult

CVariable<sSearchResult> MTL::CInstrumentCatalog::vSearchResult
protected

Definition at line 539 of file InstrumentCatalog.h.

◆ WARNING_ERROR_CODE

constexpr I32 MTL::CInstrumentCatalog::WARNING_ERROR_CODE = 1
staticconstexpr

Definition at line 294 of file InstrumentCatalog.h.


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