JSRDotNETSDK Reference

# SettingAttributes Members

SettingAttributes Class Methods Fields See Also

Static class just to define static bitflags which describe a pulser setting.

The following tables list the members exposed by the SettingAttributes 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).
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object).
| GetType | (Overloaded) Gets the Type of the current instance. (inherited from Object).
| 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).
| ToString | Returns a String that represents the current Object. (inherited from Object).

Top
Fields

| Name | Description
--- | --- | ---
| BOTH_SUPPORTED | Sometimes an instrument can support both direct and indexed access. The most common example is gain. The user could pulser.Gain = -13.0, or pulser.GainIndex = 0 to set the gain to the minimum.
| DIRECT_SUPPORTED | Any setting which is not indexed is a direct property. (and some are both) Here the value is set directly, such as by assigning a value to IPulserReceiver.Gain = 10.0;
| FACTORY | Factory properties cannot be written to after leaving the factory.
| FIXED | A fixed setting will never change its value. It is also always readonly. Since a fixed setting is unlikely to be indexed, this attribute is very likely to also have the DIRECT_SUPPORTED attribute below. See RO_FIXED_DIRECT below.
| INDEX_SUPPORTED | And indexed setting means that the property is controlled by reading and writing an integer index, rather than the value itself. For example the DPR300 has 16 possible PRF rates. So the property PulseRepetitionFrequencyIndex is an integer property that chooses which of the 16 possible rates to use by write a value between 0 and 15. The actual PRF value is accessed by PulseRepetitionFrequencyValues, which is an array of 16 doubles.
| NONE | Default of zero same as unsupported.
| READONLY | A setting may be readonly. Obviously things like the Id with the model and serial number would be readonly and fixed. A setting like PowerLimitStatus would be readonly, but wouldn't be fixed, since it can still change its value.
| RO_FIXED_DIRECT | Probably all pulser settings that are fixed will be direct ones, since there is not much point to being indexed in that case.
| SUPPORTED | This instrument has this feature, although it might be read-only or fixed at one value.
| UNSUPPORTED | Unsupported means the hardware doesn't have this feature. Writing or reading the related property will do nothing, and if a value is returned (As opposed to throwing an exception), it will be meaningless. For example, if LEDBlinkRateSupported == UNSUPPORTED, then the device might not have any LED on it. Writing to LEDBlinkRate may generate an exception. Alternatively, a device may not have a feature that is a real setting, but the setting might be supported as a FIXED/READONLY setting, which means writing to it will be ignored or an exception generated. However you can read the value. For example, a DPR300 does not have a way to disable the HV Supply. However, it is always enabled, so the property is supported as a fixed readonly setting that always reports that the HV Supply is enabled. Reading it may also, or may return a value which has no meaning.
| VOLATILE | Some pulser settings are volatile like PulserLimitStatus which may change even though they are readonly.

Top
See Also

#### Reference

SettingAttributes Class
JSRDotNETSDK Namespace