RTP Series API Programming Reference  1.2.1
Sensor Simulation

Typedefs

typedef enum PwrSnsrSignalUnits PwrSnsrSignalUnits
 
typedef enum PwrSnsrSimSignalType PwrSnsrSimSignalType
 
typedef enum PwrSnsrSimParamWeight PwrSnsrSimParamWeight
 

Enumerations

enum  PwrSnsrSignalUnits { PwrSnsrSignalUnitsdBm = 0, PwrSnsrSignalUnitsWatts = 1 }
 
enum  PwrSnsrSimSignalType { PwrSnsrSimSignalPeriodic = 0, PwrSnsrSimSignalBurst = 1 }
 
enum  PwrSnsrSimParamWeight { PwrSnsrWeightNone = 0, PwrSnsrWeightLight = 1, PwrSnsrWeightMedium = 2, PwrSnsrWeightHeavy = 3 }
 

Functions

EXPORT int PwrSnsr_OpenSimMeter (int NumChans, char *ResourceBuff, int ResourceBuffSize, SessionID *Vi)
 Open a simulated power meter session. More...
 
EXPORT int PwrSnsr_SetSimSignalAmplitude (SessionID Vi, const char *Channel, float Amplitude, PwrSnsrSignalUnits Units)
 Set the amplitude for the signal on a simulation channel. More...
 
EXPORT int PwrSnsr_GetSimSignalAmplitude (SessionID Vi, const char *Channel, float *Amplitude, PwrSnsrSignalUnits Units)
 Get the amplitude for the signal on a simulation channel. More...
 
EXPORT int PwrSnsr_SetSimSignalModulation (SessionID Vi, const char *Channel, PwrSnsrSimParamWeight Weight)
 Set the percent modulation for the signal on a simulation channel. More...
 
EXPORT int PwrSnsr_GetSimSignalModulation (SessionID Vi, const char *Channel, PwrSnsrSimParamWeight *Weight)
 Get the percent modulation for the signal on a simulation channel. More...
 
EXPORT int PwrSnsr_SetSimSignalCompression (SessionID Vi, const char *Channel, PwrSnsrSimParamWeight Weight)
 Set the percent compression for the signal on a simulation channel. More...
 
EXPORT int PwrSnsr_GetSimSignalCompression (SessionID Vi, const char *Channel, PwrSnsrSimParamWeight *Weight)
 Get the percent compression for the signal on a simulation channel. More...
 
EXPORT int PwrSnsr_SetSimSignalType (SessionID Vi, const char *Channel, PwrSnsrSimSignalType SignalType)
 Set the simulated channel signal type. More...
 
EXPORT int PwrSnsr_GetSimSignalType (SessionID Vi, const char *Channel, PwrSnsrSimSignalType *SignalType)
 Get the simulated channel signal type. More...
 
EXPORT int PwrSnsr_SetSimSignalPRF (SessionID Vi, const char *Channel, float PRF)
 Set the simulated signal PRF. Valid for Periodic and Burst. More...
 
EXPORT int PwrSnsr_GetSimSignalPRF (SessionID Vi, const char *Channel, float *PRF)
 Get the simulated signal PRF. Valid for Periodic and Burst. More...
 
EXPORT int PwrSnsr_SetSimSignalDuty (SessionID Vi, const char *Channel, float Duty)
 Set the simulated signal duty cycle in percent. Affects Periodic only. More...
 
EXPORT int PwrSnsr_GetSimSignalDuty (SessionID Vi, const char *Channel, float *Duty)
 Get the simulated signal duty cycle in percent. Affects Periodic only. More...
 

Detailed Description

Sensor simulation functions

Typedef Documentation

◆ PwrSnsrSignalUnits

Unit selector for watts or dBm.

◆ PwrSnsrSimParamWeight

Simulated signal parameter setting weight.

◆ PwrSnsrSimSignalType

Simulated signal type.

Enumeration Type Documentation

◆ PwrSnsrSignalUnits

Unit selector for watts or dBm.

Enumerator
PwrSnsrSignalUnitsdBm 

dBm.

PwrSnsrSignalUnitsWatts 

Watts.

◆ PwrSnsrSimParamWeight

Simulated signal parameter setting weight.

Enumerator
PwrSnsrWeightNone 

Setting is off.

PwrSnsrWeightLight 

Setting is lightly applied.

PwrSnsrWeightMedium 

Setting is moderately applied.

PwrSnsrWeightHeavy 

Setting is heavily applied.

◆ PwrSnsrSimSignalType

Simulated signal type.

Enumerator
PwrSnsrSimSignalPeriodic 

Periodic waveform defined by PRF and duty cycle.

PwrSnsrSimSignalBurst 

IFF-like burst signal.

Function Documentation

◆ PwrSnsr_GetSimSignalAmplitude()

