C++ Instrument Catalog
Public Member Functions | List of all members
MTL::Instrument::CPT2026Instrument Class Reference

PT2026 instrument class. More...

#include <PT2026.h>

Inheritance diagram for MTL::Instrument::CPT2026Instrument:
MTL::Instrument::CVISAInstrument

Public Member Functions

 CPT2026Instrument (CVISAResourceManager &rRM, tResourceName Rsrc)
 Constructors / destructors. More...
 
virtual ~CPT2026Instrument ()
 
ErrorList

List containing detailed information about the last operation performed.

const std::vector< sErrorErrorList ()
 
Open / Close

Create a link to the instrument. The actual handle to the instrument is private to the class.

bool Connect (U32 InitialTimeout_ms)
 
void Disconnect ()
 
Interface lock & unlock

Several communication ports are available on the instrument, including Ethernet that allows for remote control of the instrument. Locking a port will enforce the interface right to use get / set accessors to modify the behavior of the instrument whereas ports that don’t have the lock are only allowed to read the instrument parameters.

bool LockInterface ()
 
bool UnlockInterface ()
 
Channels handling

The PT2026 allow several probes to be connected to it using either a probe multiplexer or a field camera adapter.

bool ChannelsGetList (MTL::SCPI::tChannelList &rChanList)
 
bool ChannelsGetList (CExtendedChannelList &rChanList)
 
bool ChannelsGetState (MTL::SCPI::tChannelList &rSelChanList, MTL::SCPI::tChannelList &rActiveChan)
 
bool ChannelsSetLimitedListState (bool State)
 
bool ChannelsGetLimitedListState (bool &rState)
 
bool ChannelsSelect (const MTL::SCPI::tChannelList &rChanList)
 
bool ChannelsGetInfo (const MTL::SCPI::tChannelList &rChanList, std::vector< sChannelIformation > &rChanInfo)
 
bool ChannelsGetLimits (const MTL::SCPI::tChannelList &rChanList, std::vector< F64 > &rLowLimit_UNITS, std::vector< F64 > &rHighLimit_UNITS)
 
bool ChannelGetRawHall (sProbeRawHall &rRawHall)
 Returns the raw 16-bit ADC measurements performed by the hall sensor located at the tip of the NMR probe. Notice that all NMR probes aren’t necessarily equipped with such sensor. Magnetic field cameras aren’t equipped with such sensor. More...
 
bool ChannelGetHall (sProbeHall &rHall)
 Returns in the current units the calibrated Hall measurements. More...
 
bool ChannelGetRemoteLEDMode (eRemoteBusyLEDmode &rMode)
 
bool ChannelSetRemoteLEDMode (eRemoteBusyLEDmode Mode)
 
Search parameters

An NMR measurement always starts with a search operation consisting in finding the NMR resonance. This search operation may take a very long time, especially with probe measuring high fields. To reduce the time taken by the search operation, one may lessen the search range. Failing to set the search range with respect to the actual magnetic field density that one tries to measure will result in an infinite search operation. The search range must be set to fit the probe dynamic range.

If present, the Hall probe can be enabled allowing the search range to be set automatically. The search span set by the Hall subsystem will depend on the quality of the calibration.

bool ParmSearchSet (const sSearch< uParm > &rSearch)
 Configure the search operation, including detection level, frequency steps and the search bounds specified in the selected unit. More...
 
bool ParmSearchGet (sSearch< uParm > &rSearch)
 
bool ParmSearchGet (sSearch< sBoundedParm > &rSearch)
 
bool ParmSearchSetManualValue (F64 ManualValue_UNITS)
 Ask the instrument to perform a measurement at fixed frequency. Automatic search mode is left. More...
 
bool ParmSearchSetLimits (F64 LowLimit_UNITS, F64 HighLimit_UNITS)
 Set the search bounds in the selected unit. More...
 
bool ParmSearchSetHallEnable (bool Enabled)
 Allow the Hall probe to take control over the search range. More...
 
bool ParmSearchGetHallEnable (bool &rEnabled)
 
Measure parameters

Accessors to configure the way the measurement is processed to compute the result. These accessors are very specific, it is recommended not to use them.

bool ParmMeasureSet (const sMeasure< uParm > &rMeasure)
 
bool ParmMeasureGet (sMeasure< uParm > &rMeasure)
 
bool ParmMeasureGet (sMeasure< sBoundedParm > &rMeasure)
 
Averaging

An NMR measurement provided by the instrument can be the result of several measurements that are averaged. Two levels of averaging are available, one consists in averaging several NMR signals together using a repeat or exponential scheme and the other level consists in averaging NMR measurements using repeat, moving or exponential averaging. Be very careful using signal averaging as it may provide poor measurement results or even oscillation if used with a measured magnetic field density that isn’t perfectly stable. As such, signal averaging isn’t recommended and should be used only when confronted to stable but inhomogeneous conditions.

