THM1176InstrumentDriver  1.0
C++ API for Metrolab THM1176
THM1176Types.h File Reference

Type definitions for C++ API for Metrolab THM1176/TFM1186. More...

#include <string>
#include <vector>
#include <cmath>
#include <ctime>
#include "OSDefines.h"
#include "IEEE488InstrumentTypes.h"
Include dependency graph for THM1176Types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  MTL::Instrument::THM1176Types::sStatusRegister
 Complete identification of a SCPI status register. More...
 
class  MTL::Instrument::THM1176Types::RegisterList
 List of SCPI status registers. More...
 
class  MTL::Instrument::THM1176Types::StatusValues
 List of values returned for several SCPI status registers. More...
 
union  MTL::Instrument::THM1176Types::uStatusByte
 Union to access the Status Byte as integer or bit fields. More...
 
struct  MTL::Instrument::THM1176Types::uStatusByte::sStatusByte
 Access the Status Byte as bit fields. More...
 
union  MTL::Instrument::THM1176Types::uStandardEvent
 Union to access the Standard Event Status Register as integer or bit fields. More...
 
struct  MTL::Instrument::THM1176Types::uStandardEvent::sStandardEvent
 Access the Standard Event Status Register as bit fields. More...
 
union  MTL::Instrument::THM1176Types::uOPERation
 Union to access the Operation Status Register as integer or bit fields. More...
 
struct  MTL::Instrument::THM1176Types::uOPERation::sOPERation
 Access the Operation Status Register as bit fields. More...
 
union  MTL::Instrument::THM1176Types::uQUEStionable
 Union to access the Questionable Status Register as integer or bit fields. More...
 
struct  MTL::Instrument::THM1176Types::uQUEStionable::sQUEStionable
 Access the Questionable Status Register as bit fields. More...
 
class  MTL::Instrument::THM1176Types::CFluxList
 List of flux density values. More...
 
class  MTL::Instrument::THM1176Types::CUnitsList
 List of measurement units. More...
 
class  MTL::Instrument::THM1176Types::CDivisorList
 List of divisors, one per measurement unit. More...
 
struct  MTL::Instrument::THM1176Types::sError
 Error returned by the instrument. More...
 
class  MTL::Instrument::THM1176Types::CErrorList
 List of errors returned by the instrument. More...
 
struct  MTL::Instrument::THM1176Types::sBoundedParm< DataType >
 Parameter template, with current/min/max/default values. More...
 
struct  MTL::Instrument::THM1176Types::sExample< ParmType >
 Sample parameter template. More...
 
struct  MTL::Instrument::THM1176Types::sVersion
 Major and minor version numbers. More...
 
struct  MTL::Instrument::THM1176Types::sIdentifier
 Instrument's identification string - parsed version. More...
 
struct  MTL::Instrument::THM1176Types::sAveraging< ParmType >
 Averaging parameter. More...
 
struct  MTL::Instrument::THM1176Types::sInputTrigger< ParmType >
 Input trigger parameter. More...
 
struct  MTL::Instrument::THM1176Types::sRange< ParmType >
 Measurement range parameter. More...
 
struct  MTL::Instrument::THM1176Types::sFile
 Directory entry in the instrument's file system. More...
 
class  MTL::Instrument::THM1176Types::CAbsoluteTimestamp
 Timestamp for a measurement. More...
 
class  MTL::Instrument::THM1176Types::CTimestampList
 List of timestamps. More...
 
struct  MTL::Instrument::THM1176Types::sArbitraryMeasurements
 Specify the measurement data to be returned. More...
 
struct  MTL::Instrument::THM1176Types::sMeasurementConditions
 Summary of the parameters used to make a measurement. More...
 

Namespaces

 MTL
 
 MTL::Instrument
 
 MTL::Instrument::THM1176Types
 

Typedefs

typedef F32 MTL::Instrument::THM1176Types::tFlux
 Flux density value, as 32-bit floating-point number. More...
 
template<class DataType >
using MTL::Instrument::THM1176Types::uParm = DataType
 Parameter template, with only current value. More...
 
typedef std::vector< sFile > MTL::Instrument::THM1176Types::tFileList
 List of directory entries. More...
 

Enumerations

