JSRDotNETSDK Reference

# PulserSettingInfo Members

PulserSettingInfo Class Methods Properties See Also

A pulser receiver has settings such as Gain, TriggerEnable and so on. The IPulserReceiver Interface implements these settings via sets of properties such as Gain, GainMax, GainMin, GainIndex etc. This class describes the setting, with information about which roles are present for that setting.

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

Properties

| Name | Description
--- | --- | ---
| AccessType | Some settings like TriggerEnable are always accessed directly, such as pulser.TriggerEnable = true; Others, maybe accessed as an index, such as LowPassFilterIndex=0; This property indicates whether the setting can be accessed directly or by index or both.
| AttributeFlags | Gets the attribute flags for the setting. The bit definitions can be found in the SettingAttributes class.
| DataType | Gets the data type of the setting. Note this is for the setting. For example, even though the GainIndex property is an integer, the setting itself has the type of double.
| DirectValue | Gets or sets the index value. Reading or writing to this property will call into the instrument plugin
| DirectValueMax | Gets the direct value maximum.
| DirectValueMin | Gets the direct value minimum.
| DirectValueNumerator | Gets the direct value numerator in the case where the direct value is a fraction denominator. This is used for values such as the Pulse Rate Frequency, where the value to display is NUMERATOR / DIRECT_VALUE. For example, if the DIRECT_VALUE is 1000 and the NUMERATOR is 12000, the value to display is 12000/1000 or 12. If null is returned, then this setting is not represented by a fraction but the true direct value.
| DirectValueStepSize | Gets the size of the direct value step.
| DirectValueStepSupported | Gets a value indicating whether the direct value step supported.
| EnumValues | Gets the enum values.
| IndexMax | Gets or sets the index value.
| IndexValue | Gets or sets the index value. Reading or writing to this property will call into the instrument plugin.
| IndexValues | Gets or sets the index value.
| IsDirectPresentAndSupported | Gets a value indicating whether this setting is direct present and supported. If this is true for a setting named 'Gain', then pulser.Gain = 10.0; can be used.
| IsFactory | If this is try the property can not be written after the instrument leaves the factory.
| IsIndexedPresentAndSupported | Gets a value indicating whether this setting is indexed present and supported. So for Gain, this means that gain can be changed with statements like pulser.GainIndex = 0;
| IsNumeratorSupported | Gets whether or not the numerator value is provided for the DirectValue.
| IsReadOnly | Gets a value indicating whether this setting is read only.
| IsVolatile | Gets a value indicating whether this object is volatile, meaning that the current value may change spontaneously or as a result of changing a different setting. For example, EnergyPerPulse will change when the HVSupply setting is changed, therefore EnergyPerPulse would be volatile.
| ListOfRoles | Gets the list of roles that are present for this setting. Some settings have many properties associated with them, such as Index, IndexSupported and so on.
| PropInfoRoles | Gets the property information roles, including repeated properties with the role of SPECIFICVALUESUPPORTED with different indices.
| PulserReceiverId | Gets the identifier of the pulser receiver.
| SettingName | Gets the name of the setting. This is the name of the setting, not an individual property name. For example, a pulser property is HVSupplyIndex. The setting name is HVSupply.
| Units | Gets the units of measure for this setting. If it is a unit-less value, then PROPERTY_UNITS.UNIT_NONE will be returned.
| Value | Gets or sets the index value. Reading or writing to this property will call into the instrument plugin

Top
Methods