bool ParmAveragingSignalSet (const sSignalAveraging< uParm > &rSigAvg)
 
bool ParmAveragingSignalGet (sSignalAveraging< uParm > &rSigAvg)
 
bool ParmAveragingSignalGet (sSignalAveraging< sBoundedParm > &rSigAvg)
 
bool ParmAveragingMeasurementSet (const sMeasurementAveraging< uParm > &rMeasAvg)
 
bool ParmAveragingMeasurementGet (sMeasurementAveraging< uParm > &rMeasAvg)
 
bool ParmAveragingMeasurementGet (sMeasurementAveraging< sBoundedParm > &rMeasAvg)
 
Input trigger parameters

Configure the input trigger subsystem of the instrument. Use these methods to configure which event will latch a measurement. Available events are external trigger, internal timed trigger or continuous trigger.

bool ParmTriggerInputSet (const sInputTrigger< uParm > &rInputTrig)
 
bool ParmTriggerInputGet (sInputTrigger< uParm > &rInputTrig)
 
bool ParmTriggerInputGet (sInputTrigger< sBoundedParm > &rInputTrig)
 
Output trigger parameters

Configures the output trigger subsystem of the instrument. Use these methods to specify the measured values that, when reached, must generate an external TTL level or edge.

bool ParmTriggerOutputSet (const sOutputTrigger< uParm > &rOutputTrig)
 
bool ParmTriggerOutputGet (sOutputTrigger< uParm > &rOutputTrig)
 
bool ParmTriggerOutputGet (sOutputTrigger< sBoundedParm > &rOutputTrig)
 
RF Pulse parameters

Determines the rate and the width at which the sample is stimulated. The frequency of the pulse is not under the scope of these method that are just meant to determine the modulation rate. A simple modulation scheme is used, as for today, there is no way to generate other sequences (i.e spin echo, saturation inversion recovery, etc.)

bool ParmRFPulseSet (const sPulse< uParm > &rPulse)
 
bool ParmRFPulseGet (sPulse< uParm > &rPulse)
 
bool ParmRFPulseGet (sPulse< sBoundedParm > &rPulse)
 
Digitization parameters

Configures the digitization subsystem. One may configure the dead-time (the duration during which the FID signal isn’t sampled right after the RF burst that stimulate the NMR sample), the acquisition duration and the sampling rate.

bool ParmDigitizationSet (const sDigitization< uParm > &rDigitization)
 
bool ParmDigitizationGet (sDigitization< uParm > &rDigitization)
 
bool ParmDigitizationGet (sDigitization< sBoundedParm > &rDigitization)
 
Matching / Tuning parameters

The NMR measuring head consists in a matched / tuned RLC circuit that needs to be set according to the operation frequency. These accessors are very specific and shouldn’t be used.

bool ParmMatchingTuningSet (const sMatchingTuning< uParm > &rMatchingTuning)
 
bool ParmMatchingTuningGet (sMatchingTuning< uParm > &rMatchingTuning)
 
bool ParmMatchingTuningGet (sMatchingTuning< sBoundedParm > &rMatchingTuning)
 
Units parameters

Determine the unit in which the measurements will be returned by the instrument. One may select Tesla, milli-Tesla, Gauss, Kilo-Gauss, MHz relative to the sample, MHz relative to the proton or ppm. For ppm units, one must state the reference value. Obviously, the reference must be set prior to set the units to ppm. Once the ppm unit is selected, getting the reference will return 0.0, being the exact difference to the reference.

bool ParmUnitsSet (eUnits Units)
 
bool ParmUnitsSetPPMRef (tPPMReference_UNITS Ref)
 
bool ParmUnitsGet (eUnits &rUnits, tPPMReference_UNITS &rRef)
 
Reference Clock parameters

Sets the reference clock port direction.

bool ParmRefClockSet (eReferenceClock RefClock)
 
bool ParmRefClockGet (eReferenceClock &rRefClock)
 
Communication : USB

Enables or disables the USB communication port.

bool ParmComUsbSet (bool Enabled)
 
bool ParmComUsbGet (bool &rEnabled)
 
Communication : Ethernet

Enables or disables the Ethernet communication port.

bool ParmComEthernetSet (const sEthernet &rSettings)
 
bool ParmComEthernetGet (sEthernet &rSettings)
 
Communication : VXI11

Enables or disables the VXI11 compatibility layer.

bool ParmComVXI11Set (bool Enabled)
 
bool ParmComVXI11Get (bool &rEnabled)
 
Settings / Files
bool ReadFileDirectory (U32 &rUsedBytes, U32 &rAvailableBytes, tFileList &rFileList)
 
bool ReadFile (std::string Path, std::string &rContent)
 
bool WriteFile (std::string Path, const std::string &rContent)
 
bool DeleteFile (std::string Path)
 
bool GetSettingFileList (std::vector< std::string > &rSettingFileList)
 
bool SaveSettings (eSettingType Type, std::string Name)
 