enum  MTL::Instrument::THM1176Types::eStatusRegisterSet { MTL::Instrument::THM1176Types::kStatusByte = 0, MTL::Instrument::THM1176Types::kStandardEventStatusRegister, MTL::Instrument::THM1176Types::kStatusQuestionableStatusRegister, MTL::Instrument::THM1176Types::kStatusOperationStatusRegister }
 Enumeration of SCPI status register sets. More...
 
enum  MTL::Instrument::THM1176Types::eStatusRegisterType { MTL::Instrument::THM1176Types::kStatusEvent = 0, MTL::Instrument::THM1176Types::kStatusCondition, MTL::Instrument::THM1176Types::kStatusEnable }
 Enumeration of SCPI status register types. More...
 
enum  MTL::Instrument::THM1176Types::eUnits {
  MTL::Instrument::THM1176Types::kT, MTL::Instrument::THM1176Types::kmT, MTL::Instrument::THM1176Types::kuT, MTL::Instrument::THM1176Types::knT,
  MTL::Instrument::THM1176Types::kGauss, MTL::Instrument::THM1176Types::kkGauss, MTL::Instrument::THM1176Types::kmGauss, MTL::Instrument::THM1176Types::kMHzp
}
 Enumeration of possible measurement units. More...
 
enum  MTL::Instrument::THM1176Types::eInputTriggerSource { MTL::Instrument::THM1176Types::kInputTrigSrcImmediate, MTL::Instrument::THM1176Types::kInputTrigSrcTimer, MTL::Instrument::THM1176Types::kInputTrigSrcBus }
 Enumeration of possible trigger sources. More...
 
enum  MTL::Instrument::THM1176Types::eCommunicationFormat { MTL::Instrument::THM1176Types::kComFormatAscii, MTL::Instrument::THM1176Types::kComFormatInteger, MTL::Instrument::THM1176Types::kComFormatPacked2Byte, MTL::Instrument::THM1176Types::kComFormatPacked1Byte }
 Enumeration of possible formats for returned data. More...
 

Functions

std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const eStatusRegisterSet &RegSet)
 Status register set stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const eStatusRegisterType &RegType)
 Status register type stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sStatusRegister &RegDef)
 Status register definition stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const RegisterList &RegList)
 Status register list stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const StatusValues &StatusList)
 Status value list stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const uStatusByte &StatusByte)
 Status byte stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const uStandardEvent &StdEventReg)
 Standard event register stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const uOPERation &OperReg)
 OPERation register stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const uQUEStionable &QuestReg)
 QUEStionable register stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const CFluxList &FluxList)
 Flux list stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const eUnits &Units)
 Units stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const CUnitsList &UnitsList)
 Units list stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const CDivisorList &DivisorList)
 Divisor list stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sError &Error)
 Error stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const CErrorList &ErrorList)
 Error list stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sVersion &Version)
 Version stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sIdentifier &ID)
 Identifier stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sAveraging< uParm > &AvgParm)
 Averaging parameters stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sAveraging< sBoundedParm > &AvgParm)
 Averaging bounds stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const eInputTriggerSource &TrgSrc)
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sInputTrigger< uParm > &TrigParm)
 Trigger parameters stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sInputTrigger< sBoundedParm > &TrigParm)
 Trigger bounds stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const eCommunicationFormat &CommFormat)
 Comm format stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sRange< uParm > &RangeParm)
 Range parameters stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sRange< sBoundedParm > &RangeParm)
 Range bounds stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sFile &FileInfo)
 File info stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const tFileList &FileList)
 File List stream output. More...
 
CAbsoluteTimestamp MTL::Instrument::THM1176Types::operator+ (CAbsoluteTimestamp a, CAbsoluteTimestamp b)
 Timestamp addition operator. More...
 
CAbsoluteTimestamp MTL::Instrument::THM1176Types::operator- (CAbsoluteTimestamp a, CAbsoluteTimestamp b)
 Timestamp subtraction operator. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const CAbsoluteTimestamp &Timestamp)
 Timestamp stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const CTimestampList &TimestampList)
 Timestamp list stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sArbitraryMeasurements &MeasSpec)
 Arbitrary measurement specification stream output. More...
 
std::ostream & MTL::Instrument::THM1176Types::operator<< (std::ostream &Stream, const sMeasurementConditions &MeasCond)
 Measurement conditions stream output. More...
 

Detailed Description

Type definitions for C++ API for Metrolab THM1176/TFM1186.

Definition in file THM1176Types.h.