JSRDotNETSDK Reference

# PulserSettingInfo Methods

PulserSettingInfo Class See Also

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

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
See Also

#### Reference

PulserSettingInfo Class
JSRDotNETSDK Namespace