bool RecallSettings (std::string Name)
 
Initiate / Abort / Trigger

Operation control of the measurement system.

bool Initiate (bool Continuous=false)
 Starts the search operation and then immediately after NMR resonance detection proceed to NMR measurements. If no NMR resonance is found, the search operation is performed indefinitely. More...
 
bool Abort (bool CancelContinuous=true)
 Abort the current operation (Search or measure). Once the operation is aborted, the instrument will be waiting to be initiated again. When aborted, only Hall measurement can be read. More...
 
bool SendBusTrigger ()
 Send a trigger to the instrument. If configured to react to this bus trigger, the acquisition sub system will collect a measurement and store it for future read out. More...
 
bool ForceOutputTrigger ()
 Set the output trigger according to current output trigger parametrization. This method is very specific and mainly present for debug purpose. More...
 
Measurements (data) gathering
bool MeasurementsGet (U32 NoMeasurements, std::vector< tFlux > &rFlux, eUnits &rUnits)
 Returns the NMR magnetic field density measurements, including the unit used. A measurement vector is consistent to the unit. When a measurement was lost or failed for unknown reason, the value is substituted by NaN (Not A Number). More...
 
bool MeasurementsGet (U32 NoMeasurements, sArbitraryMeasurements ArbSelect, sAllMeasurements &rMeas, eUnits &rUnits)
 Returns all the data associated to a measurement, including the temporal free induction decay, its FFT, the polynom that was computed to determine the location of the peak, the intermediate frequency, the estimated T2*. This method is very specific and mainly present for debug purpose. More...
 
bool GetSearchProgress (U8 &rSPR, F64 &rHallMeasurement_UNITS)
 
bool SetFormat (eCommunicationFormat Format)
 One can request the data in ASCII or binary format. The binary format, which needs extra operation to be decoded, are preferred as this format reduced the amount of data being sent on the communication link. Setting the format to either ASCII or binary won’t affect the results gathered using the MeasurementsGet accessors. More...
 
Instrument Status Handling

See the user manual for a detailed explanation of the instrument status subsystem.

bool StatusPreset ()
 
bool StatusGet (sStatusRegister Reg, U16 &rStatus)
 
bool StatusGet (std::vector< sStatusRegister > Regs, std::vector< U16 > &rStatus)
 
bool StatusSetEnableRegister (eStatusRegisterSet Set, U16 DisableMask, U16 EnableMask)
 
bool StatusSetTransitionFilter (eStatusRegisterSet Set, eTransition Transition, U16 ClearMask, U16 SetMask)
 
bool StandardStatusSetEnableRegister (eStandardStatusRegister Set, U16 DisableMask, U16 EnableMask)
 
Utilities
bool GetIdentification (std::string &rIdentification)
 Returns the instrument identification string including its serial number and make. This string contains also the various electronic boards versions along the internal firmware and files versions. More...
 
bool PowerOff (bool Reboot=false)
 Sending this command will shut the instrument down. Setting the reboot parameter to true will initiate a full shut-down and reboot of the instrument. Be careful, the link to the instrument is lost and must be re-acquired. It is a safe practice to release the instrument lock before performing to this operation. More...
 
bool Reset ()
 Calling this method will wipe out all user parameters that are stored in the file system and revert them back to factory defaults.
More...
 
bool ReadCaseTemperature (F32 &rTemperatureDegC)
 Returns the internal instrument temperature. An internal survey will shut the instrument down if this value reaches a temperature that is factory set to prevent the system to fail. The probe temperature isn’t measured. More...
 
bool SwitchToDFUMode ()
 Restart the instrument in USB DFU mode, allowing the firmware to be upgraded. More...
 
bool ReadDebugLog (std::string &rDebugLog)
 Returns a long string containing all the operations that were processed before the last proper instrument shut down. More...
 
bool ReadInformationDates (std::string &rSManufacturingDate, std::time_t &rManufacturingDate, std::string &rSCalibrationDate, std::time_t &rCalibrationDate)
 Returns the manufacturing and calibration date in plain text or a number representing the amount of seconds since 00:00, Jan 1 1970 UTC. More...
 
Low Level Utilities
bool DeviceROMRead (const MTL::SCPI::tChannel &rChannel, std::vector< U8 > &rROMContent)
 
bool DeviceROMWrite (const MTL::SCPI::tChannel &rChannel, const std::vector< U8 > &rROMContent)
 
bool NormalizationGet (const MTL::SCPI::tChannel &rChannel, tNormalizationTable &rNormalizationTable)
 
bool NormalizationSet (const MTL::SCPI::tChannel &rChannel, const tNormalizationTable &rNormalizationTable)
 
bool LowLevelTransfer (const std::vector< U8 > &rDataToSend, std::vector< U8 > &rRcvdData, U8 &rReturnedStatus)
 
bool WriteCustomCommand (const std::string &rWriteStr)
 
