JSRDotNETSDK Reference

# IPulserReceiver Methods

IPulserReceiver Interface See Also

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

Methods

| Name | Description
--- | --- | ---
| ForceDetach | Causes this pulser receiver object to fire a Status Change event indicating the pulser receiver has been detached. The pulser receiver object will be removed from the library's lists. If the library's InstrumentDiscoveryEnable property is true, a new Pulser Receiver object will be created, and a InstrumentDiscoveredEvent will be fired and the pulser receiver object will be available for use.
| GetCustomSettings | Gets a list of the custom settings supported by this pulser/receiver.
| GetPulserPropertyAttributes | Returns an integer of logical or'd bitflags indicating various properties of a setting such as whether it is indexed or readonly etc.
| GetPulserPropertyUnits | Returns the unit of measure for the setting. The setting name is the base prefix for the property using the values from the SettingNames class.
| GetPulserPropertyUnitsAsString | Returns the unit of measure for the setting. The setting name is the base prefix for the property using the values from the SettingNames class.
| GetPulserPropertyValue | (Overloaded) An alternative method for reading the value of a property is to provide a string prefix name. The result will be an integer, double, string or array boxed into an object. The prefix name consists of begining characters of the specific properties. For example, there are many .NET properties associated with gain, such as GainIndex, GainMax, etc. The prefix name for all these properties is SettingNames.Gain. In this case, to get the gain using this method: double gain = (double) GetPulserPropertyValue(SettingNames.Gain, JSRDotNETPropRole.DIRECT); If there is no .NET property with this role, a null will be returned.
| GetPulserSettingInfo | Given the pulser setting name (such as 'Gain' or 'HVSupply'), this method returns an object with info about which .NET properties exist which are associated with this pulser property. This method will return the standard properties guaranteed by the interface but also can return new properties which are not in the interface, but might be only present for a specific model. To get a list of prefix names, see the static function PulserPropertyInfo.CreateListOfPulserProperties() method. Note that if a setting by this name cannot be found, a null will be returned, so that should be tested for.
| IsPulserSettingSupported | A quick way to see if the pulser receiver supports this pulser setting.
| Refresh | Refreshes this pulser/receiver instance. If the pulser/receiver is in the error state, it will attempt to re-initialize the connection.
| SetPulserPropertyValue | (Overloaded) As an alternative to directly setting a pulser property (as in pulser.Gain = 10.0), a setting can be set with the following method where the property is selected by name. For example: SetPulserPropertyValue(PRPropertyNames.Gain, (object) 10.0);

Top
See Also

#### Reference

IPulserReceiver Interface
JSRDotNETSDK Namespace