EXPORT int PwrSnsr_GetSimSignalAmplitude ( SessionID  Vi,
const char *  Channel,
float *  Amplitude,
PwrSnsrSignalUnits  Units 
)

Get the amplitude for the signal on a simulation channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
AmplitudeThe simulated signal level (return value).
UnitsUnits of amplitude in dBm or Watts
Returns
Success (0) or error code.

◆ PwrSnsr_GetSimSignalCompression()

EXPORT int PwrSnsr_GetSimSignalCompression ( SessionID  Vi,
const char *  Channel,
PwrSnsrSimParamWeight Weight 
)

Get the percent compression for the signal on a simulation channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
WeightThe relative compression setting (return value).
Returns
Success (0) or error code.

◆ PwrSnsr_GetSimSignalDuty()

EXPORT int PwrSnsr_GetSimSignalDuty ( SessionID  Vi,
const char *  Channel,
float *  Duty 
)

Get the simulated signal duty cycle in percent. Affects Periodic only.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
DutyDuty cycle in percent (return value).
Returns
Success (0) or error code.

◆ PwrSnsr_GetSimSignalModulation()

EXPORT int PwrSnsr_GetSimSignalModulation ( SessionID  Vi,
const char *  Channel,
PwrSnsrSimParamWeight Weight 
)

Get the percent modulation for the signal on a simulation channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
WeightThe relative modulation setting (return value).
Returns
Success (0) or error code.

◆ PwrSnsr_GetSimSignalPRF()

EXPORT int PwrSnsr_GetSimSignalPRF ( SessionID  Vi,
const char *  Channel,
float *  PRF 
)

Get the simulated signal PRF. Valid for Periodic and Burst.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
PRFPulse repetition frequency in Hz (return value).
Returns
Success (0) or error code.

◆ PwrSnsr_GetSimSignalType()

EXPORT int PwrSnsr_GetSimSignalType ( SessionID  Vi,
const char *  Channel,
PwrSnsrSimSignalType SignalType 
)

Get the simulated channel signal type.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
SignalTypeThe simulated signal type (return value).
Returns
Success (0) or error code.

◆ PwrSnsr_OpenSimMeter()

EXPORT int PwrSnsr_OpenSimMeter ( int  NumChans,
char *  ResourceBuff,
int  ResourceBuffSize,
SessionID Vi 
)

Open a simulated power meter session.

Parameters
NumChansNumber of channels
ResourceBuffBuffer to read back the session name, can be NULL
ResourceBuffSizesize of ResourceBuff in characters
ViSessionID handle (out parameter)
Returns
Success (0) or error code.

◆ PwrSnsr_SetSimSignalAmplitude()

EXPORT int PwrSnsr_SetSimSignalAmplitude ( SessionID  Vi,
const char *  Channel,
float  Amplitude,
PwrSnsrSignalUnits  Units 
)

Set the amplitude for the signal on a simulation channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
AmplitudeThe simulated signal level
UnitsUnits of amplitude in dBm or Watts
Returns
Success (0) or error code.

◆ PwrSnsr_SetSimSignalCompression()

EXPORT int PwrSnsr_SetSimSignalCompression ( SessionID  Vi,
const char *  Channel,
PwrSnsrSimParamWeight  Weight 
)

Set the percent compression for the signal on a simulation channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
WeightThe relative compression setting.
Returns
Success (0) or error code.

◆ PwrSnsr_SetSimSignalDuty()

EXPORT int PwrSnsr_SetSimSignalDuty ( SessionID  Vi,
const char *  Channel,
float  Duty 
)

Set the simulated signal duty cycle in percent. Affects Periodic only.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
DutyDuty cycle in percent ( < 99.0).
Returns
Success (0) or error code.

◆ PwrSnsr_SetSimSignalModulation()

EXPORT int PwrSnsr_SetSimSignalModulation ( SessionID  Vi,
const char *  Channel,
PwrSnsrSimParamWeight  Weight 
)

Set the percent modulation for the signal on a simulation channel.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
WeightThe relative modulation setting.
Returns
Success (0) or error code.

◆ PwrSnsr_SetSimSignalPRF()

EXPORT int PwrSnsr_SetSimSignalPRF ( SessionID  Vi,
const char *  Channel,
float  PRF 
)

Set the simulated signal PRF. Valid for Periodic and Burst.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
PRFPulse repetition frequency in Hz.
Returns
Success (0) or error code.

◆ PwrSnsr_SetSimSignalType()

EXPORT int PwrSnsr_SetSimSignalType ( SessionID  Vi,
const char *  Channel,
PwrSnsrSimSignalType  SignalType 
)

Set the simulated channel signal type.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_OpenSimMeter function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
SignalTypeThe simulated signal type.
Returns
Success (0) or error code.