- Public Member Functions inherited from MTL::Instrument::CVISAInstrument
 CVISAInstrument (CVISAResourceManager &rRM, tResourceName Rsrc)
 
virtual ~CVISAInstrument ()
 
bool Open (eOpenAccessMode AccessMode=eOpenAccessMode::NoLock, ViUInt32 Timeout_ms=0)
 
void Close ()
 
bool IsOpen ()
 
const ViStatus & Status ()
 
const ViSession & Session ()
 
bool Write (const char *Str)
 
bool Write (const std::string &rStr)
 
bool Write (const CVISABuffer &rBuf)
 
bool Write (const ViBuf WriteBuf, ViUInt32 BuffLen)
 
bool Read (CVISABuffer &rBuf, bool Append=false)
 
bool Read (ViPBuf ReadBuf, ViUInt32 ReadLen, ViUInt32 &rRetLen)
 
bool SetTimeout (ViUInt32 Timeout)
 
bool Clear ()
 
bool ReadSTB (ViUInt16 &rSTB)
 
bool AssertTrigger (eTriggerProtocol Protocol)
 
bool LockExclusive (ViUInt32 Timeout)
 
bool LockShared (ViUInt32 Timeout, ViKeyId RequestedKey, ViChar AccessKey[])
 
bool Unlock ()
 
bool EnableEvent (eEventType Type, eEventMechanism Mechanism)
 
bool DisableEvent (eEventType Type, eEventMechanism Mechanism)
 
bool WaitOnEvent (eEventType Type, ViUInt32 Timeout)
 
bool WaitOnAllEvents (ViUInt32 Timeout)
 
bool DiscardEvents (eEventType Type, eEventMechanism Mechanism)
 
bool GetAttribute (ViAttr Attribute, void *Value)
 
bool UsbControlIn (ViInt16 bmRequestType, ViInt16 bRequest, ViUInt16 wValue, ViUInt16 wIndex, ViUInt16 wLength, ViPBuf buf, ViUInt16 &rretCnt)
 
bool UsbControlOut (ViInt16 bmRequestType, ViInt16 bRequest, ViUInt16 wValue, ViUInt16 wIndex, ViUInt16 wLength, ViBuf buf)
 
bool ConfigSerialPort (const sSerialPortSettings &rPortSettings)
 

Additional Inherited Members

- Protected Attributes inherited from MTL::Instrument::CVISAInstrument
CRecursiveMutex m_Lock
 
CVISAResourceManagerm_rRrsrcMan
 
tResourceName m_Rsrc
 
ViSession m_InstrSession
 
ViStatus m_Status
 

Detailed Description

PT2026 instrument class.

Definition at line 28 of file PT2026.h.

Constructor & Destructor Documentation

◆ CPT2026Instrument()

CPT2026Instrument::CPT2026Instrument ( CVISAResourceManager rRM,
tResourceName  Rsrc 
)

Constructors / destructors.

Definition at line 244 of file PT2026.cpp.

◆ ~CPT2026Instrument()

CPT2026Instrument::~CPT2026Instrument ( )
virtual

Definition at line 249 of file PT2026.cpp.

Member Function Documentation

◆ Abort()

bool CPT2026Instrument::Abort ( bool  CancelContinuous = true)

Abort the current operation (Search or measure). Once the operation is aborted, the instrument will be waiting to be initiated again. When aborted, only Hall measurement can be read.

Definition at line 2682 of file PT2026.cpp.

◆ ChannelGetHall()

bool CPT2026Instrument::ChannelGetHall ( sProbeHall rHall)

Returns in the current units the calibrated Hall measurements.

Definition at line 634 of file PT2026.cpp.

◆ ChannelGetRawHall()

bool CPT2026Instrument::ChannelGetRawHall ( sProbeRawHall rRawHall)

Returns the raw 16-bit ADC measurements performed by the hall sensor located at the tip of the NMR probe. Notice that all NMR probes aren’t necessarily equipped with such sensor. Magnetic field cameras aren’t equipped with such sensor.

Definition at line 605 of file PT2026.cpp.

◆ ChannelGetRemoteLEDMode()

bool CPT2026Instrument::ChannelGetRemoteLEDMode ( eRemoteBusyLEDmode rMode)

Definition at line 663 of file PT2026.cpp.

◆ ChannelSetRemoteLEDMode()

bool CPT2026Instrument::ChannelSetRemoteLEDMode ( eRemoteBusyLEDmode  Mode)

Definition at line 686 of file PT2026.cpp.

◆ ChannelsGetInfo()

bool CPT2026Instrument::ChannelsGetInfo ( const MTL::SCPI::tChannelList rChanList,
std::vector< sChannelIformation > &  rChanInfo 
)

Definition at line 500 of file PT2026.cpp.

◆ ChannelsGetLimitedListState()

bool CPT2026Instrument::ChannelsGetLimitedListState ( bool &  rState)

Definition at line 453 of file PT2026.cpp.

