JSRDotNETSDK Reference

# InstrumentOpenCriteria Members

InstrumentOpenCriteria Class Constructors Methods Fields Properties See Also

This class represents a filter which can specify which instrument(s) to open. All JSRDotNETSDK dll's should accept this baseline class, but object could be subclassed if a finer-grained decision need be made.

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

Constructors

| Name | Description
--- | --- | ---
| InstrumentOpenCriteria | Default Constructor.

Top
Properties

| Name | Description
--- | --- | ---
| AllowedInterfaces | Gets the list of allowed interface types that can be used by this plugin. The default value for this property is all of the supported interfaces.
| ModelName | The model name of the instrument(s) to be opened, or NULL if any model is acceptable. Examples model names are DPR500, DPR300, PRC50, etc.
| PortsToExclude | If the library is for a family of instruments which connect via serial port, this would be a list of serial port names like COM3. If this list is null or empty, then no ports are excluded in the search for an instrument. For connection types, this may not be used, such as USB.
| PortsToInclude | If the library is for a family of instruments which connect via serial port, this would be a list of serial port names like COM3. If this list is null or empty (the default value), then all ports are included in the search for an instrument. For connection types, this may not be used, such as USB. In a possible future ethernet model, it could be a list of IP address and port numbers, etc.
| SerialNumber | The SerialNumber of the instrument to be opened, or NULL (or alternatively an empty string) if any are acceptable.
| guid | The model name of the instrument(s) to be opened, or NULL if any model is acceptable. Examples model names are DPR500, DPR300, PRC50, etc.

Top
Methods

| Name | Description
--- | --- | ---
| AddAllowedInterface | Adds an allowed interface.
| AddAllowedInterfaces | Adds an array containing the list of allowed interfaces.
| AddOpenOption | Adds an open option to the criteria object. And open option has a string name, which should be one of the open option names in the plugin metadata.
| AddPortToExclude | Adds a port to exclude when the plugin will search for instruments. If this list is empty, then all ports will be searched. The "port string" is specific to the method used for searching for instruments: e.g. COM port for SERIAL, IP Address for ETHERNET, etc.
| AddPortToInclude | Adds a port to include when the plugin will search for instruments. If this list is empty, then all ports will be searched. The "port string" is specific to the method used for searching for instruments: e.g. COM port for SERIAL, IP Address for ETHERNET, etc.
| 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).
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object).
| GetOpenOption | Looks for an open option by name. Returns string result if the option is present, or null if it is not.
| GetOpenOptionNames | Looks for an open option by name. Returns string result if the option is present, or null if it is not.
| GetOpenOptionsSpec | Gets open options specification.
| GetType | (Overloaded) Gets the Type of the current instance. (inherited from Object).
| GetValidOpenOptionNames | returns an array of the names of all the open options that can be set. If there are none, it runs an array of size 0.
| GetValidOpenOptionValues | Returns an array of values that can be set for the given open option name. If the open option isn't in the list of valid options, an empty list will be returned.
| Initialize | Initializes this object, called by all constructors to create members.
| 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).
| RemoveAllOpenOptions | Removes all open options.
| RemoveOpenOption | Removes an open option from the criteria object.
| ToString | Returns a String that represents the current Object. (inherited from Object).
| Validate | Validates this object.
| validateOpenOption | Validates the open option described by openOptionName.

Top
Fields

| Name | Description
--- | --- | ---
| CONNECT_ON_OPEN |
| GUID |
| MODELNAME |
| SERIALNUMBER |
| SHOW_SIMULATOR_WINDOWS |

Top
See Also

#### Reference

InstrumentOpenCriteria Class
JSRDotNETSDK Namespace