JSRDotNETSDK Reference

# PulserPropertyRole Enumeration

See Also

A JSRDotNET Property consists of a group of .NET properties in IPulserReceiver. This enum specifies which role one specific .NET property has. For example, one of the properties in IPulserReceiver associated with Gain, is the boolean property 'GainIndexSupported'. Thus the role of that .NET property is INDEXSUPPORTED.

Namespace: JSRDotNETSDK
Assembly: JSRDotNETSDK (in JSRDotNETSDK.dll)
Members

| Member name | Description
--- | --- | ---
| DIRECT | This Property is for directly setting or getting the value, such as pulser.Gain = 10.0;
| DIRECTSUPPORTED | This property's direct mode property is supported. If false, then the indexed mode must be used.
| SPECIFICVALUESUPPORTED | Some properties such as ReceiverMode can have several integer values, 0, 1 or 2, which correspond to Echo, Thru or Slave mode. However not all Receivers support all three modes. To determine if ReceiverMode supports Echo mode, the property ReceiverModeEchoSupported is implemented. This property indicates whether a specific value of a ReceiverMode property is supported.
| DIRECTVALUES | If the Direct value expects a list of possible values that are set directly, then this property will be provided to include a list of key value pairs corresponding to the value and a display string for each value that is supported.
| STEPSIZE | If a setting supports direct setting, such as gain, it may be true that the actual attainable values may have a constant amount of db between them. For example, if the pulser.GainMin == -10.0, the attainable gain values may be -10.0, -9.5, -9.0, -8.5, ... In this case, if the application sets the gain to -9.7, the receiver would actually set the gain to the closest available, or -9.5. This property indicates that the actual value increment. Not all settings would have an even stepsize, such as the PulseRepetitionFrequency.
| STEPSIZESUPPORTED | Indicates the stepsize between actual setting values is fixed, and that the stepsize property is meaningful.
| INDEX | In settings that are read and written by modifying an integer index, settings that support index mode are read and modified using this property. For example, as an alternative to setting the gain directly, the property with the Index role can set the gain by index such as, pulser.GainIndex = 0; This should be equivalent to pulser.Gain = pulser.GainMin; Settings can support the index method and the direct method, but many support only one or the other.
| INDEXMAX | This property role indicates the maximum legal value of the index for this setting.
| INDEXSUPPORTED | This property role indicates if the index mode for this property is supported.
| MAX | This property role indicates the maximum legal value for this setting
| MIN | This property role indicates the minimum legal value for this setting
| INDEXVALUES | For properties that support the index this is an array containing the actual values of the setting for all the indices. For example, pulser.GainValues is a read-only array of doubles. pulser.GainValues[0] == -10.0, pulser.GainValues[1] == -9.5; etc.
| NUMERATOR | For the PulseRepetitionFrequency setting, the actual attainable values are sometimes calculated using a formula of something like 12,000,000 / n. So if the value of n is 12,000, that would correspond to a frequency of 1000 Hz. The value of this property would be the numerator used, which in the example above would be 12,000,000.
| OTHER | Used for roles that don't fit into any of the other categories.

See Also

#### Reference

JSRDotNETSDK Namespace