◆ ChannelsGetLimits()

bool CPT2026Instrument::ChannelsGetLimits ( const MTL::SCPI::tChannelList rChanList,
std::vector< F64 > &  rLowLimit_UNITS,
std::vector< F64 > &  rHighLimit_UNITS 
)

Definition at line 558 of file PT2026.cpp.

◆ ChannelsGetList() [1/2]

bool CPT2026Instrument::ChannelsGetList ( CExtendedChannelList rChanList)

Definition at line 377 of file PT2026.cpp.

◆ ChannelsGetList() [2/2]

bool CPT2026Instrument::ChannelsGetList ( MTL::SCPI::tChannelList rChanList)

Definition at line 353 of file PT2026.cpp.

◆ ChannelsGetState()

bool CPT2026Instrument::ChannelsGetState ( MTL::SCPI::tChannelList rSelChanList,
MTL::SCPI::tChannelList rActiveChan 
)

Definition at line 398 of file PT2026.cpp.

◆ ChannelsSelect()

bool CPT2026Instrument::ChannelsSelect ( const MTL::SCPI::tChannelList rChanList)

Definition at line 479 of file PT2026.cpp.

◆ ChannelsSetLimitedListState()

bool CPT2026Instrument::ChannelsSetLimitedListState ( bool  State)

Definition at line 433 of file PT2026.cpp.

◆ Connect()

bool CPT2026Instrument::Connect ( U32  InitialTimeout_ms)

Definition at line 274 of file PT2026.cpp.

◆ DeleteFile()

bool CPT2026Instrument::DeleteFile ( std::string  Path)

Definition at line 2559 of file PT2026.cpp.

◆ DeviceROMRead()

bool CPT2026Instrument::DeviceROMRead ( const MTL::SCPI::tChannel rChannel,
std::vector< U8 > &  rROMContent 
)

Definition at line 3657 of file PT2026.cpp.

◆ DeviceROMWrite()

bool CPT2026Instrument::DeviceROMWrite ( const MTL::SCPI::tChannel rChannel,
const std::vector< U8 > &  rROMContent 
)

Definition at line 3688 of file PT2026.cpp.

◆ Disconnect()

void CPT2026Instrument::Disconnect ( )

Definition at line 301 of file PT2026.cpp.

◆ ErrorList()

const std::vector< sError > CPT2026Instrument::ErrorList ( )

Definition at line 259 of file PT2026.cpp.

◆ ForceOutputTrigger()

bool CPT2026Instrument::ForceOutputTrigger ( )

Set the output trigger according to current output trigger parametrization. This method is very specific and mainly present for debug purpose.

Definition at line 2699 of file PT2026.cpp.

◆ GetIdentification()

bool CPT2026Instrument::GetIdentification ( std::string &  rIdentification)

Returns the instrument identification string including its serial number and make. This string contains also the various electronic boards versions along the internal firmware and files versions.

Definition at line 3514 of file PT2026.cpp.

◆ GetSearchProgress()

bool CPT2026Instrument::GetSearchProgress ( U8 &  rSPR,
F64 &  rHallMeasurement_UNITS 
)

Definition at line 3124 of file PT2026.cpp.

◆ GetSettingFileList()

bool CPT2026Instrument::GetSettingFileList ( std::vector< std::string > &  rSettingFileList)

Definition at line 2578 of file PT2026.cpp.

◆ Initiate()

bool CPT2026Instrument::Initiate ( bool  Continuous = false)

Starts the search operation and then immediately after NMR resonance detection proceed to NMR measurements. If no NMR resonance is found, the search operation is performed indefinitely.

Definition at line 2673 of file PT2026.cpp.

◆ LockInterface()

bool CPT2026Instrument::LockInterface ( )

Definition at line 312 of file PT2026.cpp.

◆ LowLevelTransfer()

bool CPT2026Instrument::LowLevelTransfer ( const std::vector< U8 > &  rDataToSend,
std::vector< U8 > &  rRcvdData,
U8 &  rReturnedStatus 
)

Definition at line 3761 of file PT2026.cpp.

◆ MeasurementsGet() [1/2]

bool CPT2026Instrument::MeasurementsGet ( U32  NoMeasurements,
sArbitraryMeasurements  ArbSelect,
sAllMeasurements rMeas,
eUnits rUnits 
)

Returns all the data associated to a measurement, including the temporal free induction decay, its FFT, the polynom that was computed to determine the location of the peak, the intermediate frequency, the estimated T2*. This method is very specific and mainly present for debug purpose.

Definition at line 2758 of file PT2026.cpp.

◆ MeasurementsGet() [2/2]

bool CPT2026Instrument::MeasurementsGet ( U32  NoMeasurements,
std::vector< tFlux > &  rFlux,
eUnits rUnits 
)

Returns the NMR magnetic field density measurements, including the unit used. A measurement vector is consistent to the unit. When a measurement was lost or failed for unknown reason, the value is substituted by NaN (Not A Number).

