JSRDotNETSDK Reference

# JSRDotNETManager Methods

JSRDotNETManager Class See Also

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

Methods

| Name | Description
--- | --- | ---
| AddManagedPlugin | Adds a JSRDotNET library to the managed list used for discovery.
| AddPluginOpenOption | Sets plugin open options.
| AddPluginType | Adds a plugin type string to the list of supported plugins. This is used to enable special plugins that would otherwise be ignored.
| 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. (inherited from PulserReceiverBase).
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object).
| GetInstruments | Returns an array of IInstrumentIdentity objects for all of the Instrument devices that have been discovered. This only returns information about the Instruments discovered by the plugins in the Managed list.
| GetManagedPluginNames | Gets the list of plugin names from the list of managed plugins.
| GetPluginLibOpenOptions | Some libraries have options specific only to that library. These are communicated via the InstrumentOpenCriteria, which can optionally be set before device discovery is enabled. This retrieves a dictionary with the available options.
| GetPluginLibraryInstance | Gets a reference to a library instance. After calling GetPluginNames() to get the list of available libraries, this method is called to return a reference to the plugin.
| GetPluginLibraryMetadata | Gets a reference to a library metadata. After calling GetPluginNames() to get the list of available libraries, this method is called to return a metadata object that contains infromation about the plugin.
| GetPluginNameFromLibraryInstance | Gets plugin name from library instance.
| GetPluginNames | Call this to get a list of the plugins available in the plugin folder.
| GetPluginOpenOptions | Gets plugin open options.
| GetPulserPropertyAttributes | Returns an integer of logical or'd bitflags indicating various properties of a setting such as weather 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 of reading the value of a property is to provide a PR_PROPERTY enum value. The result will be an integer, double, string or array boxed into an object.
| GetPulserReceiver | If a pulser receiver has already been discovered, this function returns the .NET pulser receiver object.
| GetPulserReceiverInfo | (Overloaded) Gets pulser receiver information.
| GetPulserReceivers | Returns an array of PuslerReceiverIdentity objects for all of the pulser/receiver devices that have been discovered.
| 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.
| LoadPlugins | Loads all the plugins located in the given plugin path. If the plugin path is null or an empty string, then the default plugin path of "\plugins" under the same directory as the current executable. This method only locates the plugins and reads the metadata. It does not create any class instances or execute any code from the plugin. If an error occurs while loading the plugins, then an exception will be thrown.
| MakeIdString | (Overloaded) Puts the model number, the serial number and pulser receiver index into a string in a way that can be easily parsed back into the two strings and integer.
| MemberwiseClone | Creates a shallow copy of the current Object. (inherited from Object).
| NotifyThreadProc | Notifies the thread proc.
| ParseIdString | Parse a string with model, serial# and pulser receiver index back into the two strings and an integer.
| 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. (inherited from PulserReceiverBase).
| RemoveAllOpenOptions | Removes all open options described by strPluginName.
| RemoveManagedPlugin | Removes a JSRDotNET library from the managed list used for discovery.
| RequestThreadProc | Request thread procedure.
| SetCurrentPulserReceiver | (Overloaded) Selects a pulser receiver as the current one. After this function returns, all property reads and writes performed on this JSRDotNETManager object will refer to the specified pulser receiver.
| SetDiscoveryEnable | (Overloaded) Sets discover enable. When this is false, and gets set to true, all the libraries begin a search for pulser receivers. When one is found, a notification with NOTIFY_TYPE of PULSER_RCVR_DISCOVERED will be fired.
| 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: SetPulserSetting(PRPropertyNames.Gain, (object) 10.0);
| Shutdown | Shuts down this object and frees any resources it is using. Once the manager is shutdown it cannot started again, so after calling this, the object reference is useless.
| ToString | Returns a String that represents the current Object. (inherited from Object).
| addManagedPulserReceivers | Adds the list of pulser receivers from a newly added Managed Plugin to the Pulser/Receiver list.
| removeManagedPulserReceivers | Removes the list of pulser receivers for a remvoed Managed Plugin from the Pulser/Receiver list.
| setDiscoveryEnable | (Overloaded) Sets discover enable. When this is false, and gets set to true, all the libraries begin a search for pulser receivers. When one is found, a notification with NOTIFY_TYPE of PULSER_RCVR_DISCOVERED will be fired.

Top
See Also

#### Reference

JSRDotNETManager Class
JSRDotNETSDK Namespace
IPulserReceiver
JsrPluginHelper