![]() |
G5.Api 1.22.0.121
.Net API to control Regatron G5 devices
|
Public Member Functions | |
| FunctionGeneratorControlMode | GetControlMode () |
| void | SetControlMode (FunctionGeneratorControlMode controlMode) |
| FunctionGeneratorFunctionType | GetBaseFunction () |
| void | SetBaseFunction (FunctionGeneratorFunctionType functionType) |
| void | EnableManualScaling () |
| void | DisableManualScaling () |
| bool | IsManualScalingEnabled () |
| Single | GetRampTime () |
| void | SetRampTime (Single rampTime) |
| UInt32 | GetBaseFunctionRepetitions () |
| void | SetBaseFunctionRepetitions (UInt32 repeats) |
| Single | GetPeakValue () |
| void | SetPeakValue (Single value) |
| Single | GetOffset () |
| void | SetOffset (Single offset) |
| Single | GetFrequency () |
| void | SetFrequency (Single frequency) |
| Single | GetSymmetry () |
| void | SetSymmetry (Single symmetry) |
| void | EnableAapInputFilter () |
| void | DisableAapInputFilter () |
| Boolean | IsAapInputFilterEnabled () |
| Single | GetAapInputFilterCutOffFrequency () |
| void | SetAapInputFilterCutOffFrequency (Single frequency) |
| Single | GetAapInputScale () |
| void | SetAapInputScale (Single scale) |
| void | EnableExponentialEnvelope () |
| void | DisableExponentialEnvelope () |
| Boolean | IsExponentialEnvelopeEnabled () |
| Single | GetExponentialEnvelopeTimeConstant () |
| void | SetExponentialEnvelopeTimeConstant (Single time) |
| FunctionGeneratorPhysicalQuantity | GetAapPhysicalQuantityInput () |
| void | SetAapPhysicalQuantityInput (FunctionGeneratorPhysicalQuantity physicalQuantityInput) |
| UInt32 | GetNumberOfFunctionPoints () |
| IList< Tuple< Single, Single > > | GetFunctionPoints () |
| Get the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation. | |
| Point[] | GetFunctionPointsArray () |
| Get the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation. This method is only intended for use when no generics are supported by the actual environment. In all other cases GetFunctionPoints should be used. | |
| void | SetFunctionPoints (IList< Tuple< Single, Single > > points) |
| Set the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation. | |
| void | SetFunctionPointsArray (Point[] points) |
| Set the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation. This method is only intended for use when no generics are supported by the actual environment. In all other cases SetFunctionPoints should be used. | |
| void | RemoveAllFunctionPoints () |
| UInt32 | GetMaximalNumberOfFunctionPoints () |
| void | EnableFrequencySweep () |
| Enables the frequency sweep. | |
| void | DisableFrequencySweep () |
| Disables the frequency sweep. | |
| Boolean | IsFrequencySweepEnabled () |
| Checks if the frequency sweep is enabled. | |
| void | SetFrequencySweepParameters (FrequencySweepParameters frequencySweepParameters) |
| Configures a frequency sweep on the connected device. The DwellMode will be set to TimePerPoint. | |
| FrequencySweepParameters | GetFrequencySweepParameters () |
| Get the actual parameter set of the configured frequency sweep on the connected device. | |
| void | SetLinearFrequencySweepConfiguration (SteadyFrequencySweepConfiguration steadyFrequencySweepConfiguration) |
| Configures a frequency sweep on the connected device. The SweepMode will be set to Linear. | |
| void | SetLinearStepFrequencySweepConfiguration (TimeStepFrequencySweepConfiguration timeStepFrequencySweepConfiguration) |
| Configures a frequency sweep on the connected device. The SweepMode will be set to LinearStep. The DwellMode will be set to TimePerPoint. | |
| void | SetLinearStepFrequencySweepConfiguration (PeriodsStepFrequencySweepConfiguration periodsStepFrequencySweepConfiguration) |
| Configures a frequency sweep on the connected device. The SweepMode will be set to LinearStep. The DwellMode will be set to PeriodsPerPoint. | |
| void | SetExponentialFrequencySweepConfiguration (SteadyFrequencySweepConfiguration steadyFrequencySweepConfiguration) |
| Configures a frequency sweep on the connected device. The SweepMode will be set to Exponential. | |
| void | SetExponentialStepFrequencySweepConfiguration (TimeStepFrequencySweepConfiguration timeStepFrequencySweepConfiguration) |
| Configures a frequency sweep on the connected device. The SweepMode will be set to ExponentialStep. The DwellMode will be set to TimePerPoint. | |
| void | SetExponentialStepFrequencySweepConfiguration (PeriodsStepFrequencySweepConfiguration periodsStepFrequencySweepConfiguration) |
| Configures a frequency sweep on the connected device. The SweepMode will be set to ExponentialStep. The DwellMode will be set to PeriodsPerPoint. | |
| FrequencySweepConfiguration | GetFrequencySweepConfiguration () |
| Get the actual configuration of the frequency sweep on the connected device. | |
| void | EnablePeakSweep () |
| Enables the peak sweep. | |
| void | DisablePeakSweep () |
| Disables the peak sweep. | |
| Boolean | IsPeakSweepEnabled () |
| Checks if the peak sweep is enabled. | |
| void | SetPeakSweepParameters (PeakSweepParameters peakSweepParameters) |
| Configures a peak sweep on the connected device. The DwellMode is automatically set to TimePerPoint. | |
| PeakSweepParameters | GetPeakSweepParameters () |
| Get the actual parameter set of the configured peak sweep on the connected device. | |
| void | SetLinearPeakSweepConfiguration (SteadyPeakSweepConfiguration steadyPeakSweepConfiguration) |
| Configures a peak sweep on the connected device. The SweepMode will be set to Linear. | |
| void | SetLinearStepPeakSweepConfiguration (TimeStepPeakSweepConfiguration timeStepPeakSweepConfiguration) |
| Configures a peak sweep on the connected device. The SweepMode will be set to LinearStep. | |
| void | SetExponentialPeakSweepConfiguration (SteadyPeakSweepConfiguration steadyPeakSweepConfiguration) |
| Configures a peak sweep on the connected device. The SweepMode will be set to Exponential. | |
| void | SetExponentialStepPeakSweepConfiguration (TimeStepPeakSweepConfiguration timeStepPeakSweepConfiguration) |
| Configures a peak sweep on the connected device. The SweepMode will be set to ExponentialStep. | |
| PeakSweepConfiguration | GetPeakSweepConfiguration () |
| Get the actual configuration of the peak sweep on the connected device. | |
| Single | CalculateBlockTime () |
| Calculate the block time depending on the peak and/or frequency sweep times of the enabled sweeps. If no sweep is enabled, the block time remains unchanged. | |
|
inline |
Calculate the block time depending on the peak and/or frequency sweep times of the enabled sweeps. If no sweep is enabled, the block time remains unchanged.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Disables the frequency sweep.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Disables the peak sweep.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Enables the frequency sweep.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Enables the peak sweep.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Get the actual configuration of the frequency sweep on the connected device.
| G5ApiException |
|
inline |
Get the actual parameter set of the configured frequency sweep on the connected device.
| G5ApiException |
|
inline |
Get the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation.
| G5ApiException |
|
inline |
Get the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation. This method is only intended for use when no generics are supported by the actual environment. In all other cases GetFunctionPoints should be used.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Get the actual configuration of the peak sweep on the connected device.
| G5ApiException |
|
inline |
Get the actual parameter set of the configured peak sweep on the connected device.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Checks if the frequency sweep is enabled.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
Checks if the peak sweep is enabled.
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| frequency |
| G5ApiException |
|
inline |
| scale |
| G5ApiException |
|
inline |
| physicalQuantityInput |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| G5ApiException |
|
inline |
| controlMode |
| G5ApiException |
|
inline |
| time |
| G5ApiException |
|
inline |
Configures a frequency sweep on the connected device. The SweepMode will be set to Exponential.
| steadyFrequencySweepConfiguration | Steady frequency sweep configuration |
| G5ApiException |
|
inline |
Configures a peak sweep on the connected device. The SweepMode will be set to Exponential.
| steadyPeakSweepConfiguration | Steady peak sweep configuration |
| G5ApiException |
|
inline |
Configures a frequency sweep on the connected device. The SweepMode will be set to ExponentialStep. The DwellMode will be set to PeriodsPerPoint.
| periodsStepFrequencySweepConfiguration | Periods step frequency sweep configuration |
| G5ApiException |
|
inline |
Configures a frequency sweep on the connected device. The SweepMode will be set to ExponentialStep. The DwellMode will be set to TimePerPoint.
| timeStepFrequencySweepConfiguration | Time step frequency sweep configuration |
| G5ApiException |
|
inline |
Configures a peak sweep on the connected device. The SweepMode will be set to ExponentialStep.
| timeStepPeakSweepConfiguration | Time step peak sweep configuration |
| G5ApiException |
|
inline |
| frequency |
| G5ApiException |
|
inline |
Configures a frequency sweep on the connected device. The DwellMode will be set to TimePerPoint.
| frequencySweepParameters | Frequency sweep parameter set |
| G5ApiException |
|
inline |
Set the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation.
| points | Points to be set. |
| G5ApiException |
|
inline |
Set the user defined points of the function generator for UserDefined, Aap or SolarArraySimulation. This method is only intended for use when no generics are supported by the actual environment. In all other cases SetFunctionPoints should be used.
| points | Points to be set. |
| G5ApiException |
|
inline |
Configures a frequency sweep on the connected device. The SweepMode will be set to Linear.
| steadyFrequencySweepConfiguration | Steady frequency sweep configuration |
| G5ApiException |
|
inline |
Configures a peak sweep on the connected device. The SweepMode will be set to Linear.
| steadyPeakSweepConfiguration | Steady peak sweep configuration |
| G5ApiException |
|
inline |
Configures a frequency sweep on the connected device. The SweepMode will be set to LinearStep. The DwellMode will be set to PeriodsPerPoint.
| periodsStepFrequencySweepConfiguration | Periods step frequency sweep configuration |
| G5ApiException |
|
inline |
Configures a frequency sweep on the connected device. The SweepMode will be set to LinearStep. The DwellMode will be set to TimePerPoint.
| timeStepFrequencySweepConfiguration | Time step frequency sweep configuration |
| G5ApiException |
|
inline |
Configures a peak sweep on the connected device. The SweepMode will be set to LinearStep.
| timeStepPeakSweepConfiguration | Time step peak sweep configuration |
| G5ApiException |
|
inline |
| offset |
| G5ApiException |
|
inline |
Configures a peak sweep on the connected device. The DwellMode is automatically set to TimePerPoint.
| peakSweepParameters | Peak sweep parameter set |
| G5ApiException |
|
inline |
| value |
| G5ApiException |
|
inline |
| rampTime |
| G5ApiException |
|
inline |
| symmetry | Value in percent (0 to 100) |
| ArgumentOutOfRangeException | |
| G5ApiException |