Definition at line 2711 of file PT2026.cpp.

◆ NormalizationGet()

bool CPT2026Instrument::NormalizationGet ( const MTL::SCPI::tChannel rChannel,
tNormalizationTable rNormalizationTable 
)

Definition at line 3708 of file PT2026.cpp.

◆ NormalizationSet()

bool CPT2026Instrument::NormalizationSet ( const MTL::SCPI::tChannel rChannel,
const tNormalizationTable rNormalizationTable 
)

Definition at line 3740 of file PT2026.cpp.

◆ ParmAveragingMeasurementGet() [1/2]

bool CPT2026Instrument::ParmAveragingMeasurementGet ( sMeasurementAveraging< sBoundedParm > &  rMeasAvg)

Definition at line 1313 of file PT2026.cpp.

◆ ParmAveragingMeasurementGet() [2/2]

bool CPT2026Instrument::ParmAveragingMeasurementGet ( sMeasurementAveraging< uParm > &  rMeasAvg)

Definition at line 1248 of file PT2026.cpp.

◆ ParmAveragingMeasurementSet()

bool CPT2026Instrument::ParmAveragingMeasurementSet ( const sMeasurementAveraging< uParm > &  rMeasAvg)

Definition at line 1218 of file PT2026.cpp.

◆ ParmAveragingSignalGet() [1/2]

bool CPT2026Instrument::ParmAveragingSignalGet ( sSignalAveraging< sBoundedParm > &  rSigAvg)

Definition at line 1155 of file PT2026.cpp.

◆ ParmAveragingSignalGet() [2/2]

bool CPT2026Instrument::ParmAveragingSignalGet ( sSignalAveraging< uParm > &  rSigAvg)

Definition at line 1095 of file PT2026.cpp.

◆ ParmAveragingSignalSet()

bool CPT2026Instrument::ParmAveragingSignalSet ( const sSignalAveraging< uParm > &  rSigAvg)

Definition at line 1069 of file PT2026.cpp.

◆ ParmComEthernetGet()

bool CPT2026Instrument::ParmComEthernetGet ( sEthernet rSettings)

Definition at line 2303 of file PT2026.cpp.

◆ ParmComEthernetSet()

bool CPT2026Instrument::ParmComEthernetSet ( const sEthernet rSettings)

Definition at line 2275 of file PT2026.cpp.

◆ ParmComUsbGet()

bool CPT2026Instrument::ParmComUsbGet ( bool &  rEnabled)

Definition at line 2248 of file PT2026.cpp.

◆ ParmComUsbSet()

bool CPT2026Instrument::ParmComUsbSet ( bool  Enabled)

Definition at line 2230 of file PT2026.cpp.

◆ ParmComVXI11Get()

bool CPT2026Instrument::ParmComVXI11Get ( bool &  rEnabled)

Definition at line 2437 of file PT2026.cpp.

◆ ParmComVXI11Set()

bool CPT2026Instrument::ParmComVXI11Set ( bool  Enabled)

Definition at line 2419 of file PT2026.cpp.

◆ ParmDigitizationGet() [1/2]

bool CPT2026Instrument::ParmDigitizationGet ( sDigitization< sBoundedParm > &  rDigitization)

Definition at line 1981 of file PT2026.cpp.

◆ ParmDigitizationGet() [2/2]

bool CPT2026Instrument::ParmDigitizationGet ( sDigitization< uParm > &  rDigitization)

Definition at line 1940 of file PT2026.cpp.

◆ ParmDigitizationSet()

bool CPT2026Instrument::ParmDigitizationSet ( const sDigitization< uParm > &  rDigitization)

Definition at line 1916 of file PT2026.cpp.

◆ ParmMatchingTuningGet() [1/2]

bool CPT2026Instrument::ParmMatchingTuningGet ( sMatchingTuning< sBoundedParm > &  rMatchingTuning)

Definition at line 2090 of file PT2026.cpp.

◆ ParmMatchingTuningGet() [2/2]

bool CPT2026Instrument::ParmMatchingTuningGet ( sMatchingTuning< uParm > &  rMatchingTuning)

Definition at line 2052 of file PT2026.cpp.

◆ ParmMatchingTuningSet()

bool CPT2026Instrument::ParmMatchingTuningSet ( const sMatchingTuning< uParm > &  rMatchingTuning)

Definition at line 2031 of file PT2026.cpp.

◆ ParmMeasureGet() [1/2]

bool CPT2026Instrument::ParmMeasureGet ( sMeasure< sBoundedParm > &  rMeasure)

Definition at line 986 of file PT2026.cpp.

◆ ParmMeasureGet() [2/2]

bool CPT2026Instrument::ParmMeasureGet ( sMeasure< uParm > &  rMeasure)

Definition at line 924 of file PT2026.cpp.

◆ ParmMeasureSet()

bool CPT2026Instrument::ParmMeasureSet ( const sMeasure< uParm > &  rMeasure)

