JSRDotNETSDK Reference

# JSRDotNETManager Properties

JSRDotNETManager Class See Also

The following tables list the members exposed by the JSRDotNETManager type.

Properties

| Name | Description
--- | --- | ---
| ArePluginsAvailable | Gets a value indicating whether we are plugins available.
| DampingIndex | Gets or sets the zero-based index of the pulser damping. The actual damping value corresponding to the available indices can be read from the DampingValues array.
| DampingIndexMax | Gets the damping index maximum.
| DampingIndexSupported | Gets a value indicating whether the damping index property is supported.
| DampingValues | Gets the damping values in Ohms.
| EnergyPerPulse | Gets the energy per pulse in Joules. This property is simply the amount of energy stored in the pulser's capacitor which is used to create the outgoing pulse. Not all of these energy is necessarily delivered to the pulser, since there may be some losses.
| Gain | Gets or sets the gain in dB. Chooses the closest legal gain value.
| GainIndex | Gets or sets the zero-based gain index. To find the value, see GainValues property. This property will only have an effect if GainIndexPropertySupported is true for this particular model of instrument. Otherwise, use the Gain property to get or set the gain.
| GainIndexMax | Gets the gain index maximum.
| GainIndexSupported | Gets a value indicating whether the gain index property is enabled. For receivers which have only a few possible values of gain, this alternative method for setting gain can be used to select the gain from the GainValues array. Some instruments do not allow this method because they support a range of closely spaced gain values which makes the list of allowed gains less useful.
| GainMax | Gets the gain maximum in dB.
| GainMin | Gets the gain minimum in dB.
| GainStepSize | Gets the size of the gain step. For example if the gain step size is 0.5, and the GainMin is - 22.0 dB, then the next valid gain value is -21.5 dB. This property only has a meaningful value if GainStepSizeSupported is true.
| GainStepSizeSupported | Gets a value indicating whether the gain step size is supported by a receiver. If an instrument does not have regular increments between min and max gain, then this property indicates that the GainStepSize property should be ignored.
| GainSupported | Gets a value indicating whether the gain supported. (inherited from PulserReceiverBase).
| GainValues | Gets an array of gain values in dB corresponding to the GainIndex property. This property will only have values if the GainIndexSupported property is true.
| HVMeasurement | Returns current floating point voltages of HV Supply in Volts. Only accurate to nearest 1/10th of a volt. Not all instruments support this property.
| HVMeasurementSupported | Returns True if HVMeasurement property is supported.
| HVSupply | Gets or sets the voltage of the pulser high voltage supply.
| HVSupplyEnable | Gets or sets a value indicating whether this Pulser's High Voltage power supply is enabled. Only some instruments have this capability.
| HVSupplyEnableSupported | Gets a value indicating whether the hv supply enable supported.
| HVSupplyIndex | Gets or sets the zero-based index of the pulser volts, if this property is available for this pulser receiver.
| HVSupplyIndexMax | Gets the pulser volts index maximum value. If the HVSupplyIndex property is not available in this pulser receiver, zero will be returned. The number of available pulser voltages is this value minus one.
| HVSupplyIndexSupported | Gets a value indicating whether the high voltage value can be selected by index;
| HVSupplyMax | Gets the pulser high voltage supply maximum voltage.
| HVSupplyMin | Gets the pulser high voltage supply minimum voltage.
| HVSupplySupported | Gets a value indicating whether the pulser HVSupply property is enabled.
| HVSupplyValues | Gets the voltages which can be selected by HVSupplyIndex property. If this property is not supported for this pulser receiver, this is an array of zero elements.
| HasManualControls | Gets a value indicating whether this object has physical controls.
| HighPassFilterIndex | Gets or sets the zero-based index of the high pass filter.
| HighPassFilterIndexMax | The maximum allowed index for the low pass filter selection. The number of low pass filter selections is equal to this plus one.
| HighPassFilterIndexSupported | Gets a value indicating whether the high pass filter index supported. (inherited from PulserReceiverBase).
| HighPassFilterValues | Gets the high pass cutoff frequencies in MHz for each possible index.
| Id | Gets the identification object of the pulser receiver.
| Info | Gets the hardware and or connection information for this pulser receiver and the instrument.
| IsPulserPresent | Returns true if a pulser is attached to this PulserReceiver.
| IsPulserPresentSupported | Returns true if IsPulserPresent property is supported
| IsPulserReceiverSelected | True if a pulser receiver is selected.
| LEDBlinkModeIndex | Gets or sets the zero-based index of the LED blink mode.
| LEDBlinkModeIndexMax | Gets the LED blink mode index maximum. The number of possible LED blink modes is this minus one.
| LEDBlinkModeIndexSupported | Gets a value indicating whether the LED blink mode index property is enabled.
| LEDBlinkModeValues | Gets the names of all the possible LED blink modes available by setting the LEDBlinkModeIndex property.
| LastExceptionContextMessage | If LastExceptionOrNull is not null, this property should give a brief message indicating where the exception was intercepted.
| LastExceptionOrNull | If an exception occurs, an notification event with NotifyType=ERROR should be sent. However, it could be possible that the notification thread is interrupted by the exception and the notification cannot be sent. If an exception occurs, a reference to it will be available via this property, or it will be null if no such exception occurred.
| LowPassFilterIndex | Gets or sets the zero-based index of the current selected low pass filter selection.
| LowPassFilterIndexMax | The maximum allowed index for the low pass filter selection. The number of low pass filter selections is equal to this plus one.
| LowPassFilterIndexSupported | Gets a value indicating whether the low pass filter index supported. (inherited from PulserReceiverBase).
| LowPassFilterValues | Gets the low pass cutoff frequencies in MHz for each possible index.
| ManagerState | Gets or sets the state of the manager.
| MaxFrequency | Gets the the base receiver max frequency in Mhz. This a fixed characteristic of the receiver hardware and does not change when the low pass or high pass filter settings are changed.
| PluginPath | Gets or sets the full pathname where the plugins are located.
| PluginsLoaded | Gets whether or not the plugins have been loaded.
| PulseEnergyIndex | Gets or sets the zero-based index of the pulse energy selection.
| PulseEnergyIndexMax | Gets the pulse energy index maximum.
| PulseEnergyIndexSupported | Gets a value indicating whether the pulser energy index property is enabled.
| PulseEnergyValueNames | Gets a list of names of the available pulse energy values.
| PulseRepetitionFrequency | Gets or sets the pulse repetition frequency if an internal trigger is available in this pulser receiver. If the specified frequency is not attainable, the closest attainable frequency will be chosen. After setting this property, the property can be read to determine the frequency actually attained.
| PulseRepetitionFrequencyIndex | Gets or sets the zero-based index of the internally generated pulse repetition frequency if the TriggerSource property is set to Internal. See the PulserRepetitionFreqValues property for the list of actually attainable frequencies.
| PulseRepetitionFrequencyIndexMax | The maximum number allowed for the PulseRepetitionFrequencyIndex property, or zero if this property cannot be used with this pulser receiver.
| PulseRepetitionFrequencyIndexSupported | Gets a value indicating whether the pulser repetition frequency index property can be used on this pulser receiver.
| PulseRepetitionFrequencyMax | Gets the maximum possible pulse repetition frequency maximum in Hz.
| PulseRepetitionFrequencyMin | Gets the minimum possible pulse repetition frequency maximum in Hz.
| PulseRepetitionFrequencyNumerator | For pulsers which support the direct setting of the PulseRepetitionFrequency, this property may indicate the numerator used to calculate the actual attainable PRF values. For example, the DPR500 pulsers use a numerator of 12,000,000. The actual attainable PRF values are 12,000,000 / n, where n is an integer. The allow range of n would be indicated by the Min and Max for the PRF. If the min PRF is 184 Hz, and the max is 20,000 Hz, then n could be in the range 12,000,000 / 20,000 = 600 to 12,000,000 / 184 = 65,217. For instruments like the DPR300, which do not support the direct setting of the PRF value, this numerator will return the illegal value of 0. For the DPR300, the index method is used to set PRF.
| PulseRepetitionFrequencySupported | Gets a value indicating whether the pulse repetition frequency supported. (inherited from PulserReceiverBase).
| PulseRepetitionFrequencyValues | Gets an array of attainable PRF values if this pulser receiver supports the PulseRepetionFrequencyIndex property.
| PulserEnergyCapacitorValues | Returns a list of pulser energy capacitor values in micro-farads.
| PulserEnergyCapacitorValuesSupported | Returns true if the PulserEnergyCapacitorValues property is supported.
| PulserFirmwareVer | Gets the Pulser Firmware Version string
| PulserFirmwareVerSupported | Gets a value which indicates if the PulserFirmwareVer property is supported
| PulserHWRev | Gets the Pulser Hardware Revision String
| PulserHWRevSupported | Gets a value which indicates if the PulserHWRev property is supported
| PulserImpedance | Gets or sets the pulser output impedance.
| PulserImpedanceSupported | Gets a value indicating whether the PulserImpedance property is supported.
| PulserIsPulsing | Gets a value indicating whether the pulser is currently being triggered. Some instruments do not have the ability to detect this when using an external trigger. When such instruments are set to external trigger, a value of UNKNOWN will be returned.
| PulserMaxPRFs | Returns an array of max PRF frequencies in Hz, one for each energy setting of the pulser.
| PulserMaxPRFsSupported | Returns true if the PulserMaxPRFs property is supported.
| PulserModelName | Gets the Pulser Model name string
| PulserModelNameSupported | Gets a value which indicates if the PulserModelName property is supported
| PulserOEMData | Gets or sets the OEM Data for a pulser. OEM data is a byte array of exactly 8 bytes. It is stored in EEPROM and will be preserved when unit is powered down. It will remain set until overwritten with something else. This data is not used by the product's firmware, it is meant as a convenience for developers who may wish to authenticate the identity of this particular unit.
| PulserOEMDataSupported | Gets a bool value which indicates if the OEMValue property is supported
| PulserPowerLimitStatus | Gets the current pulser power limit status. Some pulsers can be damaged or suffer a reduction in performance when the combination pulser voltage and pulse repetition frequency is too high. This property returns an integer based on the current settings of the instrument. Some instruments cannot detect the pulse repetition frequency when an external trigger source is used. In this case, this property will return UNKNOWN.
| PulserSerialNum | Gets the Pulser serial num if supported
| PulserSerialNumSupported | Returns true if PulserSerialNum property is supported.
| PulserSettings | Returns a collection of PulserSettingInfo structures. Each PulserSettingInfo object in the collection corresponds to a setting such as Gain, TriggerEnable, or LowPassFilter, etc. Note that a PulserSettingInfo object describes a setting, which in turn is usually implemented as a number of properties. For example, the setting 'LowPassFilter' is implemented in pulser objects as LowPassFilterIndex, LowPassFilterIndexMax, and LowPassFilterValues. The PulserSettingInfo object returns information about the LowPassFilter setting in general, and information about the three actual properties can be discovered from that PulserSettingInfo object. Note that in addition to the standard properties always implemented in the IPulserReceiver interface, there may be additional settings such as custom features. For example, the PulserReceiver_DPR object implements IPulserReceiver. But in addition, there is an additional read-only setting called IsPulserPresent, because the DPR500 is unique in that the instrument can still be connected while one of its remote pulsers is disconnected. Thus, even though the property IsPulserPresent is not in the IPulserReceiver interface, application software can still read the value of this by calling the GetPropertyValue() method on the PulserSettingInfo object, or by using the GetPulserPropertyValue() method of the IPulserReceiver while using the appropriate setting name and role.
| PulserTriggerCount | Gets the accumulated trigger count since the device was power cycled.
| PulserTriggerCountSupported | Gets a value indicating whether the PulserTriggerCount property is supported.
| PulserTriggerSourceIndex | Gets or sets the zero-based index of the trigger source selection.
| PulserTriggerSourceIndexMax | Gets the pulser trigger source index maximum.
| PulserTriggerSourceValueNames | Gets a list of names of the available pulse energy values.
| ReceiverFirmwareVer | Gets the Receiver Firmware Version string
| ReceiverFirmwareVerSupported | Gets a value which indicates if the ReceiverFirmwareVer property is supported
| ReceiverHWRev | Gets the Receiver Hardware Revision string
| ReceiverHWRevSupported | Gets a value which indicates if the ReceiverHWRev property is supported
| ReceiverMode | Gets or sets or the receiver signal input mode.
| ReceiverModeBothSupported | Gets a value indicating whether the signal select both mode supported.
| ReceiverModeEchoSupported | Gets a value indicating whether the signal select echo mode supported.
| ReceiverModeThruSupported | Gets a value indicating whether the signal select thru mode supported.
| ReceiverModelName | Receiver Model name string
| ReceiverModelNameSupported | Gets a value which indicates if the ReceiverModelName property is supported.
| ReceiverOEMData | Gets or sets the OEM Data for a unit. OEM data is a byte array of exactly 8 bytes. It is stored in EEPROM and will be preserved if unit is powered down. It will remain set until overwritten with something else. This data is not used by the product's firmware, it is meant as a convenience for developers who may wish to authenticate the identity of this particular unit.
| ReceiverOEMDataSupported | Gets a bool value which indicates if the OEMValue property is supported
| ReceiverSerialNum | Gets the Receiver serial num if supported
| ReceiverSerialNumSupported | Returns true if ReceiverSerialNum property is supported.
| ReceiverSupplyVoltages | Gets the supply voltages.
| ReceiverSupplyVoltagesSupported | Gets if the supply voltage property is supported.
| State | Gets the present state of this pulser/receiver instance. (inherited from PulserReceiverBase).
| StatusChangePropertyCriteria | Gets or sets the status change property filter. If this property is never set, it remains its default value, null. If the filter is null, then all property changes will generate change events. If not null, then only properties which are included in the filter will generate property change events.
| TriggerEdgePolarity | The trigger fires on rising or falling edge.
| TriggerEdgePolaritySupported | Gets a value indicating whether the trigger edge polarity property is enabled.
| TriggerEnable | Gets or sets the trigger enable. Note: The DPR300 may report this property incorrectly if this property has not been written to since the last time the instrument was power cycled.
| TriggerImpedance | Gets or sets the trigger impedance.
| TriggerImpedanceSupported | Gets a value indicating whether the TriggerImpedance property is supported.
| TriggerSource | Gets or sets the trigger source.
| TriggerSourceExternalSupported | Gets a value indicating whether the external trigger is supported on this instrument.
| TriggerSourceInternalSupported | Gets a value indicating whether the internal triggers are supported on this instrument.
| TriggerSourceSlaveSupported | Gets a value indicating whether the trigger source slave mode is supported.
| UnitModelName | Gets or sets the model name for a unit. Setting this property will fail unless unit is in factory mode.
| UnitModelNameSupported | Gets a bool value which indicates if the UnitModelName propery is supported
| UnitSerialNum | Gets or sets the serial number for a unit. Setting the serial number will fail unless unit is in factory mode.
| UnitSerialNumSupported | Gets a bool value which indicates if the UnitSerialNum propery is supported

Top
See Also

#### Reference

JSRDotNETManager Class
JSRDotNETSDK Namespace
IPulserReceiver
JsrPluginHelper