JSRDotNETSDK Reference

# PulserReceiverImpl Methods

PulserReceiverImpl Class See Also

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

Methods

| Name | Description
--- | --- | ---
| Equals | (Overloaded) Determines whether the specified Object is equal to the current Object. (inherited from Object).
| 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).
| 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.
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object).
| 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.
| GetType | (Overloaded) Gets the Type of the current instance. (inherited from Object).
| IsPulserSettingSupported | A quick way to see if the pulser receiver supports this pulser setting.
| 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).
| 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);
| ToString | Returns a String that represents the current Object. (inherited from Object).
| buildSettingsList | Builds the settings list if null, otherwise does nothing.
| checkException | Check exception.
| clearCache | Clears the cache of Pulser/Receiver values
| eventThreadClear | Work item cancel.
| eventThreadPost | Event thread post.
| eventThreadStop | Event thread stop.
| eventThreadTaskLoop | Event thread task loop.
| getCustomPulserPropertyValue | Gets custom pulser property value.
| getSettingInfo | Gets setting information.
| getValue | (Overloaded) Gets a value from the instrument pulser/receiver subclass.
| initialize | Initializes this pulser/receiver instance. This must be called in the subclass' constructor.
| instrumentClearCache | Clears the cache in the instrument. This is provided for the subclass to implement in case there is any cached values that need to be cleared when the PulserReceiver cache is cleared. NOTE: This function will be called during the construction of the PulserReceiverImpl object. By default, this function does nothing. NOTE: Cache is already locked before entering this function
| instrumentForceDetach | Notifies the instrument that a force detach was requested for this instance.
| instrumentGetValue | Gets the value from the instrument.This method is to be implemented in the subclass of this PulserReceiver class.
| instrumentRefresh | Requests a refresh of the instrument to refresh its current device info. This is also required to exit the ERROR state. To provide the success/fail response, call the refreshComplete function with the success and optional exception.
| instrumentSetValue | Set value in the instrument. This method is to be implemented in the subclass of this PulserReceiver class.
| isStatusChangeRegistered | (Overloaded) Queries if a particular property is registered to report status changes.
| notifyStatusChange | Notifies the status change.
| refreshComplete | Function called to indicate that the refresh is complete and update the state accordingly.
| resetDampingCache | Resets the damping cache.
| resetGainCache | Resets the gain cache.
| resetHVSupplyCache | Resets the hv supply cache.
| resetHVSupplyEnableCache | Resets the hv supply enable cache.
| resetHighPassFilterCache | Resets the high pass filter cache.
| resetLEDBlinkModeCache | Resets the LED blink mode cache.
| resetLowPassFilterCache | Resets the low pass filter cache.
| resetPulseEnergyCache | Resets the pulse energy cache.
| resetPulseRepetitionFreqencyCache | Resets the pulse repetition freqency cache.
| resetPulserImpedanceCache | Resets the pulser impedance cache.
| resetPulserInfoCache | Resets the pulser information cache.
| resetReceiverModeCache | Resets the receiver mode cache.
| resetTriggerEdgePolarityCache | Resets the trigger edge polarity cache.
| resetTriggerImpedanceCache | Resets the trigger impedance cache.
| resetTriggerSourceCache | Resets the trigger source cache.
| sendDetachedEvent | Sends the detached event.
| sendFaultEvent | Sends a fault event.
| sendStateUpdate | Sends a fault event.
| sendStatusChange | Executes the status change on a different thread, and waits for the result.
| setState | Updates the state described by newState.
| setValue | (Overloaded) Sets a value in the instrument pulser/receiver subclass.

Top
See Also

#### Reference

PulserReceiverImpl Class
JSRDotNETSDK Namespace
IPulserReceiver