Definition at line 895 of file PT2026.cpp.

◆ ParmRefClockGet()

bool CPT2026Instrument::ParmRefClockGet ( eReferenceClock rRefClock)

Definition at line 2204 of file PT2026.cpp.

◆ ParmRefClockSet()

bool CPT2026Instrument::ParmRefClockSet ( eReferenceClock  RefClock)

Definition at line 2183 of file PT2026.cpp.

◆ ParmRFPulseGet() [1/2]

bool CPT2026Instrument::ParmRFPulseGet ( sPulse< sBoundedParm > &  rPulse)

Definition at line 1872 of file PT2026.cpp.

◆ ParmRFPulseGet() [2/2]

bool CPT2026Instrument::ParmRFPulseGet ( sPulse< uParm > &  rPulse)

Definition at line 1834 of file PT2026.cpp.

◆ ParmRFPulseSet()

bool CPT2026Instrument::ParmRFPulseSet ( const sPulse< uParm > &  rPulse)

Definition at line 1811 of file PT2026.cpp.

◆ ParmSearchGet() [1/2]

bool CPT2026Instrument::ParmSearchGet ( sSearch< sBoundedParm > &  rSearch)

Definition at line 777 of file PT2026.cpp.

◆ ParmSearchGet() [2/2]

bool CPT2026Instrument::ParmSearchGet ( sSearch< uParm > &  rSearch)

Definition at line 728 of file PT2026.cpp.

◆ ParmSearchGetHallEnable()

bool CPT2026Instrument::ParmSearchGetHallEnable ( bool &  rEnabled)

Definition at line 870 of file PT2026.cpp.

◆ ParmSearchSet()

bool CPT2026Instrument::ParmSearchSet ( const sSearch< uParm > &  rSearch)

Configure the search operation, including detection level, frequency steps and the search bounds specified in the selected unit.

Definition at line 698 of file PT2026.cpp.

◆ ParmSearchSetHallEnable()

bool CPT2026Instrument::ParmSearchSetHallEnable ( bool  Enabled)

Allow the Hall probe to take control over the search range.

Definition at line 861 of file PT2026.cpp.

◆ ParmSearchSetLimits()

bool CPT2026Instrument::ParmSearchSetLimits ( F64  LowLimit_UNITS,
F64  HighLimit_UNITS 
)

Set the search bounds in the selected unit.

Definition at line 850 of file PT2026.cpp.

◆ ParmSearchSetManualValue()

bool CPT2026Instrument::ParmSearchSetManualValue ( F64  ManualValue_UNITS)

Ask the instrument to perform a measurement at fixed frequency. Automatic search mode is left.

Definition at line 841 of file PT2026.cpp.

◆ ParmTriggerInputGet() [1/2]

bool CPT2026Instrument::ParmTriggerInputGet ( sInputTrigger< sBoundedParm > &  rInputTrig)

Definition at line 1480 of file PT2026.cpp.

◆ ParmTriggerInputGet() [2/2]

bool CPT2026Instrument::ParmTriggerInputGet ( sInputTrigger< uParm > &  rInputTrig)

Definition at line 1427 of file PT2026.cpp.

◆ ParmTriggerInputSet()

bool CPT2026Instrument::ParmTriggerInputSet ( const sInputTrigger< uParm > &  rInputTrig)

Definition at line 1380 of file PT2026.cpp.

◆ ParmTriggerOutputGet() [1/2]

bool CPT2026Instrument::ParmTriggerOutputGet ( sOutputTrigger< sBoundedParm > &  rOutputTrig)

Definition at line 1707 of file PT2026.cpp.

◆ ParmTriggerOutputGet() [2/2]

bool CPT2026Instrument::ParmTriggerOutputGet ( sOutputTrigger< uParm > &  rOutputTrig)

Definition at line 1612 of file PT2026.cpp.

◆ ParmTriggerOutputSet()

bool CPT2026Instrument::ParmTriggerOutputSet ( const sOutputTrigger< uParm > &  rOutputTrig)

Definition at line 1539 of file PT2026.cpp.

◆ ParmUnitsGet()

bool CPT2026Instrument::ParmUnitsGet ( eUnits rUnits,
tPPMReference_UNITS rRef 
)

Definition at line 2152 of file PT2026.cpp.

◆ ParmUnitsSet()

bool CPT2026Instrument::ParmUnitsSet ( eUnits  Units)

Definition at line 2134 of file PT2026.cpp.

◆ ParmUnitsSetPPMRef()

bool CPT2026Instrument::ParmUnitsSetPPMRef ( tPPMReference_UNITS  Ref)

Definition at line 2143 of file PT2026.cpp.

◆ PowerOff()

bool CPT2026Instrument::PowerOff ( bool  Reboot = false)

Sending this command will shut the instrument down. Setting the reboot parameter to true will initiate a full shut-down and reboot of the instrument. Be careful, the link to the instrument is lost and must be re-acquired. It is a safe practice to release the instrument lock before performing to this operation.

