JSRDotNETSDK Reference

# JSRDotNETSDK Namespace

Assembly: JSRDotNETSDK (in JSRDotNETSDK.dll)
Classes

| Name | Description
--- | --- | ---
| EnumXlator |
| EventArgsInstrumentDiscovered | When an instrument is discovered, the instrument discovery event handler is called. This is Event Arguments object which contains information about discovered instrument, or error information if an exception occurred.
| EventArgsManagerNotify | A general event args object for getting information about an notification. Has three general string arguments which have different meanings for different notifications. When NotifyCode is PULSER_RCVR_DISCOVERED, args are model, serial Num, and Pulser Index Number when NotifyCode is CURRENT_PULSER_RCVR_CHANGED, args are model, serial Num, and Pulser Index Number when NotifyCode is PULSER_RCVR_DETACH, args are model, ser#, prindex, bWasSelected is true if currently selected when NotifyCode is PROPERTY_CHANGE, args are model, ser#, prindex, and the property name when NotifyCode is ERROR, args are exception type, message, inner exception type if exists.
| EventArgsStatusChange | Event arguments for pulser receiver status change event, for when a property changes, or an error occurs, or an instrument becomes detached.
| ExceptionJSRDotNET | If an error is caught by the SDK, an ExceptionJSRDotNet will be thrown.
| ExportJSRDotNETLibAttribute | Custom Attribute for jsr dot net library.
| IndexString |
| InstrumentIdentity |
| InstrumentOpenCriteria | 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.
| JSRDotNET | Main interface for accessing a Jsr Pulser Receiver product family from a DLL.
| JSRDotNETManager | This class provides simplified access to the JSRDotNETAPI. Instead of having a separate .NET object for each pulser receiver, all properties are simply accessed from this one object.
| JSRDotNET_Logger | A general logger class.
| PRPropertyNames | This static class contains the full property names including the setting name (such as Gain) and the role name. (Such as Max, IndexSupported, etc) This is used to identify a property of IPulserReceiver in full, such as ReceiverModeEchoSupported. Note that an instrument module may support more properties than listed here. This would be discovered by examining the metadata.
| PropertyChangeEventCriteria | An object which contains a list of PR_PROPERTY enums. It is used to specify which properties will fire Status Change events when the property is modified.
| PulserReceiverBase | Interface for pulser receiver. An instrument can have multiple pulser receivers.
| PulserReceiverIdentity | An object which can uniquely identify a pulser receiver. It has as a member an InstrumentIdentity object, which identifies which instrument this pulser receiver is part of. In the case where an instrument has more than one pulser receiver attached, there will be more than one IPulserReceiverIdentity objects with the same InstrumentIdentity member.
| PulserReceiverImpl | Interface for pulser receiver. An instrument can have multiple pulser receivers.
| PulserSettingAttribute |
| PulserSettingInfo | A pulser receiver has settings such as Gain, TriggerEnable and so on. The IPulserReceiver Interface implements these settings via sets of properties such as Gain, GainMax, GainMin, GainIndex etc. This class describes the setting, with information about which roles are present for that setting.
| SettingAttributes | Static class just to define static bitflags which describe a pulser setting.
| SettingNames | A static class container for the strings which represent the settings names used in the IPulserReceiver class.
| SettingRoleNames | A pulser receiver property name such as GainIndexMax consists of the setting name (Gain) and a role name ("IndexMax"). This
| ValueString<T> |

Top
Interfaces

| Name | Description
--- | --- | ---
| IInstrumentIdentity | An opaque class.
| IJSRDotNET | Main interface for accessing a Jsr Pulser Receiver product family from a DLL.
| IJSRDotNETLibMetadata | Interface for ijsr dot net library metadata.
| IPulserReceiver | Interface for pulser receiver. An instrument can have multiple pulser receivers.
| IPulserReceiverIdentity | An object which can uniquely identify a pulser receiver. It has as a member an InstrumentIdentity object, which identifies which instrument this pulser receiver is part of. In the case where an instrument has more than one pulser receiver attached, there will be more than one IPulserReceiverIdentity objects with the same InstrumentIdentity member.
| IValueString |

Top
Enumerations

| Name | Description
--- | --- | ---
| CONNECTION_TYPE | Values that represent connection types.
| DiscoveryEventType | Enumeration values that indicate the type of event that has occurred
| DiscoveryStateFlags | A bit-field of flags for specifying discovery states.
| ERROR_CODE | Values that represent error codes.
| IS_PULSING | Values that represent the current activity of the pulser. Some instruments do not have the ability to detect if an external trigger is active or not. However, if the internal trigger source is used, the instrument will report this property as active.
| NOTIFY_TYPE | Values that represent notify types. If the NotifyEventHandler event is subscribed to, the end application can get notifications of these types.
| POWER_LIMIT | Values that represent the power limit status of the pulser. Some instruments will will operate at reduced performance levels or become damaged if the combination of output voltage and pulse repetition frequency is too high.
| PROPERTY_UNITS | Values that represent property units of measure.
| PULSER_IMPEDANCE | Values that represent pulser impedances.
| PulserPropertyDataType | The main datatype of the property. For example, gain is of type DOUBLE, while the Info property is an array of strings.
| PulserPropertyRole | A JSRDotNET Property consists of a group of .NET properties in IPulserReceiver. This enum specifies which role one specific .NET property has. For example, one of the properties in IPulserReceiver associated with Gain, is the boolean property 'GainIndexSupported'. Thus the role of that .NET property is INDEXSUPPORTED.
| PulserReceiverState |
| PulserSettingAccessType | This type applies to a JSRDotNET Property, such as Gain. Thus it applies to several properties of IPulserReceiver such as Gain, GainIndex, GainIndexMax, etc. Some properties are accessed directly such as TriggerEnable=true; Others are accessed through an index, such DampingIndex=2, where the actual damping values are floating point doubles. Sometimes a property can be set using both methods, where direct access simply chooses the closest legal value. This enum specifies which of these access methods the JSRDotNET property uses.
| RECEIVER_MODE | Enum Values that represent signal selects.
| STATUS_CHANGE | Values that represent pulser receiver status changes.
| TRIGGER_IMPEDANCE | Values that represent trigger impedances.
| TRIGGER_POLARITY | Enum Values that represent edge trigger polarity.
| TRIGGER_SOURCE | Enum Values that represent trigger sources.

Top