| Name | Description
--- | --- | ---
| CreateListOfPulserProperties | Creates list of pulser properties. It takes an IPulserReceiver object as an argument. Reflection is used to look for properties in the object which have the PulserSettingAttribute in the metadata. It then analyzes the information from the PulserSettingAttribute to create the PulserSettingInfo objects in order to build the list.
| Equals | (Overloaded) Determines whether the specified Object is equal to the current Object. (inherited from Object).
| ExtractPulserProperties | Creates list of pulser properties. It takes an IPulserReceiver object as an argument. Reflection is used to look for properties in the object which have the PulserSettingAttribute in the metadata. It then analyzes the information from the PulserSettingAttribute to create the PulserSettingInfo objects in order to build the list.
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object).
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object).
| GetNearestIndexValue | Gets nearest index value.
| GetPropertyValue | (Overloaded) Gets the value of a property such as GainMin. While the setting name is 'Gain', there are possibly many properties associated with the gain setting. This method allows the reading of those properties, even if they aren't defined in the IPulserReceiver interface. For example, to read the GainIndex property, this method could be used like: pulserSettingInfo.GetPropertyValue(pulser, PulserPropertyRole.Index); The index is used for accessing properties when the pulser object has several properties with the same role, such as ReceiverModeEchoSupported, ReceiverModeThruSupported. For those, the index specifies the value of ReceiverMode that the property applies to, I.E. the numerical values of the RECEIVER_MODE enumeration.
| GetReturnType | Gets return type for the read method of a specific property role.
| GetRoleReadMethod | Gets role read method. This is a way to read the value of a property, even if the property is not defined in the IPulserReceiver interface. It can also be used to read the properties which are defined also.
| GetRoleWriteMethod | Gets role write method. This is a way to write the value of a property, even if the property is not defined in the IPulserReceiver interface. It can also be used to write to the properties which are defined also.
| GetSettingNameAndRoleFromName | Takes a full property name like "HVSupplyIndexMax" and returns the role (PulserPropertyRole.INDEXMAX) and the setting name: HVSupply.
| GetType | (Overloaded) Gets the Type of the current instance. (inherited from Object).
| GetUnitsAsString | Gets units of measure as string.
| GetValueAsString | Gets a string representation of this property in the current pulser receiver device. If this property is not supported, then null is returned.
| GetValuesAsStrings | Gets a string representation of this property in the current pulser receiver device. If this property is not supported, then null is returned.
| IsDirectValueValid | Query if 'value' is a valid value to be used for the Direct Value.
| IsEnumValueSupported | Query if 'idx' is a supported/valid index value.
| IsIndexValueSupported | Query if 'idx' is a supported/valid index value.
| IsPropertySupported | (Overloaded) True if property supported.
| IsRoleSupported | Query if 'role' is role supported.
| MakePropertyName | Takes a full property role and setting name and creates a properth name. Given a role of PulserPropertyRole.INDEXMAX and the setting name: HVSupply, this function will return HVSupplyIndexMax.
| MemberwiseClone | Creates a shallow copy of the current Object. (inherited from Object).
| ReferenceEquals | Determines whether the specified Object instances are the same instance. (inherited from Object).
| SetPropertyValue | (Overloaded) Sets the value of a property such as GainMin. While the setting name is 'Gain', there are possibly many properties associated with the gain setting. This method allows the writing of those properties, even if they aren't defined in the IPulserReceiver interface. For example, to write to the GainIndex property, this method could be used like: pulserSettingInfo.SetPropertyValue(pulser, PulserPropertyRole.Index, (object)1);
| ToString | Returns a String that represents the current Object.
| getPulserPropertyName | creates a pulser property name out of the general setting name and standard text used to specified a role. For example, if this PulserSettingInfo.SettingName == "Gain", and the the role was PulserPropertyRole.MAX, this method would return the string "GainMax";
| getRoleInfo | Gets role write method. This is a way to write the value of a property, even if the property is not defined in the IPulserReceiver interface. It can also be used to write to the properties which are defined also.
| objectToString | Converts a returned object to string representation. This is mainly used to format double return types to an appropriate value.

Top
Classes

| Name | Description
--- | --- | ---
| PropInfoRole | A property information role. A small structure which holds the role and for a few cases, and index value.

Top
See Also

#### Reference

PulserSettingInfo Class
JSRDotNETSDK Namespace