Definition at line 3534 of file PT2026.cpp.

◆ ReadCaseTemperature()

bool CPT2026Instrument::ReadCaseTemperature ( F32 &  rTemperatureDegC)

Returns the internal instrument temperature. An internal survey will shut the instrument down if this value reaches a temperature that is factory set to prevent the system to fail. The probe temperature isn’t measured.

Definition at line 3551 of file PT2026.cpp.

◆ ReadDebugLog()

bool CPT2026Instrument::ReadDebugLog ( std::string &  rDebugLog)

Returns a long string containing all the operations that were processed before the last proper instrument shut down.

Definition at line 3578 of file PT2026.cpp.

◆ ReadFile()

bool CPT2026Instrument::ReadFile ( std::string  Path,
std::string &  rContent 
)

Definition at line 2517 of file PT2026.cpp.

◆ ReadFileDirectory()

bool CPT2026Instrument::ReadFileDirectory ( U32 &  rUsedBytes,
U32 &  rAvailableBytes,
tFileList rFileList 
)

Definition at line 2468 of file PT2026.cpp.

◆ ReadInformationDates()

bool CPT2026Instrument::ReadInformationDates ( std::string &  rSManufacturingDate,
std::time_t &  rManufacturingDate,
std::string &  rSCalibrationDate,
std::time_t &  rCalibrationDate 
)

Returns the manufacturing and calibration date in plain text or a number representing the amount of seconds since 00:00, Jan 1 1970 UTC.

Definition at line 3598 of file PT2026.cpp.

◆ RecallSettings()

bool CPT2026Instrument::RecallSettings ( std::string  Name)

Definition at line 2650 of file PT2026.cpp.

◆ Reset()

bool CPT2026Instrument::Reset ( )

Calling this method will wipe out all user parameters that are stored in the file system and revert them back to factory defaults.

Definition at line 3544 of file PT2026.cpp.

◆ SaveSettings()

bool CPT2026Instrument::SaveSettings ( eSettingType  Type,
std::string  Name 
)

Definition at line 2606 of file PT2026.cpp.

◆ SendBusTrigger()

bool CPT2026Instrument::SendBusTrigger ( )

Send a trigger to the instrument. If configured to react to this bus trigger, the acquisition sub system will collect a measurement and store it for future read out.

Definition at line 2691 of file PT2026.cpp.

◆ SetFormat()

bool CPT2026Instrument::SetFormat ( eCommunicationFormat  Format)

One can request the data in ASCII or binary format. The binary format, which needs extra operation to be decoded, are preferred as this format reduced the amount of data being sent on the communication link. Setting the format to either ASCII or binary won’t affect the results gathered using the MeasurementsGet accessors.

Definition at line 3163 of file PT2026.cpp.

◆ StandardStatusSetEnableRegister()

bool CPT2026Instrument::StandardStatusSetEnableRegister ( eStandardStatusRegister  Set,
U16  DisableMask,
U16  EnableMask 
)

Definition at line 3466 of file PT2026.cpp.

◆ StatusGet() [1/2]

bool CPT2026Instrument::StatusGet ( sStatusRegister  Reg,
U16 &  rStatus 
)

Definition at line 3196 of file PT2026.cpp.

◆ StatusGet() [2/2]

bool CPT2026Instrument::StatusGet ( std::vector< sStatusRegister Regs,
std::vector< U16 > &  rStatus 
)

Definition at line 3258 of file PT2026.cpp.

◆ StatusPreset()

bool CPT2026Instrument::StatusPreset ( )

Definition at line 3188 of file PT2026.cpp.

◆ StatusSetEnableRegister()

bool CPT2026Instrument::StatusSetEnableRegister ( eStatusRegisterSet  Set,
U16  DisableMask,
U16  EnableMask 
)

Definition at line 3332 of file PT2026.cpp.

◆ StatusSetTransitionFilter()

bool CPT2026Instrument::StatusSetTransitionFilter ( eStatusRegisterSet  Set,
eTransition  Transition,
U16  ClearMask,
U16  SetMask 
)

Definition at line 3387 of file PT2026.cpp.

◆ SwitchToDFUMode()

bool CPT2026Instrument::SwitchToDFUMode ( )

Restart the instrument in USB DFU mode, allowing the firmware to be upgraded.

Definition at line 3571 of file PT2026.cpp.

◆ UnlockInterface()

bool CPT2026Instrument::UnlockInterface ( )

Definition at line 332 of file PT2026.cpp.

◆ WriteCustomCommand()

bool CPT2026Instrument::WriteCustomCommand ( const std::string &  rWriteStr)

Definition at line 3792 of file PT2026.cpp.

◆ WriteFile()

bool CPT2026Instrument::WriteFile ( std::string  Path,
const std::string &  rContent 
)

Definition at line 2538 of file PT2026.cpp.


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