|
Signal
|
Represents a serializable Guid signal ID to UInt16 index cross reference.
Inheritance Hierarchy
SystemObject
GSF.TimeSeries.TransportSignalIndexCache
GSF.TimeSeries.TransportSignalIndexCache
Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.257-beta
Syntax[SerializableAttribute] public class SignalIndexCache : ISupportBinaryImage
The SignalIndexCache type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SignalIndexCache | Creates a new SignalIndexCache instance. |
| SignalIndexCache(DataSet, SignalIndexCache) | Creates a new local system cache from one that was received remotely. |
Properties| Name | Description | |
|---|---|---|
 | AuthorizedSignalIDs | Gets reference to array of requested input measurement signal IDs that were authorized. |
| BinaryLength | Gets the length of the binary image. |
| Encoding | Gets or sets character encoding used to convert strings to binary. |
| MaximumIndex | Gets the current maximum integer signal index. |
| Reference | Gets or sets integer signal index cross reference dictionary. |
| SubscriberID | Gets or sets the Guid based subscriber ID of this SignalIndexCache. |
| UnauthorizedSignalIDs | Gets or sets reference to array of requested input measurement signal IDs that were unauthorized. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GenerateBinaryImage | Generates binary image of the SignalIndexCache and copies it into the given buffer, for BinaryLength bytes. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetSignalIndex | Gets runtime signal index for given Guid signal ID. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ParseBinaryImage | Initializes the SignalIndexCache by parsing the specified buffer containing a binary image. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Extension Methods| Name | Description | |
|---|---|---|
 | BinaryImage |
Returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions) |
| CopyBinaryImageToStream |
Copies binary image of object that implements ISupportBinaryImage to a Stream.
(Defined by ISupportBinaryImageExtensions) |
| CopyImage |
This is a common optimized block copy function for any kind of data.
(Defined by Common) |
| GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| ParseBinaryImageFromStream |
Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions) |
Remarks
This class is used to create a runtime index to be used for data exchange so that a 16-bit integer
is exchanged in the data packets for signal identification instead of the 128-bit Guid signal ID
to reduce bandwidth required for signal exchange. This means the total number of unique signal
IDs that could be exchanged using this method in a single session is 65,535. This number seems
reasonable for the currently envisioned use cases, however, multiple sessions each with their own
runtime signal index cache could be established if this is a limitation for a given data set.
See Also