GSF.TimeSeries
Marks a parameter as being a connection string parameter used to configure an .
Marks a parameter or class as having a custom configuration editor page used to configure that parameter or class.
Creates a new instance of the class.
The name of the assembly in which the editor type resides.
The full name of the type of the editor.
The connection string for the custom configuration screen.
Creates a new instance of the class.
The type of the editor.
The connection string for the custom configuration screen.
Gets the type of the UI editor used to configure the custom adapter.
Gets the connection string used to configure the editor.
Base class for the interface.
Creates a new instance of the class.
Gets or sets primary keys of input measurements the expects, if any.
If your adapter needs to receive all measurements, you must explicitly set InputMeasurementKeys to null.
Gets or sets output measurements that the will produce, if any.
Gets or sets the values that determines the order in which filter adapters are executed.
Handler for new measurements that have not yet been routed.
Measurements that have not yet been routed.
Determines if the given measurement key represents
a signal that is bound for this filter adapter.
The key that identifies the signal.
True if measurements for the given signal are bound for this filter adapter.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of this .
Processes the new measurements before they have been routed to other adapters.
The new measurements that have not yet been routed.
Represents a collection of implementations.
Provides notification of change in collection count.
Creates a new instance of the .
Gets or sets the values that determines the order in which filter adapters are executed.
Handler for new measurements that have not yet been routed.
Measurements that have not yet been routed.
Attempts to create an from the specified .
containing item information to initialize.
Initialized adapter if successful; otherwise null.
true if item was successfully initialized; otherwise false.
See property for expected column names.
is null.
Inserts an element into the the specified index.
The zero-based index at which item should be inserted.
The implementation to insert.
Assigns a new element to the at the specified index.
The zero-based index for which item should be assigned.
The implementation to assign.
Removes the element at the specified index of the .
The zero-based index of the element to remove.
Removes all elements from the .
Raises event.
Represents a new Input, Action, Output interface session.
Provides status messages to consumer.
is the new status message.
is the message .
Event is raised when there is an exception encountered while processing.
is the exception that was thrown.
Event is raised when are updated.
Event is raised when are updated.
Event is raised when adapter is aware of a configuration change.
Event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
is the total number of unpublished seconds of data.
Event is raised every five seconds allowing host to track total number of unprocessed measurements.
Each implementation reports its current queue size of unprocessed
measurements so that if queue size reaches an unhealthy threshold, host can take evasive action.
is total number of unprocessed measurements.
Indicates to the host that processing for one of the input adapters has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Event is raised when this is disposed or an in the collection is disposed.
Creates a new .
Releases the unmanaged resources before the object is reclaimed by .
Gets the all adapters collection for this .
Gets the filter adapter collection for this .
Gets the input adapter collection for this .
Gets the action adapter collection for this .
Gets the output adapter collection for this .
Gets the routing tables for this .
Gets or sets a routing table restriction for a collection of input measurement keys.
Gets or sets the configuration for this .
Gets or sets the node ID for this .
Gets name assigned to this , if any.
Gets the combined status of the adapters in this .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initialize and start adapters.
Sets flag that determines if adapters should be automatically started.
Gets flag that determines if temporal processing is supported in this .
Name of collection over which to check support (e.g., "InputAdapters"); or null for all collections.
Flag that determines if temporal processing is supported in this .
Gets derived name of specified object.
Sending object from which to derive name.
Derived name of specified object.
Recalculates routing tables as long as all adapters have been initialized.
Raises the event.
Object source raising the event.
New status message.
of status message.
Raises the event with a formatted status message.
Object source raising the event.
Formatted status message.
of status message.
Arguments for .
This overload combines string.Format and SendStatusMessage for convenience.
Raises event.
Object source raising the event.
Processing .
Raises event.
Object source raising the event.
Raises event.
Object source raising the event.
Raises event.
Object source raising the event.
Raises the event.
Object source raising the event.
Total number of unpublished seconds of data.
Raises the event.
Object source raising the event.
Total measurements in the queue that have not been processed.
Raises the event.
Object source raising the event.
, if any.
Raises the event.
Object source raising the event.
Event handler for reporting status messages.
Event source of the status message.
Event arguments containing the status message to report.
Event handler for processing reported exceptions.
Event source of the exception.
Event arguments containing the exception to report.
Event handler for updates to adapter input measurement key definitions.
Sending object.
Event arguments, if any.
Event handler for updates to adapter output measurement definitions.
Sending object.
Event arguments, if any.
Event handler for adapter notifications about configuration changes.
Sending object.
Event arguments, if any.
Event handler for monitoring unpublished samples.
Event source reference to adapter, typically an action adapter, that is reporting the number of unpublished data samples.
Event arguments containing number of samples, in seconds of data, of unpublished data in the source adapter.
Time-series framework uses this handler to monitor the number of unpublished samples, in seconds of data, in action adapters.
This method is typically called once every five seconds.
Event handler for requesting temporal support.
Event source reference to adapter collection, typically an action adapter collection, that is requesting temporal support.
Event arguments are not used.
Action adapter collections use this handler to make sure temporal support is initialized before setting up temporal sessions.
Event handler for monitoring unprocessed measurements.
Event source reference to adapter, typically an output adapter, that is reporting the number of unprocessed measurements.
Event arguments containing number of queued (i.e., unprocessed) measurements in the source adapter.
Time-series framework uses this handler to monitor the number of unprocessed measurements in output adapters.
This method is typically called once every five seconds.
Event handler for new measurement notifications from input adapters and action adapters.
Event source reference to the adapter that is reporting new measurements.
Event arguments for event that contains references to the new measurements.
Event handler for processing complete notifications from input adapters.
Event source reference to input adapter that is reporting processing completion.
Event arguments for event, if any; otherwise .
Event handler for disposed events from all adapters.
Sending object.
Event arguments, if any.
Extracts a configuration that supports temporal processing from an existing real-time configuration.
Real-time configuration.
A new configuration for adapters that support temporal processing.
Represents a module that processes input measurements on
the way by before routing the measurements to other adapters.
Gets or sets the values that determines the order in which filter adapters are executed.
Handler for new measurements that have not yet been routed.
Measurements that have not yet been routed.
Represents the interface for implementations of independent adapter collection managers.
Gets or sets the wait timeout, in milliseconds, that system wait for system configuration reload to complete.
Gets or sets the total number of attempts to wait for system configuration reloads when waiting for configuration updates to be available.
Gets or sets the connection string used for database operations. Leave blank to use local configuration database defined in "systemSettings".
Gets or sets the provider string used for database operations. Defaults to a SQL Server provider string.
Gets or sets template for output measurement point tag names.
Gets or sets template for output measurement alternate tag names.
Gets or sets template for output measurement signal reference names.
Gets or sets template for output measurement descriptions.
Gets or sets template for the parent device acronym used to group associated output measurements.
Gets or sets default signal type to use for all output measurements when array is not defined.
Gets per adapter signal type for output measurements, used when each output needs to be a different type.
Gets any custom adapter settings to be added to each adapter connection string. Can be used to add
settings that are custom per adapter.
Gets or sets the target historian acronym for output measurements.
Gets or sets the source measurement table to use for configuration.
Gets routing tables used by instance.
Gets original data member setting for instance.
Gets or sets flag that determines if the instance
should be automatically parsed every time the
is updated without requiring adapter to be reinitialized.
Gets input measurement 's for each of the , if any.
Gets output measurement 's for each of the , if any.
Gets or sets wait handle used by instance to
manage waiting for changes to be loaded in system configuration.
Gets number of input measurement required by each adapter.
Gets or sets the index into the per adapter input measurements to use for target adapter name.
Gets output measurement names to use for each adapter.
Gets or sets current adapter ID counter.
Gets adapter index currently being processed.
Gets adapter output index currently being processed.
Gets associated device ID for , if any, for measurement generation.
Parses connection string. Derived classes should override for custom connection string parsing.
Notifies derived classes that configuration has been reloaded.
Recalculates routing tables.
Gets configured database connection.
New ADO data connection based on configured settings.
Enumerates child adapters
Gets subscriber information for specified client connection.
Enumerated index for child adapter.
Status for adapter with specified .
Raises event.
Raises event.
Raises the event and sends this data to the .
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Represents an adapter base class that provides functionality to manage and distribute measurements to a collection of action adapters.
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Creates a new .
Gets or sets primary keys of input measurements for the .
Gets or sets output measurements that the will produce, if any.
Gets or sets the number of frames per second applied to each adapter.
Valid frame rates for a are greater than 0 frames per second.
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second) applied to each adapter.
Defines the time sensitivity to past measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too old.
This becomes the amount of delay introduced by the concentrator to allow time for data to flow into the system.
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second) applied to each adapter.
Defines the time sensitivity to future measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too advanced.
This becomes the tolerated +/- accuracy of the local clock to real-time.
Gets or sets flag that determines if timestamp reasonability checks should be performed on incoming
measurements (i.e., measurement timestamps are compared to system clock for reasonability using
tolerance).
Setting this value to false will make the concentrator use the latest value received as "real-time"
without validation; this is not recommended in production since time reported by source devices may
be grossly incorrect. For non-production configurations, setting this value to false will allow
concentration of historical data.
Gets or sets flag that determines whether or not to use the local clock time as real-time.
Use your local system clock as real-time only if the time is locally GPS-synchronized,
or if the measurement values being sorted were not measured relative to a GPS-synchronized clock.
Gets or sets the wait timeout, in milliseconds, that system wait for system configuration reload to complete.
Gets or sets the total number of attempts to wait for system configuration reloads when waiting for configuration updates to be available.
Gets or sets the connection string used for database operations. Leave blank to use local configuration database defined in "systemSettings".
Gets or sets the provider string used for database operations. Defaults to a SQL Server provider string.
Gets or sets template for output measurement point tag names.
Gets or sets template for output measurement alternate tag names.
Gets or sets template for output measurement signal reference names.
Gets or sets template for output measurement descriptions.
Gets or sets template for the parent device acronym used to group associated output measurements.
Gets or sets default signal type to use for all output measurements when array is not defined.
Gets per adapter signal type for output measurements, used when each output needs to be a different type.
Gets any custom adapter settings to be added to each adapter connection string. Can be used to add
settings that are custom per adapter.
Gets or sets the target historian acronym for output measurements.
Gets or sets the source measurement table to use for configuration.
Gets or sets based data source used to load each . Updates
to this property will cascade to all adapters in this .
Gets number of input measurement required by each adapter. If value is not constant, use
to determine input count for adapter at current index.
Gets or sets the index into the per adapter input measurements to use for target adapter name.
Gets output measurement names to use for each adapter.
Gets or sets flag that determines if the adapter
should be automatically parsed every time the
is updated without requiring adapter to be reinitialized. Defaults to true
to allow child adapters to come and go based on updates to system configuration.
When this value is true (the default), implementors must call the
method an overridden method.
Gets input measurement 's for each of the , if any.
Gets output measurement 's for each of the , if any.
Gets or sets current adapter ID counter.
Gets adapter index currently being processed.
Gets adapter output index currently being processed.
Gets associated device ID for , if any, for measurement generation. If overridden to provide custom
device ID, should be set to null so no parent device is created.
Returns the detailed status of the .
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes the .
Initializes management operations for child adapters based on inputs. Derived classes should override
and call this method when is
true (the default).
Input measurement keys to use for initialization.
When is true (the default), implementors must override
the method and at least call this method.
Validates that an even number of inputs are provided for specified .
Parses connection string. Derived classes should override for custom connection string parsing and call the
method when is
true (the default).
When is true (the default), implementors must override
this method and at least call the method.
Notifies derived classes that configuration has been reloaded
Recalculates routing tables.
Queues a collection of measurements for processing to each connected to this .
Measurements to queue for processing.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of the .
Enumerates child adapters.
Gets subscriber information for specified client connection.
Enumerated index for child adapter.
Status for adapter with specified .
Gets configured database connection.
New ADO data connection based on configured settings.
Represents an adapter base class that provides functionality to manage and distribute measurements to a collection of action adapters.
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Defines the default value for the .
Finds child adapter with specified .
Target instance.
Adapter name to find.
instance with , if found; otherwise, null.
Lookups up point tag name from provided .
Target instance.
signal ID to lookup.
Measurement table name used for meta-data lookup.
Point tag name, if found; otherwise, string representation of provided signal ID.
Lookups up associated device name from provided .
Target instance.
signal ID to lookup.
Measurement table name used for meta-data lookup.
Device name, if found; otherwise, string representation of associated point tag.
Lookups up associated phasor label from provided .
Target instance.
signal ID to lookup.
Measurement table name used for meta-data lookup.
Phasor label name, if found; otherwise, string representation associated point tag.
Determines if exists in local configuration.
Target instance.
Signal ID to find.
Measurement table name used for meta-data lookup.
true, if is found; otherwise, false.
Gets measurement record, creating it if needed.
Target instance.
Device ID associated with current adapter, or zero if none.
Point tag of measurement.
Alternate tag of measurement.
Signal reference of measurement.
Description of measurement.
Signal type of measurement.
Acronym of target historian for measurement.
Measurement record.
Waits for to be loaded in system configuration.
Target instance.
Signal IDs to wait for.
Measurement table name used for meta-data lookup.
Handles construction steps for a new instance.
Target instance.
Disposes resources used by the instance.
Target instance.
Initializes the .
Target instance.
Sets based data source used to load each . Updates to this
property will cascade to all adapters in this instance.
Target instance.
Returns the detailed status for the instance.
Target instance.
Parses connection string. Derived classes should override for custom connection string parsing.
Target instance.
Validates that an even number of inputs are provided for specified .
Target instance.
Recalculates routing tables.
Target instance.
Queues a collection of measurements for processing to each connected to this .
Target instance.
Measurements to queue for processing.
Gets a short one-line status of this .
Target instance.
Maximum number of available characters for display.
A short one-line summary of the current status of the .
Enumerates child adapters.
Target instance.
Gets subscriber information for specified client connection.
Target instance.
Enumerated index for child adapter.
Gets configured database connection.
Target instance.
New ADO data connection based on configured settings.
Determines whether the data in the data source has actually changed when receiving a new data source.
Target instance.
New data source to check.
true if data source has changed; otherwise, false.
Represents an adapter base class that provides functionality to manage and distribute measurements to a collection of input adapters.
Creates a new .
Gets or sets output measurements that the will produce, if any.
Gets or sets the wait timeout, in milliseconds, that system wait for system configuration reload to complete.
Gets or sets the total number of attempts to wait for system configuration reloads when waiting for configuration updates to be available.
Gets or sets the connection string used for database operations. Leave blank to use local configuration database defined in "systemSettings".
Gets or sets the provider string used for database operations. Defaults to a SQL Server provider string.
Gets or sets template for output measurement point tag names.
Gets or sets template for output measurement alternate tag names.
Gets or sets template for output measurement signal reference names.
Gets or sets template for output measurement descriptions.
Gets or sets template for the parent device acronym used to group associated output measurements.
Gets or sets default signal type to use for all output measurements when array is not defined.
Gets per adapter signal type for output measurements, used when each output needs to be a different type.
Gets any custom adapter settings to be added to each adapter connection string. Can be used to add
settings that are custom per adapter.
Gets or sets the target historian acronym for output measurements.
Gets or sets the source measurement table to use for configuration.
Gets or sets based data source used to load each . Updates
to this property will cascade to all adapters in this .
Gets output measurement names to use for each adapter.
Gets or sets flag that determines if the adapter
should be automatically parsed every time
the is updated without requiring adapter to be reinitialized. Defaults
to true to allow child adapters to come and go based on updates to system configuration.
Gets output measurement 's for each of the , if any.
Gets adapter index currently being processed.
Gets adapter output index currently being processed.
Gets associated device ID for , if any, for measurement generation. If overridden to provide custom
device ID, should be set to null so no parent device is created.
Returns the detailed status of the .
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes the .
Parses connection string. Derived classes should override for custom connection string parsing.
Notifies derived classes that configuration has been reloaded
Recalculates routing tables.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of the .
Enumerates child adapters.
Gets subscriber information for specified client connection.
Enumerated index for child adapter.
Status for adapter with specified .
Gets configured database connection.
New ADO data connection based on configured settings.
Represents an adapter base class that provides functionality to manage and distribute measurements to a collection of output adapters.
Creates a new .
Gets or sets primary keys of input measurements for the .
Gets or sets the wait timeout, in milliseconds, that system wait for system configuration reload to complete.
Gets or sets the total number of attempts to wait for system configuration reloads when waiting for configuration updates to be available.
Gets or sets the connection string used for database operations. Leave blank to use local configuration database defined in "systemSettings".
Gets or sets the provider string used for database operations. Defaults to a SQL Server provider string.
Gets any custom adapter settings to be added to each adapter connection string. Can be used to add
settings that are custom per adapter.
Gets or sets the source measurement table to use for configuration.
Gets or sets based data source used to load each . Updates
to this property will cascade to all adapters in this .
Gets number of input measurement required by each adapter.
Gets or sets the index into the per adapter input measurements to use for target adapter name.
Gets or sets flag that determines if the adapter
should be automatically parsed every time
the is updated without requiring adapter to be reinitialized. Defaults
to true to allow child adapters to come and go based on updates to system configuration.
Gets input measurement 's for each of the , if any.
Get adapter index currently being processed.
Get adapter output index currently being processed.
Gets associated device ID for , if any, for measurement generation.
Returns the detailed status of the .
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes the .
Validates that an even number of inputs are provided for specified .
Parses connection string. Derived classes should override for custom connection string parsing.
Notifies derived classes that configuration has been reloaded
Recalculates routing tables.
Queues a collection of measurements for processing to each connected to this .
Measurements to queue for processing.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of the .
Enumerates child adapters.
Gets subscriber information for specified client connection.
Enumerated index for child adapter.
Status for adapter with specified .
Gets configured database connection.
New ADO data connection based on configured settings.
Provides an alternative means of routing messages one at a time if an adapter
is more efficient at receiving messages.
Gets the alternative routing method callbacks for this adapter.
The methods if the adapter supports them. Null if this method is not to be used.
An interface to provide a custom implementation of the routing functionality of the
Gets the number of routes in this routing table.
Assigns the status messaging callbacks.
Raise status messages on this callback
Raise exceptions on this callback
Patches the existing routing table with the supplied adapters.
all of the producers
all of the consumers
This method will directly inject measurements into the routing table and use a shared local input adapter. For
contention reasons, it is not recommended this be its default use case, but it is necessary at times.
the sender object
the event arguments
Represents functionality to manage device and measurement metadata for adapters.
Defines the default measurement table name.
Defines the default value for the configuration reload wait timeout.
Defines the default value for the configuration reload wait attempts.
Gets ID of parent device, creating or updating record if needed, for the current instance.
Target instance.
Parent device acronym template. Use '{0}' to reference .
ID of parent device; or, null on failure.
Looks up point tag name from provided .
Target instance.
signal ID to lookup.
Measurement table name used for meta-data lookup.
Point tag name, if found; otherwise, string representation of provided signal ID.
Looks up signal reference from provided .
Target instance.
signal ID to lookup.
Measurement table name used for meta-data lookup.
Signal reference name, if found; otherwise, string representation of provided signal ID.
Looks up or creates measurement key based on provided .
Target instance.
signal ID to lookup.
Measurement ID to use for creating new measurement key.
Source name used for meta-data lookup.
Measurement table name used for meta-data lookup.
Found or newly created measurement key. Failure to create key results in .
This is a metadata first lookup operation.
Looks up associated device acronym and ID from provided .
Target instance.
signal ID to lookup.
Measurement table name used for meta-data lookup.
Device acronym and ID tuple, if found; otherwise, string representation of associated point tag and ID of zero.
Determines if exists in local configuration.
Target instance.
Signal ID to find.
Measurement table name used for meta-data lookup.
true, if is found; otherwise, false.
Determines if exists in local configuration.
Target instance.
Point tag to find./
Signal ID of measurement with specified point tag.
Measurement table name used for meta-data lookup.
true, if is found; otherwise, false.
Determines if exists in local configuration.
Target instance.
Point tag to find./
Signal ID of measurement with specified point tag.
Measurement table name used for meta-data lookup.
true, if is found; otherwise, false.
Gets measurement record, creating it if needed.
Target instance.
Device ID associated with current adapter, or zero if none.
Point tag of measurement.
Alternate tag of measurement.
Signal reference of measurement.
Description of measurement.
Signal type of measurement.
Acronym of target historian for measurement.
Flag that determines if host system should be notified of configuration changes.
Measurement record.
Notifies host system of configuration changes.
Target instance.
Waits for to be loaded in system configuration.
Target instance.
Wait handle to signal when configuration has been reloaded.
Signal IDs to wait for.
Configuration reload wait timeout.
Configuration reload wait attempts.
Measurement table name used for meta-data lookup.
true if are loaded; otherwise, false.
Gets string representation of elapsed wait time for and .
Configuration reload wait timeout.
Configuration reload wait attempts.
String representation of elapsed wait time.
Represents an adapter base class that provides functionality to operate on a 1-second window of data.
Defines the default value for the .
Gets or sets the expected number of input measurements for a instance.
Gets or sets the expected number of output measurements for a instance.
Gets sub-second offsets based on current .
Gets or sets primary keys of input measurements the action adapter expects.
If your adapter needs to receive all measurements, you must explicitly set InputMeasurementKeys to null.
Gets or sets output measurements that the action adapter will produce, if any.
Gets or sets the source measurement table to use for configuration.
Gets or sets input measurement 's for each of the , if any.
Gets or sets output measurement 's for each of the , if any.
Gets the flag indicating if this adapter supports temporal processing.
Returns the detailed status of the .
Initializes .
Processes 1-second data window.
Top of second window timestamp.
1-second data window.
Publish of time-aligned collection of
values that arrived within defined .
Collection of measurements with the same timestamp that arrived within that are ready for processing.
Index of within a second ranging from zero to - 1.
If user implemented publication function consistently exceeds available publishing time (i.e., 1 / seconds),
concentration will fall behind. A small amount of this time is required by the for processing overhead, so actual total time
available for user function process will always be slightly less than 1 / seconds.
A set of methods that can be called to route measurements to an adapter that implements
Note, this method will be called within a synchronized context.
Measurements can be directly passed through to this method without the need for routing/filtering.
Creates .
The standard and default routing table that uses double buffer queues to route measurements.
Instances a new .
Assigns the status messaging callbacks.
Raise status messages on this callback
Raise exceptions on this callback
Gets the number of routes in this routing table.
Patches the existing routing table with the supplied adapters.
all of the producers
all of the consumers
This method will directly inject measurements into the routing table and use a shared local input adapter. For
contention reasons, it is not recommended this be its default use case, but it is necessary at times.
the sender object
the event arguments
Indicates how the have changed from one route calculation to another.
A list of all that did NOT existed in the old route calculation, but do exist in the new route calculation.
A list of all that existed in the old route calculation, and also exist in the new route calculation.
A list of all that existed in the old route calculation, but do NOT exist in the new route calculation.
A union of with .
Creates a
A complete list of all the adapters that existed before.
A complete list of all the adapters that exist now
Represents an alternative routing table that has intentional delays to lower overall CPU utilization.
Contains all consumers for all adapters regardless of if they are optimized or not.
Normal as opposed to optimized ones;
Once this many measurements have been queued, a route operation will not wait the mandatory wait time
and will immediately start the routing process.
Creates a
Gets the number of routes in this routing table.
Assigns the status messaging callbacks.
Raise status messages on this callback
Raise exceptions on this callback
Patches the existing routing table with the supplied adapters.
all of the producers
all of the consumers
This method will directly inject measurements into the routing table and use a shared local input adapter. For
contention reasons, it is not recommended this be its default use case, but it is necessary at times.
the sender object
the event arguments
Represents the routing tables for the Iaon adapters.
Provides status messages to consumer.
is new status message.
Event is raised when there is an exception encountered while processing.
is the exception that was thrown.
Creates a new instance of the class.
Releases the unmanaged resources before the object is reclaimed by .
Log messages generated by an adapter.
Gets or sets the active .
Gets or sets the active .
Gets or sets the active .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Spawn routing tables recalculation.
Input measurement keys restriction.
Set the to null to use full adapter I/O routing demands.
This method will directly inject measurements into the routing table and use a shared local input adapter. For
contention reasons, it is not recommended this be its default use case, but it is necessary at times.
the sender object
the event arguments
Event handler for distributing new measurements in a broadcast fashion.
Event source reference to adapter that generated new measurements.
Event arguments containing a collection of new measurements.
Time-series framework uses this handler to route new measurements to the action and output adapters; adapter will handle filtering.
Raises the event and sends this data to the .
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Starts or stops connect on demand adapters based on current state of demanded input or output signals.
The set of signals to be produced by the chain of adapters to be handled.
Collection of input adapters at start of routing table calculation.
Collection of action adapters at start of routing table calculation.
Collection of output adapters at start of routing table calculation.
Set the to null to use full adapter routing demands.
Determines the set of adapters in the dependency chain that produces the set of signals in the
and returns the set of input signals required by the
adapters in the chain and the set of output signals produced by the adapters in the chain.
The set of signals that must be produced by the dependency chain.
Collection of input adapters at start of routing table calculation.
Collection of action adapters at start of routing table calculation.
Collection of output adapters at start of routing table calculation.
Determines the set of adapters in the dependency chain for all adapters in the system which are either not connect or demand or are demanded.
Collection of input adapters at start of routing table calculation.
Collection of action adapters at start of routing table calculation.
Collection of output adapters at start of routing table calculation.
Represents the base class for action adapters.
This base class acts as a measurement concentrator which time aligns all incoming measurements for proper processing.
Derived classes are expected to override to handle time aligned measurements
and call for any new measurements that may get created.
Provides status messages to consumer.
is new status message.
Event is raised when are updated.
Event is raised when are updated.
Event is raised when adapter is aware of a configuration change.
Provides new measurements from action adapter.
is a collection of new measurements for host to process.
Creates a new .
Gets name of the action adapter.
Gets or sets numeric ID associated with this action adapter.
Gets or sets key/value pair connection information specific to action adapter.
Example connection string using manually defined measurements:
framesPerSecond=30; lagTime=1.0; leadTime=0.5; minimumMeasurementsToUse=-1;
useLocalClockAsRealTime=true; allowSortsByArrival=false;
inputMeasurementKeys={P1:1245;P1:1247;P2:1335};
outputMeasurements={P3:1345,60.0,1.0;P3:1346;P3:1347}
When defined manually, elements in key:
* inputMeasurementKeys are defined as "ArchiveSource:PointID"
* outputMeasurements are defined as "ArchiveSource:PointID,Adder,Multiplier", the adder and multiplier are optional
defaulting to 0.0 and 1.0 respectively.
Example connection string using measurements defined in a table:
framesPerSecond=30; lagTime=1.0; leadTime=0.5; minimumMeasurementsToUse=-1;
useLocalClockAsRealTime=true; allowSortsByArrival=false;
inputMeasurementKeys={FILTER ActiveMeasurements WHERE Company='GSF' AND SignalType='FREQ' ORDER BY ID};
outputMeasurements={FILTER ActiveMeasurements WHERE SignalType IN ('IPHA','VPHA') AND Phase='+'}
Basic filtering syntax is as follows:
{FILTER <TableName> WHERE <Expression> [ORDER BY <SortField>]}
Source tables are expected to have at least the following fields:
Name
Type
Description.
-
ID
NVARCHAR
Measurement key formatted as: ArchiveSource:PointID.
-
PointTag
NVARCHAR
Point tag of measurement.
-
Adder
FLOAT
Adder to apply to value, if any (default to 0.0).
-
Multiplier
FLOAT
Multiplier to apply to value, if any (default to 1.0).
Note that framesPerSecond, lagTime and leadTime are required parameters, all other parameters are optional.
Gets connection info for adapter, if any.
For example, this could return IP or host name of source connection.
Gets or sets based data source available to this .
Gets or sets maximum time system will wait during for initialization.
Set to to wait indefinitely.
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start input demands,
as an example, this would be false for an action adapter that calculated measurement, but true for an action adapter used to archive inputs.
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start output demands,
as an example, this would be true for an action adapter that calculated measurement, but false for an action adapter used to archive inputs.
Gets or sets the number of frames per second.
Valid frame rates for a are greater than 0 frames per second.
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to past measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too old.
This becomes the amount of delay introduced by the concentrator to allow time for data to flow into the system.
LagTime must be greater than zero, but it can be less than one.
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to future measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too advanced.
This becomes the tolerated +/- accuracy of the local clock to real-time.
LeadTime must be greater than zero, but it can be less than one.
Gets or sets primary keys of input measurements the action adapter expects.
If your adapter needs to receive all measurements, you must explicitly set InputMeasurementKeys to null.
Gets or sets output measurements that the action adapter will produce, if any.
Gets or sets values used to filter input measurement keys.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets values used to filter output measurements.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets the flag indicating if this adapter supports temporal processing.
Gets the start time temporal processing constraint defined by call to .
This value will be when start time constraint is not set - meaning the adapter
is processing data in real-time.
Gets the stop time temporal processing constraint defined by call to .
This value will be when stop time constraint is not set - meaning the adapter
is processing data in real-time.
Gets or sets minimum number of input measurements required for adapter. Set to -1 to require all.
Gets or sets flag indicating if the action adapter has been initialized successfully.
Gets settings parsed when was assigned.
Gets flags that determines if class status should be included in status.
Returns the detailed status of the action adapter.
Derived classes should extend status with implementation specific information.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Gets a flag that indicates whether the object has been disposed.
Starts the or restarts it if it is already running.
Stops the .
Examines the concentrator frame queue state of the .
Resets the statistics of the .
Manually sets the initialized state of the .
Desired initialized state.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of this .
Queues a collection of measurements for processing. Measurements are automatically filtered to the defined .
Collection of measurements to queue for processing.
Measurements are filtered against the defined .
Defines a temporal processing constraint for the adapter.
Defines a relative or exact start time for the temporal constraint.
Defines a relative or exact stop time for the temporal constraint.
Defines any temporal parameters related to the constraint.
This method defines a temporal processing constraint for an adapter, i.e., the start and stop time over which an
adapter will process data. Actual implementation of the constraint will be adapter specific. Implementations
should be able to dynamically handle multiple calls to this function with new constraints. Passing in null
for the and should cancel the temporal constraint and
return the adapter to standard / real-time operation.
The and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Serves as a hash function for the current .
A hash code for the current .
Attempts to retrieve the minimum needed number of measurements from the frame (as specified by MinimumMeasurementsToUse)
Source frame for the measurements
Return array of measurements
True if minimum needed number of measurements were returned in measurement array
Remember this function will *only* return the minimum needed number of measurements, no more. If you want to use
all available measurements in your adapter you should just use Frame.Measurements.Values directly.
Note that the measurements array parameter will be created if the reference is null, otherwise if caller creates
array it must be sized to MinimumMeasurementsToUse
Raises the event.
Raises the event.
New status message.
Raises the event with a formatted status message.
Formatted status message.
Arguments for .
This overload combines string.Format and SendStatusMessage for convenience.
Raises the event and sends this data to the .
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises event.
Raises event.
Raises event.
Represents a collection of implementations.
This event will be raised when there are new measurements available from the action adapter.
is collection of new measurements for host to process.
This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
is the total number of unpublished seconds of data.
This event is raised if there are any measurements being discarded during the sorting process.
is the enumeration of values that are being discarded during the sorting process.
Event is raised when temporal support is requested.
Constructs a new instance of the .
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start input demands,
as an example, this would be false for an action adapter that calculated measurement, but true for an action adapter used to archive inputs.
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start output demands,
as an example, this would be true for an action adapter that calculated measurement, but false for an action adapter used to archive inputs.
Gets or sets flag that determines if readonly collections should be converted
to writable so published measurement sets can be augmented by filter adapters.
When filter adapters are detected in the , collections that
output new measurements should convert all readonly measurement collections into
collections that can be modified so that measurements can be removed if needed.
Gets the descriptive status of this .
Initializes the .
Queues a collection of measurements for processing to each implementation in
this .
Measurements to queue for processing.
Raises the event.
New measurements.
Raises the event.
Event source.
New measurements event arguments.
This event handler is overridable to allow derived class interception of all
measurements flowing out of the .
Raises the event.
Total number of unpublished seconds of data in the queue.
Raises the event.
Enumeration of values being discarded.
Raises event.
Wires events and initializes new implementation.
New implementation.
Unwires events and disposes of implementation.
to dispose.
Represents the base class for any adapter.
Default measurement reporting interval.
Default initialization timeout.
Provides status messages to consumer.
is new status message.
Event is raised when there is an exception encountered while processing.
is the exception that was thrown.
Event is raised when are updated.
Event is raised when are updated.
Event is raised when adapter is aware of a configuration change.
Event is raised when is disposed.
Constructs a new instance of the .
Releases the unmanaged resources before the object is reclaimed by .
Log messages generated by an adapter.
Gets or sets the name of this .
Derived classes should provide a name for the adapter.
Gets or sets numeric ID associated with this .
Gets or sets key/value pair connection information specific to this .
Example connection string using manually defined measurements:
inputMeasurementKeys={P1:1245;P1:1247;P2:1335};
outputMeasurements={P3:1345,60.0,1.0;P3:1346;P3:1347}
When defined manually, elements in key:
* inputMeasurementKeys are defined as "ArchiveSource:PointID"
* outputMeasurements are defined as "ArchiveSource:PointID,Adder,Multiplier", the adder and multiplier are optional
defaulting to 0.0 and 1.0 respectively.
Example connection string using measurements defined in a table:
inputMeasurementKeys={FILTER ActiveMeasurements WHERE Company='GSF' AND SignalType='FREQ' ORDER BY ID};
outputMeasurements={FILTER ActiveMeasurements WHERE SignalType IN ('IPHA','VPHA') AND Phase='+'}
Basic filtering syntax is as follows:
{FILTER <TableName> WHERE <Expression> [ORDER BY <SortField>]}
Source tables are expected to have at least the following fields:
Name
Type
Description.
-
ID
NVARCHAR
Measurement key formatted as: ArchiveSource:PointID.
-
PointTag
NVARCHAR
Point tag of measurement.
-
Adder
FLOAT
Adder to apply to value, if any (default to 0.0).
-
Multiplier
FLOAT
Multiplier to apply to value, if any (default to 1.0).
Gets connection info for adapter, if any.
For example, this could return IP or host name of source connection.
Gets or sets based data source available to this .
Gets or sets maximum time system will wait during for initialization.
Set to to wait indefinitely.
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
Gets or sets primary keys of input measurements the expects, if any.
If your adapter needs to receive all measurements, you must explicitly set InputMeasurementKeys to null.
Gets or sets output measurements that the will produce, if any.
Gets the total number of measurements handled thus far by the .
Gets or sets the measurement reporting interval.
This is used to determined how many measurements should be processed before reporting status.
Gets or sets flag indicating if the adapter has been initialized successfully.
Gets or sets enabled state of this .
Base class simply starts or stops based on flag value. Derived classes should
extend this if needed to enable or disable operational state of the adapter based on flag value.
Gets the UTC time this was started.
Gets the UTC time this was stopped.
Gets the flag indicating if this adapter supports temporal processing.
Gets the start time temporal processing constraint defined by call to .
This value will be when start time constraint is not set - meaning the adapter
is processing data in real-time.
Gets the stop time temporal processing constraint defined by call to .
This value will be when stop time constraint is not set - meaning the adapter
is processing data in real-time.
Gets or sets the desired processing interval, in milliseconds, for the adapter.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
interval while a value of 0 means to process data as fast as possible.
Gets the total amount of time, in seconds, that the adapter has been active.
Gets settings parsed when was assigned.
Gets the status of this .
Derived classes should provide current status information about the adapter for display purposes.
Gets a flag that indicates whether the object has been disposed.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Starts the or restarts it if it is already running.
Stops the .
Manually sets the initialized state of the .
Desired initialized state.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of this .
Defines a temporal processing constraint for the adapter.
Defines a relative or exact start time for the temporal constraint.
Defines a relative or exact stop time for the temporal constraint.
Defines any temporal parameters related to the constraint.
This method defines a temporal processing constraint for an adapter, i.e., the start and stop time over which an
adapter will process data. Actual implementation of the constraint will be adapter specific. Implementations
should be able to dynamically handle multiple calls to this function with new constraints. Passing in null
for the and should cancel the temporal constraint and
return the adapter to standard / real-time operation.
The and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Serves as a hash function for the current .
A hash code for the current .
Raises the event.
New status message.
Raises the event with a formatted status message.
Formatted status message.
Arguments for .
This overload combines string.Format and SendStatusMessage for convenience.
Raises the event and sends this data to the .
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises the event.
Processing .
Raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises event.
Raises event.
Raises event.
Safely increments the total processed measurements.
Gets status message with common time-series messaging prefix for given .
Status message.
Message level.
Status message with common time-series messaging prefix for given .
Parses a standard FILTER styles expression into its constituent parts.
Filter expression to parse.
Name of table in filter expression.
Where expression in filter expression.
Sort field, if any, in filter expression.
Total row restriction, if any, in filter expression.
true if filter expression was successfully parsed; otherwise false.
This method can be safely called from multiple threads.
Parses a string formatted as an absolute or relative time tag.
String formatted as an absolute or relative time tag.
representing the parsed string formatted as an absolute or relative time tag.
Relative times are parsed based on an offset to current time (UTC) specified by "*".
The parameter can be specified in one of the following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
-
*+2d
Evaluates to 2 days from .
parameter cannot be null or empty.
does not contain a valid string representation of a date and time.
Loads an or instance's input measurement keys from a specific set of source ID's.
to load input measurement keys for.
Measurement table name used to load input source ID's.
Any existing input measurement keys will be distinctly merged with those associated with specified source ID's.
Loads an or instance's output measurements from a specific set of source ID's.
to load output measurements for.
Measurement table name used to load output source ID's.
Any existing output measurements will be distinctly merged with those associated with specified source ID's.
Parses input measurement keys from connection string setting.
The used to define input measurement keys.
Determines if database access via "SELECT" statement should be allowed for defining input measurement keys (see remarks about security).
Value of setting used to define input measurement keys, typically "inputMeasurementKeys".
Measurement table name used to load additional meta-data; this is not used when specifying a FILTER expression.
User selected input measurement keys.
Security warning: allowing SELECT statements, i.e., setting to true, should only be allowed in cases where SQL
injection would not be an issue (e.g., in places where a user can already access the database and would have nothing to gain via an injection attack).
Parses output measurement keys from connection string setting.
The used to define output measurements.
Determines if database access via "SELECT" statement should be allowed for defining output measurement keys (see remarks about security).
Value of setting used to define output measurements, typically "outputMeasurements".
Measurement table name used to load additional meta-data; this is not used when specifying a FILTER expression.
User selected output measurements.
Security warning: allowing SELECT statements, i.e., setting to true, should only be allowed in cases where SQL
injection would not be an issue (e.g., in places where a user can already access the database and would have nothing to gain via an injection attack).
Parses output measurements from connection string setting.
The used to define output measurements.
Determines if database access via "SELECT" statement should be allowed for defining output measurements (see remarks about security).
Value of setting used to define output measurements, typically "outputMeasurements".
Measurement table name used to load additional meta-data; this is not used when specifying a FILTER expression.
User selected output measurements.
Security warning: allowing SELECT statements, i.e., setting to true, should only be allowed in cases where SQL
injection would not be an issue (e.g., in places where a user can already access the database and would have nothing to gain via an injection attack).
Represents a collection of implementations.
Type of this collection contains.
Provides status messages to consumer.
is new status message.
Event is raised when there is an exception encountered while processing.
is the exception that was thrown.
Event is raised when are updated.
Event is raised when are updated.
Event is raised when adapter is aware of a configuration change.
Event is raised when this is disposed or an in the collection is disposed.
Constructs a new instance of the .
Releases the unmanaged resources before the object is reclaimed by .
Log messages generated by an adapter.
Gets or sets the name of this .
Gets or sets numeric ID associated with this .
Gets or sets flag indicating if the adapter collection has been initialized successfully.
Gets or sets key/value pair connection information specific to this .
Gets or sets based data source used to load each .
Updates to this property will cascade to all items in this .
Table name specified in from is expected
to have the following table column names:
ID, AdapterName, AssemblyName, TypeName, ConnectionString
ID column type should be integer based, all other column types are expected to be string based.
Gets or sets specific data member (e.g., table name) in used to this .
Table name specified in from is expected
to have the following table column names:
ID, AdapterName, AssemblyName, TypeName, ConnectionString
ID column type should be integer based, all other column types are expected to be string based.
Gets or sets the default adapter time that represents the maximum time system will wait during for initialization.
Set to to wait indefinitely.
Gets or sets flag indicating if adapter collection should automatically start items when is false.
Gets or sets primary keys of input measurements the expects, if any.
Gets or sets output measurements that the will produce, if any.
Gets or sets values used to filter input measurement keys.
The collection classes simply track this value if assigned, no automatic action is taken.
Gets or sets values used to filter output measurements.
The collection classes simply track this value if assigned, no automatic action is taken.
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets the flag indicating if this adapter collection supports temporal processing.
For collections this defaults to false.
Gets the start time temporal processing constraint defined by call to .
This value will be when start time constraint is not set - meaning the adapter
is processing data in real-time.
Gets the stop time temporal processing constraint defined by call to .
This value will be when stop time constraint is not set - meaning the adapter
is processing data in real-time.
Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
interval while a value of 0 means to process data as fast as possible.
Gets the total amount of time, in seconds, that the adapter has been active.
Gets the total number of measurements processed thus far by each implementation
in the .
Gets or sets enabled state of this .
Gets the UTC time this was started.
Gets the UTC time this was stopped.
Gets a flag that indicates whether the object has been disposed.
Gets a value indicating whether the is read-only.
Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the .
Gets flag that determines if implementations are automatically initialized
when they are added to the collection.
Gets settings parsed when was assigned.
Gets the descriptive status of this .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Loads all implementations defined in .
Table name specified in from is expected
to have the following table column names:
ID, AdapterName, AssemblyName, TypeName, ConnectionString
ID column type should be integer based, all other column types are expected to be string based.
Note that when calling this method any existing items will be cleared allowing a "re-initialize".
DataSource is null.
DataMember is null or empty.
Attempts to create an from the specified .
containing item information to initialize.
Initialized adapter if successful; otherwise null.
true if item was successfully initialized; otherwise false.
See property for expected column names.
is null.
Attempts to get the adapter with the specified .
ID of adapter to get.
Adapter reference if found; otherwise null.
true if adapter with the specified was found; otherwise false.
Attempts to get the adapter with the specified .
Name of adapter to get.
Adapter reference if found; otherwise null.
true if adapter with the specified was found; otherwise false.
Attempts to get the adapter with the specified given function.
Value of adapter to get.
Function delegate used to test item .
Adapter reference if found; otherwise null.
true if adapter with the specified was found; otherwise false.
Attempts to initialize (or reinitialize) an individual based on its ID.
The numeric ID associated with the to be initialized.
true if item was successfully initialized; otherwise false.
Starts, or restarts, each implementation in this .
Stops each implementation in this .
Resets the statistics of this collection.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of this .
Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.
Defines a relative or exact start time for the temporal constraint.
Defines a relative or exact stop time for the temporal constraint.
Defines any temporal parameters related to the constraint.
This method defines a temporal processing constraint for an adapter, i.e., the start and stop time over which an
adapter will process data. Actual implementation of the constraint will be adapter specific. Implementations
should be able to dynamically handle multiple calls to this function with new constraints. Passing in null
for the and should cancel the temporal constraint and
return the adapter to standard / real-time operation.
The and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Raises the event.
New status message.
Raises the event with a formatted status message.
Formatted status message.
Arguments for .
This overload combines string.Format and SendStatusMessage for convenience.
Raises the event and sends this data to the .
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises the event.
Processing .
Raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises event.
Raises event.
Raises event.
Removes all elements from the .
Inserts an element into the the specified index.
The zero-based index at which item should be inserted.
The implementation to insert.
Assigns a new element to the at the specified index.
The zero-based index for which item should be assigned.
The implementation to assign.
Removes the element at the specified index of the .
The zero-based index of the element to remove.
Wires events and initializes new implementation.
New implementation.
Derived classes should override if more events are defined.
Un-wires events and disposes of implementation.
to dispose.
Derived classes should override if more events are defined.
Represents an attribute that allows a method in an class to be exposed as
an invokable command.
Only public methods will be exposed as invokable.
Creates a new with the specified value.
Assigns the description for this adapter command.
Creates a new with the specified value.
Assigns the description for this adapter command.
Assigns the roles which are allowed to invoke this adapter command.
Gets the description of this adapter command.
Gets the roles which are allowed to invoke this adapter command.
Represents a collection of all implementations (i.e., a collection of 's).
This collection allows all implementations to be managed as a group.
Constructs a new instance of the .
Gets flag that determines if implementations are automatically initialized
when they are added to the collection.
We don't auto-initialize collections added to the since no data source
will be available when the collections are being created.
Gets or sets based data source used to load each .
Updates to this property will cascade to all items in this .
Table name specified in from is expected
to have the following table column names:
ID, AdapterName, AssemblyName, TypeName, ConnectionString
ID column type should be integer based, all other column types are expected to be string based.
Initializes each implementation in this .
Wires events and initializes new implementation.
New implementation.
Derived classes should override if more events are defined.
Create newly defined adapters in the adapter collection configurations.
Remove adapters that are no longer present in the adapter collection configurations.
Attempts to get any adapter in all collections with the specified .
ID of adapter to get.
Adapter reference if found; otherwise null.
Adapter collection reference if is found; otherwise null.
true if adapter with the specified was found; otherwise false.
Attempts to get any adapter in all collections with the specified .
Name of adapter to get.
Adapter reference if found; otherwise null.
Adapter collection reference if is found; otherwise null.
true if adapter with the specified was found; otherwise false.
Attempts to initialize (or reinitialize) an individual based on its ID from any collection.
The numeric ID associated with the to be initialized.
true if item was successfully initialized; otherwise false.
This method traverses all collections looking for an adapter with the specified ID.
This method is not implemented in .
This method is not implemented in .
Represents the base class for simple, non-time-aligned, action adapters.
This base class acts on incoming measurements, in a non-time-aligned fashion, for general processing. If derived
class needs time-aligned data for processing, the class should be used instead.
Derived classes are expected call for any new measurements that may get created.
Default value for the property.
Default value for the property.
Default value for the property.
Default value for the property.
Default value for the property.
Default value for the property.
Default value for the property.
Default value for the property.
Provides new measurements from action adapter.
is a collection of new measurements for host to process.
This event is raised by derived class, if needed, to track current number of unpublished seconds of data in the queue.
is the total number of unpublished seconds of data.
This event is raised if there are any measurements being discarded during the sorting process.
is the enumeration of values that are being discarded during the sorting process.
Creates a new instance of the class.
Gets or sets primary keys of input measurements the expects, if any.
Gets or sets values used to filter input measurement keys.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets values used to filter output measurements.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start input demands,
as an example, this would be false for an action adapter that calculated measurement, but true for an action adapter used to archive inputs.
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start output demands,
as an example, this would be true for an action adapter that calculated measurement, but false for an action adapter used to archive inputs.
Gets or sets the frames per second to be used by the .
This value is only tracked in the , derived class will determine its use.
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to past measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too old.
This becomes the amount of delay introduced by the concentrator to allow time for data to flow into the system.
LagTime must be greater than zero, but it can be less than one.
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to future measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too advanced.
This becomes the tolerated +/- accuracy of the local clock to real-time.
LeadTime must be greater than zero, but it can be less than one.
Gets or sets flag to start tracking the absolute latest received measurement values.
Latest received measurement value will be available via the property.
Gets reference to the collection of absolute latest received measurement values.
Gets or sets flag that determines whether or not to use the local clock time as real time.
Use your local system clock as real time only if the time is locally GPS-synchronized,
or if the measurement values being sorted were not measured relative to a GPS-synchronized clock.
Turn this off if the class is intended to process historical data.
Gets or sets flag that determines whether to fall back on local clock time as real time when time is unreasonable.
This property is only applicable when is false.
Gets the most accurate time value that is available. If = true, then
this function will return . Otherwise, this function will return the timestamp of the
most recent measurement.
Returns the detailed status of the data input source.
Derived classes should extend status with implementation specific information.
Initializes .
Queues a single measurement for processing.
Measurement to queue for processing.
Queues a collection of measurements for processing.
Measurements to queue for processing.
Raises the event.
Raises the event.
Total number of unpublished seconds of data.
Raises the event.
Enumeration of values being discarded.
Represents the abstract interface for any action adapter.
Provides new measurements from action adapter.
is a collection of new measurements for host to process.
This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
is the total number of unpublished seconds of data.
This event is raised if there are any measurements being discarded during the sorting process.
is the enumeration of values that are being discarded during the sorting process.
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start input demands,
as an example, this would be false for an action adapter that calculated measurement, but true for an action adapter used to archive inputs.
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
Action adapters are in the curious position of being able to both consume and produce points, as such the user needs to be able to control how their
adapter will behave concerning routing demands when the adapter is setup to connect on demand. In the case of respecting auto-start output demands,
as an example, this would be true for an action adapter that calculated measurement, but false for an action adapter used to archive inputs.
Gets or sets values used to filter input measurement keys.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null to apply no filter.
Gets or sets values used to filter output measurements.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null to apply no filter.
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Queues measurements for processing. Measurements are automatically filtered to the defined .
Collection of measurements to queue for calculation processing.
Represents the abstract interface for any adapter.
Provides status messages to consumer.
is new status message.
Event is raised when there is an exception encountered while processing.
Implementations of this interface are expected to capture any exceptions that might be thrown by
user code in any processing to prevent third-party code from causing an unhandled exception
in the host. Errors are reported via this event so host administrators will be aware of the exception.
Any needed connection cycle to data adapter should be restarted when an exception is encountered.
is the exception that was thrown.
Event is raised when are updated.
Event is raised when are updated.
Event is raised when adapter is aware of a configuration change.
Gets or sets based data source available to .
Gets or sets key/value pair connection information specific to .
Gets connection info for adapter, if any.
For example, this could return IP or host name of source connection.
Gets settings parsed when was assigned.
Gets or sets name of this .
Gets or sets the numeric ID associated with this .
Gets or sets flag indicating if the adapter has been initialized successfully.
Implementers only need to track this value.
Gets or sets maximum time system will wait during for initialization.
Implementers should use value to wait indefinitely.
Gets or sets flag indicating if adapter should automatically start or connect on demand.
Gets or sets primary keys of input measurements the adapter expects.
Gets or sets output measurements that the adapter will produce, if any.
Gets the total number of measurements processed thus far by the .
Gets the flag indicating if this adapter supports temporal processing.
Gets the start time temporal processing constraint defined by call to .
This value will be when start time constraint is not set - meaning the adapter
is processing data in real-time.
Gets the stop time temporal processing constraint defined by call to .
This value will be when stop time constraint is not set - meaning the adapter
is processing data in real-time.
Gets or sets the desired processing interval, in milliseconds, for the adapter.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
interval while a value of 0 means to process data as fast as possible.
Starts the adapter, if it is not already running.
Stops the adapter.
Gets a short one-line adapter status.
Maximum number of available characters for display.
A short one-line summary of the current adapter status.
Defines a temporal processing constraint for the adapter.
Defines a relative or exact start time for the temporal constraint.
Defines a relative or exact stop time for the temporal constraint.
Defines any temporal parameters related to the constraint.
This method defines a temporal processing constraint for an adapter, i.e., the start and stop time over which an
adapter will process data. Actual implementation of the constraint will be adapter specific. Implementations
should be able to dynamically handle multiple calls to this function with new constraints. Passing in null
for the and should cancel the temporal constraint and
return the adapter to standard / real-time operation.
The and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Defines static extension functions for implementations.
Returns true if has a temporal constraint defined, i.e., either
or is not
set to its default value.
instance to test.
true if has a temporal constraint defined.
Returns the values of the input measurements.
instance input measurements to convert.
values of the input measurements.
Returns the values of the output measurements.
instance output measurements to convert.
values of the output measurements.
Gets a distinct list of input measurement keys for all of the provided adapters.
Type of .
Source enumeration.
Distinct list of input measurement keys for all of the provided adapters.
Gets a distinct list of output measurement keys for all of the provided adapters.
Type of .
Source enumeration.
Distinct list of output measurement keys for all of the provided adapters.
Represents the abstract interface for a collection of adapters.
Gets or sets specific data member (e.g., table name) in used to initialize this .
Table name specified in from is expected
to have the following table column names:
ID, AdapterName, AssemblyName, TypeName, ConnectionString
ID column type should be integer based, all other column types are expected to be string based.
Resets the statistics of this collection.
Attempts to get the adapter with the specified .
ID of adapter to get.
Adapter reference if found; otherwise null.
true if adapter with the specified was found; otherwise false.
Attempts to get the adapter with the specified .
Name of adapter to get.
Adapter reference if found; otherwise null.
true if adapter with the specified was found; otherwise false.
Attempts to create an from the specified .
containing item information to initialize.
Initialized adapter if successful; otherwise null.
true if item was successfully initialized; otherwise false.
Attempts to initialize (or reinitialize) an individual based on its ID.
The numeric ID associated with the to be initialized.
true if item was successfully initialized; otherwise false.
Represents the abstract interface for any incoming adapter.
Provides new measurements from input adapter.
is a collection of new measurements for host to process.
Indicates to the host that processing for the input adapter has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Gets or sets values used to filter output measurements.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Represents the base class for any incoming input adapter.
Derived classes are expected to call when new measurements are received.
Provides new measurements from input adapter.
is a collection of new measurements for host to process.
Indicates to the host that processing for the input adapter has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Constructs a new instance of the .
Gets or sets values used to filter output measurements.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets flag that determines if is connected.
Gets flag that determines if the data input connects asynchronously.
Derived classes should return true when data input source is connects asynchronously, otherwise return false.
Gets or sets the connection attempt interval, in milliseconds, for the data input source.
Returns the detailed status of the data input source.
Derived classes should extend status with implementation specific information.
Gets or sets primary keys of input measurements the expects, if any.
Redefined to hide attributes defined in the base class.
When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Starts this and initiates connection cycle to data input source.
Attempts to connect to data input source.
Derived classes should attempt connection to data input source here. Any exceptions thrown
by this implementation will result in restart of the connection cycle.
Called when data input source connection is established.
Derived classes should call this method manually if is true.
Stops this and disconnects from data input source.
Attempts to disconnect from data input source.
Derived classes should attempt disconnect from data input source here. Any exceptions thrown
by this implementation will be reported to host via event.
Called when data input source is disconnected.
Derived classes should call this method manually if is true.
Raises the event.
Raises the event.
Represents a collection of implementations.
This event will be raised when there are new measurements available from the input data source.
is collection of new measurements for host to process.
Indicates to the host that processing for one of the input adapters has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Creates a new .
Gets or sets flag that determines if readonly collections should be converted
to writable so published measurement sets can be augmented by filter adapters.
When filter adapters are detected in the , collections that
output new measurements should convert all readonly measurement collections into
collections that can be modified so that measurements can be removed if needed.
Gets the descriptive status of this .
Raises the event.
New measurements.
Raises the event.
Event source.
New measurements event arguments.
This event handler is overridable to allow derived class interception of all
measurements flowing out of the .
Raises the event.
Wires events and initializes new implementation.
New implementation.
Unwires events and disposes of implementation.
to dispose.
Represents that abstract interface for any outgoing adapter.
Event is raised every five seconds allowing host to track total number of unprocessed measurements.
Implementations of this interface are expected to report current queue size of unprocessed
measurements so that if queue size reaches an unhealthy threshold, host can take evasive action.
is total number of unprocessed measurements.
Gets or sets values used to filter input measurements.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
Returns a flag that determines if measurements sent to this are
destined for archival.
This property allows the to calculate statistics on how
many measurements have been archived per minute. Historians would normally set this property
to true; other custom exports would set this property to false.
Queues measurements for processing. Measurements are automatically filtered to the defined .
Collection of measurements to queue for processing.
Implementations of this function should remove a range of measurements from the internal measurement queue.
This method is typically only used to curtail size of measurement queue if it's getting too large. If more
points are requested than there are points available - all points in the queue should be removed.
Contains classes that define an adapter interface layer used to route measurements through a cycle of input, sorted actions and queued output.
Represents the base class for any outgoing data stream.
This base class acts as a measurement queue so that output adapters can temporarily go
offline without losing any measurements to be processed. Derived classes are expected to
override to handle queued measurements.
Event is raised every five seconds allowing host to track total number of unprocessed measurements.
Base class reports current queue size of unprocessed measurements so that if queue size reaches
an unhealthy threshold, host can take evasive action.
is total number of unprocessed measurements.
Constructs a new instance of the .
Gets or sets based data source available to this .
Gets or sets whether or not to automatically place measurements back into the processing
queue if an exception occurs while processing. Defaults to false.
Gets or sets values used to filter input measurements.
This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
Set to null apply no filter.
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets the flag that determines if measurements sent to this are destined for archival.
This property allows the to calculate statistics on how many measurements have
been archived per minute. Historians would normally set this property to true; other custom exports would set
this property to false.
Gets the flag indicating if this implementation supports temporal processing.
For output adapters that archive data it is assumed that the desired behavior will be to not support temporal processing
since the data being processed has already been archived (i.e., no need to attempt to rearchive old data). As a result
the default behavior for an output adapter is to not support temporal processing when
is true. If you have an output adapter that you want to support temporal data processing independent of the
value, then override this property and force the base value to the desired state.
Gets or sets the desired processing interval, in milliseconds, for the output adapter.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
interval while a value of 0 means to process data as fast as possible.
Gets flag that determines if the data output stream connects asynchronously.
Derived classes should return true when data output stream connects asynchronously, otherwise return false.
Gets or sets the connection attempt interval, in milliseconds, for the data output adapter.
Gets the operation that calls .
Allows derived class access to internal processing queue.
Returns the detailed status of the data input source. Derived classes should extend status with implementation specific information.
Gets or sets output measurements that the will produce, if any.
Redefined to hide attributes defined in the base class.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Initiates request for metadata refresh for , if implemented.
Executes the metadata refresh in a synchronous fashion.
Starts this and initiates connection cycle to data output stream.
Attempts to connect to data output stream.
Derived classes should attempt connection to data output stream here. Any exceptions thrown
by this implementation will result in restart of the connection cycle.
Called when data output source connection is established.
Derived classes should call this method manually if is true.
Stops this and disconnects from data output stream.
Attempts to disconnect from data output stream.
Derived classes should attempt disconnect from data output stream here. Any exceptions thrown
by this implementation will be reported to host via event.
Called when data input source is disconnected.
Derived classes should call this method manually if is true.
Queues a single measurement for processing. Measurement is automatically filtered to the defined .
Measurement to queue for processing.
Queues a collection of measurements for processing. Measurements are automatically filtered to the defined .
Measurements to queue for processing.
Serializes measurements to data output stream.
Derived classes must implement this function to process queued measurements.
For example, this function would "archive" measurements if output adapter is for a historian.
It is important that consumers "resume" connection cycle if processing fails (e.g., connection
to archive is lost). Here is an example:
protected virtual void ProcessMeasurements(IMeasurement[] measurements)
{
try
{
// Process measurements...
foreach (IMeasurement measurement in measurement)
{
ArchiveMeasurement(measurement);
}
}
catch (Exception)
{
// So long as user hasn't requested to stop, restart connection cycle
if (Enabled)
Start();
}
}
This removes a range of measurements from the internal measurement queue.
This method is typically only used to curtail size of measurement queue if it's getting too large. If more points are
requested than there are points available - all points in the queue will be removed.
Blocks the current thread, if the is connected, until all items
in queue are processed, and then stops processing.
It is possible for items to be added to the queue while the flush is executing. The flush will continue to
process items as quickly as possible until the queue is empty. Unless the user stops queuing items to be
processed, the flush call may never return (not a happy situation on shutdown).
The does not clear queue prior to destruction. If the user fails to call
this method before the class is destructed, there may be items that remain unprocessed in the queue.
Raises the event.
Total measurements in the queue that have not been processed.
Represents a collection of implementations.
Event is raised every five seconds allowing host to track total number of unprocessed measurements.
Each implementation reports its current queue size of unprocessed
measurements so that if queue size reaches an unhealthy threshold, host can take evasive action.
is total number of unprocessed measurements.
Creates a new .
Gets the total number of measurements processed and destined for archive thus far by each
implementation in the .
Returns a flag that determines if all measurements sent to this are
destined for archival.
Queues a collection of measurements for processing to each implementation in
this .
Measurements to queue for processing.
This function removes a range of measurements from the internal measurement queues. Note that the requested
will be removed from each implementation in this
.
Total measurements to remove from the each queue.
This method is typically only used to curtail size of measurement queue if it's getting too large. If more points are
requested than there are points available - all points in the queue will be removed.
Raises the event.
Total measurements in the queue that have not been processed.
Wires events and initializes new implementation.
New implementation.
Unwires events and disposes of implementation.
to dispose.
Represents the two states that an alarm can be in: raised or cleared.
Indicates that an alarm is cleared.
Indicates that an alarm has been raised.
Represents the severity of alarms.
Indicates that an alarm is of no importance.
Indicates that an alarm is informative, but not dangerous.
Indicates that an alarm is not very important.
Indicates that an alarm is somewhat important.
Indicates that an alarm is moderately importance.
Indicates that an alarm is important.
Indicates that an alarm is very important.
Indicates an alarm for a value that is unreasonable.
Indicates than an alarm signifies a dangerous situation.
Indicates an alarm for a value that is latched, i.e., flat-lined.
Indicates that an alarm reports bad data.
Represents the operation to be performed
when testing values from an incoming signal.
Internal range test
External range test
Upper bound
Lower bound
Upper limit
Lower limit
Latched value
Represents an alarm that tests the values of
an incoming signal to determine the state of alarm.
Creates a new instance of the class.
Creates a new instance of the class.
The operation to be performed when testing values from the incoming signal.
Gets or sets the identification number of the alarm.
Gets or sets the tag name of the alarm.
Gets or sets the identification number of the
signal whose value is monitored by the alarm.
Gets or sets the identification number of
the measurements generated for alarm events.
Gets or sets the description of the alarm.
Gets or sets the operation to be performed
when testing values from the incoming signal.
Gets or sets the severity of the alarm.
Gets or sets the value to be compared against
the signal to determine whether to raise the
alarm. This value is irrelevant for the
operation.
Gets or sets a tolerance window around the
to use when comparing
against the value of the signal. This value
is only relevant for the
and operations.
The equal and not equal operations are actually
internal and external range tests based on the setpoint
and the tolerance. The two tests are performed as follows.
- Equal: (value >= SetPoint - Tolerance) && (value <= SetPoint + Tolerance)
- Not equal: (value < SetPoint - Tolerance) || (value > SetPoint + Tolerance)
Gets or sets the amount of time that the
signal must be exhibiting alarming behavior
before the alarm is raised.
Gets or sets the hysteresis used when clearing
alarms. This value is only relevant in greater
than (or equal) and less than (or equal) operations.
The hysteresis is an offset that provides padding between
the point at which the alarm is raised and the point at
which the alarm is cleared. For example, in the case of the
operation:
- Raised: value >= SetPoint
- Cleared: value < SetPoint - Hysteresis
The direction of the offset depends on whether the
operation is greater than (or equal) or less than (or equal).
The hysteresis must be greater than zero.
Gets or sets the current state of the alarm (raised or cleared).
Gets or sets the timestamp of the most recent
measurement that caused the alarm to be raised.
Gets the most recent measurement
that caused the alarm to be raised.
Tests the value of the given measurement to determine
whether the alarm should be raised or cleared.
The measurement whose value is to be tested.
true if the alarm's state changed; false otherwise
Creates a new alarm that is a copy of the current instance.
A new alarm that is a copy of this instance.
2
Creates a new object that is a copy of the current instance.
A new object that is a copy of this instance.
2
Defines common properties and functions for the time-series library.
Folder name for dynamically compiled assemblies.
Represents a base class for implementations.
Occurs when the configuration loader has a message to provide about its current status.
Occurs when the configuration loader encounters a non-catastrophic exception.
Creates a new instance.
Log messages generated by an adapter.
Gets the flag that indicates whether augmentation is supported by this configuration loader.
Loads the entire configuration data set from scratch.
The configuration data set.
Augments the given configuration data set with the changes
tracked since the version of the given configuration data set.
The configuration data set to be augmented.
Raises the event and sends this data to the .
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Represents a configuration loader that gets its configuration from a binary file.
Gets or sets the path to the binary file.
Gets the flag that indicates whether augmentation is supported by this configuration loader.
Loads the entire configuration data set from scratch.
The configuration data set.
Not supported.
Defines a method signature for a bootstrap data source operation.
Connection to database.
Formatted node ID Guid query string.
Latest version of the configuration to which data operations were previously applied.
Optional data operation arguments.
Reference to host status message function.
Reference to host process exception function.
Represents a configuration loader that gets its configuration from a database connection.
Gets or sets the connection string which
defines how to connect to the database.
Gets or sets the data provider string, which determines the
.NET types to use when opening connections to the database.
Gets or sets the string to use in queries when filtering results by node ID.
Gets the flag that indicates whether augmentation is supported by this configuration loader.
Opens the database connection.
Loads the entire configuration data set from scratch.
The configuration data set.
Augments the given configuration data set with the changes
tracked since the version of the given configuration data set.
The configuration data set to be augmented.
Closes the database connection.
Releases all the resources used by the object.
Represents the interface by which the time-series engine's
system configuration is loaded from a configuration source.
Occurs when the configuration loader has a message to provide about its current status.
Occurs when the configuration loader encounters a non-catastrophic exception.
Gets the flag that indicates whether augmentation is supported by this configuration loader.
Loads the entire configuration data set from scratch.
The configuration data set.
Augments the given configuration data set with the changes
tracked since the version of the given configuration data set.
The configuration data set to be augmented.
Represents a configuration loader that queries a web service for its configuration.
Gets or sets the URI for the web service.
Gets the flag that indicates whether augmentation is supported by this configuration loader.
Loads the entire configuration data set from scratch.
The configuration data set.
Not supported.
Represents a configuration loader that gets its configuration from an XML file.
Gets or sets the path to the XML file.
Gets the flag that indicates whether augmentation is supported by this configuration loader.
Loads the entire configuration data set from scratch.
The configuration data set.
Not supported.
Represents an exception related to connection activities.
This exception is used to filter connection exceptions into a separate log since
these types of exceptions can be so frequent when a device is offline.
Creates a new .
Creates a new with the specified .
Exception message.
Creates a new with the specified
and .
Exception message.
Inner exception.
Represents functions to derive related to value and time quality.
Gets derived quality flags from a set of value and time quality vectors.
Boolean vector where flag determines if value quality is good.
Boolean vector where flag determines if time quality is good.
Derived quality flags.
Gets derived quality flags from specified value and time quality.
Flag that determines if value quality is good.
Flag that determines if time quality is good.
Derived quality flags.
Represents a set of meta-data fields for that should rarely change.
This class allows measurement meta-data to be quickly transferred from one to
another. This class is immutable, so any change to these values requires that the class be recreated.
Gets or sets the primary key of this .
Gets or sets the text based tag name of this .
Defines an offset to add to the value.
Implementers should make sure this value defaults to zero.
Defines a multiplicative offset to apply to the value.
Implementers should make sure this value defaults to one.
Gets or sets function used to apply a down-sampling filter over a sequence of values.
Creates a
Gets or sets the primary key of this .
Gets or sets the text based tag name of this .
Defines an offset to add to the value.
Defines a multiplicative offset to apply to the value.
Gets or sets function used to apply a down-sampling filter over a sequence of values.
Creates a new instance of using the provided measurement . All other fields remain the same.
The key to set.
New instance of using the provided measurement .
Creates a new instance of using the provided . All other fields remain the same.
The adder to set.
New instance of using the provided .
Creates a new instance of using the provided and . All other fields remain the same.
The adder to set.
The multiplier to set.
New instance of using the provided and .
Creates a new instance of using the provided . All other fields remain the same.
The multiplier to set.
New instance of using the provided .
Creates a new instance of using the provided . All other fields remain the same.
The tag name to set.
New instance of using the provided .
Creates a new instance of using the provided . All other fields remain the same.
the measurementValueFilter to set.
New instance of using the provided .
Represents an undefined .
Down-sampling method enumeration.
Down-samples to the last measurement received.
Use this option if no down-sampling is needed or the selected value is not critical. This is the fastest option if the incoming and outgoing frame rates match.
Down-samples to the measurement closest to frame time.
This is the typical operation used when performing simple down-sampling. This is the fastest option if the incoming frame rate is faster than the outgoing frame rate.
Down-samples by applying a user-defined value filter over all received measurements to anti-alias the results.
This option will produce the best result but has a processing penalty.
Down-samples to the measurement that has the best quality closest to frame time.
This option chooses the measurement closest to the frame time with the best quality.
Measurement concentrator base class.
This class synchronizes (i.e., sorts by timestamp) real-time measurements.
Note that your lag time should be defined as it relates to the rate at which data is coming
into the concentrator. Make sure you allow enough time for transmission of data over the network
allowing any needed time for possible network congestion. Lead time should be defined as your
confidence in the accuracy of your local clock (e.g., if you set lead time to 2, this means you
trust that your local clock is within plus or minus 2 seconds of real-time.)
This concentrator is designed to sort measurements being transmitted in real-time for data being
sent at rates of at least 1 sample per second. Slower rates (e.g., once every few seconds) are not
supported since sorting data at these speeds would be trivial. There is no defined maximum number
of supported samples per second - but keep in mind that CPU utilization will increase as the
measurement volume and frame rate increase.
Frame rate timer.
One static instance of this internal class is created per encountered frame rate / processing interval.
Create a new class.
Desired frame rate for .
Desired processing interval, if applicable.
When the is set to -1, the frame rate timer interval will be calculated as a distribution
of whole milliseconds over the specified number of . Otherwise the specified
will be used as the timer interval.
Releases the unmanaged resources before the object is reclaimed by .
Gets frames per second for this .
Gets the processing interval defined for the .
Gets reference count for this .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Adds a reference to this .
Tick function to add to event list.
Removes a reference to this .
Tick function to remove from event list.
This event is raised every 5 seconds allowing consumer to track current number of unpublished seconds of data in the queue.
is the total number of unpublished seconds of data.
This event is raised if there is an exception encountered while attempting to process a frame in the sample queue.
is the encountered while parsing the data stream.
Processing will not stop for any exceptions thrown by the user function, but any captured exceptions will be exposed through this event.
This event is raised if there are any measurements being discarded during the sorting process.
is the enumeration of values that are being discarded during the sorting process.
This event is raised when is disposed.
Raised, for the benefit of dependent classes, when lag time is updated.
Raised, for the benefit of dependent classes, when lead time is updated.
Creates a new .
Concentration will not begin until consumer "Starts" concentrator (i.e., calling method or setting
= true).
Creates a new from specified parameters.
Number of frames to publish per second.
Past time deviation tolerance, in seconds - this becomes the amount of time to wait before publishing begins.
Future time deviation tolerance, in seconds - this becomes the tolerated +/- accuracy of the local clock to real-time.
must be greater then 0.
must be greater than zero, but can be specified in sub-second intervals (e.g., set to .25 for a quarter-second lag time).
Note that this defines time sensitivity to past timestamps.
must be greater than zero, but can be specified in sub-second intervals (e.g., set to .5 for a half-second lead time).
Note that this defines time sensitivity to future timestamps.
Concentration will not begin until consumer "Starts" concentrator (i.e., calling method or setting
= true).
Specified argument is outside of allowed value range (see remarks).
Releases the unmanaged resources before the object is reclaimed by .
Log messages generated by an adapter.
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to past measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too old.
This becomes the amount of delay introduced by the concentrator to allow time for data to flow into the system.
LagTime must be greater than zero, but it can be less than one.
Gets defined past time deviation tolerance, in ticks.
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to future measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too advanced.
This becomes the tolerated +/- accuracy of the local clock to real-time.
LeadTime must be greater than zero, but it can be less than one.
Gets or sets flag to start tracking the absolute latest received measurement values.
Latest received measurement value will be available via the property.
Note that enabling this option will slightly increase the required sorting time.
Gets reference to the collection of absolute latest received measurement values.
Gets reference to the last published .
Gets or sets flag that determines if precision timer should be used for frame publication.
Gets or sets the number of frames per second.
Valid frame rates for a are greater than 0 frames per second.
Gets or sets the desired processing interval, in milliseconds, for the adapter.
This property is normally only used when you need the concentrator to send data at faster than real-time speeds,
e.g., faster than the defined . A use case would be pushing historical data through
the concentrator where you want to sort and publish data as quickly as possible.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, e.g.,
a timer interval, over which to process data. A value of -1 means to use the default processing interval, i.e., use
the , while a value of 0 means to process data as fast as possible.
From a real-time perspective the defines its general processing interval based on
the defined property. The frames per second property, however, is more than a basic
processing interval since it is used to define the intervals in one second that will become the time sorting
destination "buckets" used by the concentrator irrespective of the data rate of the incoming data. As an example,
if the frames per second of the concentrator is set to 30 and the source data rate is 60fps, then data will be
down-sampled to 30 frames of sorted incoming data but the assigned processing interval will be used to publish the
frames at the specified rate.
The implemented functionality of the process interval property will be to respond to values in the following way:
Value
Response
-
< 0
In this case the default processing interval has been requested, as a result the
will be set to false and the concentrator processing interval will be defined based on the currently defined
property, e.g., if the frames per second is 30 the processing interval will be 33.33ms.
-
0
In this case the processing interval has been defined to process data as fast as possible, as a result the
property will be set to true and property
will be set to false. With a processing interval of zero data is expected to flow into the concentrator as quick as
it can be provided. The property will still be used to sort data by time into appropriate
frames, but the concentrator will use the reception time of the measurements against the defined lag-time to make sure
needed data has arrived before publication and frames will be published at the same rate of data arrival.
-
> 0
In this case a specific processing interval has been defined for processing data, as a result both the
and properties will be set to true. With
a specifically defined processing interval, data is expected to flow into the concentrator at a similar rate. The
property will still be used to sort data by time into appropriate frames, but the concentrator
will use the reception time of the measurements against the defined lag-time to make sure needed data has arrived before
publication and frames will be published on the specified interval. If multiple frames are ready for publication when the
processing interval executes, then all the ready frames will be published sequentially as quickly as possible.
Gets or sets the maximum frame publication timeout in milliseconds, set to (-1) to wait indefinitely.
The concentrator automatically defines a precision timer to provide the heartbeat for frame publication, however if the system
gets busy the heartbeat signals can be missed. This property defines a maximum wait timeout before reception of the heartbeat
signal to make sure frame publications continue to occur in a timely fashion even when a system is under stress.
This property is automatically defined as 2% more than the number of milliseconds per frame when the
property is set. Users can override this default value to provide custom behavior for this timeout.
Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame.
Desired maximum resolution
Value to assign
-
Seconds
.
-
Milliseconds
.
-
Microseconds
.
-
100-Nanoseconds
0
Assigning values less than zero will be set to zero since minimum possible concentrator resolution is one tick (100-nanoseconds). Assigning
values greater than . will be set to .
since maximum possible concentrator resolution is one second (i.e., 1 frame per second).
Gets or sets a value to indicate whether the concentrator should round to the
nearest frame timestamp rather than rounding down to the nearest timestamps.
Gets or sets the to be used by the concentrator.
The down-sampling method determines the algorithm to use if input is being received at a higher-resolution than the defined output.
Gets the number of ticks per frame.
Gets or sets the expected number of measurements to be assigned to a single frame.
Gets or sets flag that allows system to preemptively publish frames assuming all have arrived.
In order for this property to used, the must be defined.
Gets or sets flag that determines if timestamp reasonability checks should be performed on incoming
measurements (i.e., measurement timestamps are compared to system clock for reasonability using
tolerance).
Setting this value to false will make the concentrator use the latest value received as "real-time"
without validation; this is not recommended in production since time reported by source devices may
be grossly incorrect. For non-production configurations, setting this value to false will allow
concentration of historical data.
Gets or sets flag that determines if concentrator should sort measurements by received time.
Setting this value to true will make concentrator use the timestamp of measurement
reception, which is typically the creation time, for sorting and
publication. This is useful in scenarios where the concentrator will be receiving very large
volumes of data but not necessarily in real-time, such as, reading values from a file where
you want data to be sorted and processed as fast as possible.
Setting this value to true will force to be true
and to be false.
Gets or sets the current enabled state of concentrator.
Current enabled state of concentrator
Concentrator must be started by calling method or setting
= true) before concentration will begin.
Gets the UTC time the concentrator was started.
Gets the UTC time the concentrator was stopped.
Gets the total amount of time, in seconds, that the concentrator has been active.
Gets or sets flag that determines if bad timestamps (as determined by measurement's timestamp quality)
should be ignored when sorting measurements.
Setting this property to true forces system to use timestamps as-is without checking quality.
If this property is true, it will supersede operation of .
Gets or sets flag that determines whether or not to allow incoming measurements with bad timestamps
to be sorted by arrival time.
Value defaults to true, so any incoming measurement with a bad timestamp quality will be sorted
according to its arrival time. Setting the property to false will cause all measurements with a
bad timestamp quality to be discarded. This property will only be considered when
is false.
Value will be forced to false if is true.
Gets or sets flag that determines whether or not to use the local clock time as real-time.
Use your local system clock as real-time only if the time is locally GPS-synchronized,
or if the measurement values being sorted were not measured relative to a GPS-synchronized clock.
If is true, will
always be set to true, even if you try to set it to false.
Gets the most accurate time value that is available. If = true, then
this function will return . Otherwise, this function will return the timestamp of the
most recent measurement, or if no measurement timestamps are within time deviation
tolerances as specified by the value.
Because the measurements being received by remote devices are often measured relative to GPS time, these timestamps
are typically more accurate than the local clock. As a result, we can use the latest received timestamp as the best
local time measurement we have (ignoring transmission delays); but, even these times can be incorrect so we still have
to apply reasonability checks to these times. To do this, we use the local system time and the
value to validate the latest measured timestamp. If the newest received measurement timestamp gets too old or creeps
too far into the future (both validated + and - against defined lead time property value), we will fall back on local
system time. Note that this creates a dependency on a fairly accurate local clock - the smaller the lead time deviation
tolerance, the better the needed local clock accuracy. For example, a lead time deviation tolerance of a few seconds
might only require keeping the local clock synchronized to an NTP time source; but, a sub-second tolerance would
require that the local clock be very close to GPS time.
Gets the total number of measurements ever requested for sorting.
Gets the total number of measurements successfully sorted.
Gets the total number of measurements that have been discarded because of old timestamps
(i.e., measurements that were outside the time deviation tolerance from base time, past or future).
Gets a reference the last that was discarded by the concentrator.
Gets the calculated latency of the last that was discarded by the concentrator.
Gets the total number of published measurements.
Gets the total number of published frames.
Gets the total number of measurements that were sorted by arrival because the measurement reported a bad timestamp quality.
Gets the total number of down-sampled measurements processed by the concentrator.
Gets the total number of missed sorts by timeout processed by the concentrator.
Gets the total number of wait handle expirations encountered due to delayed precision timer releases.
Gets the total number of frames ahead of schedule processed by the concentrator.
Gets the total number of seconds frames have spent in the publication process since concentrator started.
Gets the average required frame publication time, in seconds.
If user publication function, , consistently exceeds available publishing time
(i.e., 1 / ), concentration will fall behind.
Gets detailed state of concentrator frame queue.
Gets current detailed state and status of concentrator for display purposes.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Starts the concentrator, if it is not already running.
Concentrator must be started by calling method or setting
= true) before concentration will begin.
Stops the concentrator.
Resets the statistics of the concentrator.
Returns the deviation, in seconds, that the given number of ticks is from real-time (i.e., ).
Timestamp to calculate distance from real-time.
A value indicating the deviation, in seconds, from real-time.
Returns the deviation, in milliseconds, that the given number of ticks is from real-time (i.e., ).
Timestamp to calculate distance from real-time.
A value indicating the deviation in milliseconds.
Sorts the placing the data point in its proper .
to sort.
Sorts each placing each data point in its proper .
Collection of 's to sort.
Publish of time-aligned collection of values that arrived within the
concentrator's defined .
of measurements with the same timestamp that arrived within that are ready for processing.
Index of within a second ranging from zero to - 1.
If user implemented publication function consistently exceeds available publishing time (i.e., 1 / seconds),
concentration will fall behind. A small amount of this time is required by the for processing overhead, so actual total time
available for user function process will always be slightly less than 1 / seconds.
Creates a new for the given .
Timestamp for new in .
New at given .
Derived classes can override this method to create a new custom . Default
behavior creates a basic to hold synchronized measurements.
Assigns to its associated .
Derived classes can choose to override this method to handle custom assignment of a to
its . Default behavior simply assigns measurement to frame's keyed measurement dictionary:
frame.Measurements[measurement.Key] = measurement;
The that is used.
The type of to use."/>
Raises the event.
Processing .
Raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises the event.
Total number of unpublished seconds of data.
Raises the event.
Enumeration of values being discarded.
Allows derived classes to raise a discarding measurements event.
Console application operations used to host the time-series framework service.
Creates new .
Service host instance.
Runs the console host.
Represents a table lookup for active measurements.
Gets all of the rows with the provided deviceID.
Returns an empty set if the deviceID could not be found.
the deviceID to lookup.
Returns an empty set if the deviceID could not be found.
Gets all of the rows with the provided device name. This will exclude
all ActiveMeasurements that are classified as SignalType='STAT'. This is because
'STAT's are not associated with a device in the database.
Returns an empty set if the deviceID could not be found.
the device to lookup.
Returns an empty set if the device could not be found.
Creates a cached lookup so certain metadata so lookups can occur with quickly.
Gets/Creates the lookup cache for the provided dataset.
The non-null dataset provided by the time-series framework
Lookup cache for the provided dataset.
Gets/Creates the for the provided dataset.
for the provided dataset.
Lookups up metadata record from provided .
Target .
signal ID to lookup.
Measurement table name used for meta-data lookup.
Metadata data row, if found; otherwise, null.
Gets signal type for given measurement key
Target .
Source .
Measurement table name used for meta-data lookup.
as defined for measurement key in data source.
Gets signal types for given measurement keys.
Target .
Source set of values.
Measurement table name used for meta-data lookup.
values for each defined measurement key as configured in data source.
Gets signal types for given measurement keys.
Target .
Source set of values.
Measurement table name used for meta-data lookup.
values for each defined measurement key as configured in data source.
Represents a lookup cache for adapter data source data.
Table lookup for active measurements.
Defines static extension functions for implementations.
These helper functions map to the previously defined corresponding properties to help with the transition of .
Returns true if is not set.
instance to test.
true if is not set.
Returns true if is not set.
instance to test.
true if is not set.
Returns true if is set.
instance to test.
true if is set.
Gets derived quality flags from a set of source measurements.
Source measurements.
Derived quality flags.
Returns true if is set.
instance to test.
true if is not set.
Returns true if is set.
instance to test.
true if is not set.
Returns the measurement ID if defined, otherwise the run-time signal ID associated with the measurement key.
instance to test.
Measurement ID if defined, otherwise the run-time signal ID associated with the measurement key.
Returns the values of a enumeration.
enumeration to convert.
values of the enumeration.
Gets a unique (run-time only) signal type ID for the given useful for sorting.
to obtain signal type for.
that contains measurement metadata.
Unique (run-time only) signal type ID for the given .
Sets the tag name for a .
to create new for.
New tag name value to assign to measurement's metadata.
Sets the associated for a .
to create new for.
New measurement key value to assign to measurement's metadata.
Sets the adder (i.e., "b" of y = mx + b) for a .
to create new for.
New adder value to assign to measurement's metadata.
Sets the multiplier (i.e., "m" of y = mx + b) for a .
to create new for.
New multiplier value to assign to measurement's metadata.
Gets a single column of measurement data from a two dimensional data window.
Target data window.
Index of column to return.
All values from in .
Created on field.
Created by field.
Updated on field.
Updated by field.
Represents the process that generates correctness reports for the time-series service.
Creates a new instance of the class.
Represents the process that generates completeness reports for the time-series service.
Creates a new instance of the class.
Gets or sets the minimum percentage of measurements received from devices in level 4.
Gets or sets the minimum percentage of measurements received from devices in level 3.
Gets or sets the alias for the level 4 category.
Gets or sets the alias for the level 3 category.
Gets or sets the option to generate a csv report along with pdf report.
Gets the current status details about reporting process.
Loads saved settings from the config file.
Saves settings to the config file.
Gets the command line arguments for the reporting process.
Applies any received command line arguments for the reporting process.
Received command line arguments.
Determines whether the given path is a path to a report, based on the file name.
Defines an interface for reporting processes.
Gets report type (i.e., name) for this reporting process.
Gets or sets the path to the archive file to which the statistics required for reporting are archived.
Gets or sets the directory to which reports will be written.
Gets or sets the title to be displayed on reports.
Gets or sets the name of the company to be displayed on reports.
Gets or sets the minimum lifetime of a report
since the last time it was accessed, in days.
Gets or sets flag to enable e-mailing of reports.
Gets or sets SMTP server to use when e-mailing reports.
Gets or sets the "from" address to use when e-mailing reports.
Gets or sets the comma separated "to" addresses to use when e-mailing reports.
Returns the list of reports that are available from the report location.
The list of generated reports.
Returns the list of reports which are in the queue but are yet to be generated.
The list of pending reports.
Queues up a report to be generated on a separate thread.
The date of the report to be generated.
Flag that determines if report should be e-mailed, if enabled.
Deletes reports from the that have been idle for the length of the .
Gets the command line arguments for the reporting process.
Gets the command line arguments for the reporting process for a given report date.
The date of the report to be generated.
Flag that determines if report should be e-mailed, if enabled.
Applies any received command line arguments for the reporting process.
Received command line arguments.
Represents the base functionality for reporting processes.
Creates a new instance of the class.
Report type - passed into StatHistorianReportGenerator.
Determines whether the object settings are to be persisted to the config file.
Gets report type, i.e., basically the report name associated with this reporting process.
This value is passed to StatHistorianReportGenerator as "reportType" parameter.
Gets or sets the category name under which the object settings are persisted in the config file.
Gets or sets the path to the archive file to which
the statistics required for reporting are archived.
Gets or sets the directory to which reports will be written.
Gets or sets the title to be displayed on reports.
Gets or sets the name of the company to be displayed on reports.
Gets or sets the minimum lifetime of a report
since the last time it was accessed, in days.
Gets or sets flag to enable e-mailing of reports.
Gets or sets SMTP server to use when e-mailing reports.
Gets or sets the "from" address to use when e-mailing reports.
Gets or sets the comma separated "to" addresses to use when e-mailing reports.
Gets or sets the username used to authenticate to the SMTP server.
Gets or sets the password used to authenticate to the SMTP server.
Gets or sets the password used to authenticate to the SMTP server as a secure string.
Gets the current status details about reporting process.
Returns the list of reports that are available from the report location.
The list of generated reports.
Returns the list of reports which are in the queue but are yet to be generated.
The list of pending reports.
Queues up a report to be generated on a separate thread.
The date of the report to be generated.
Flag that determines if report should be e-mailed, if enabled.
Deletes reports from the that have
been idle for the length of the .
Loads saved settings from the config file.
Saves settings to the config file.
Executes the reporting process to generate the report.
Gets the command line arguments for the reporting process.
Gets the command line arguments for the reporting process for a given report date.
The date of the report to be generated.
Flag that determines if report should be e-mailed, if enabled.
Applies any received command line arguments for the reporting process.
Received command line arguments.
Determines whether the given path is a path to a report, based on the file name.
Determines who is the owner of the given process.
Represents a collection of items.
Gets the descriptive status of this .
Loads available implementations.
New report process handler to call when new implementations are loaded.
Exception handler, if any, to call when type creation fails; otherwise, if null any exceptions will be thrown.
Finds the for the specified name.
Name of the report type to find.
The for the specified name, if found;
otherwise, null if not found.
Inserts an element into the at the specified index.
The zero-based index at which should be inserted.
The object to insert. The value can be null for reference types.
is less than zero. -or-
is greater than .
Replaces the element at the specified index.
The zero-based index of the element to replace.
The new value for the element at the specified index. The value can be null for reference types.
is less than zero. -or-
is greater than .
Implementation of a basic .
A frame represents a collection of measurements at a given time.
Constructs a new given the specified parameters.
Timestamp, in ticks, for this .
Expected number of measurements for the .
Constructs a new given the specified parameters.
Timestamp, in ticks, for this .
Initial set of measurements to load into the , if any.
Keyed measurements in this .
Gets or sets published state of this (pre-processing).
Gets or sets total number of measurements that have been sorted into this .
If this property has not been assigned a value, the property will return measurement count.
Gets or sets exact timestamp, in , of the data represented in this .
The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets the life-span of this since its creation.
Gets timestamp, in ticks, of when this was created.
Gets or sets reference to last measurement that was sorted into this .
Create a copy of this and its measurements.
The measurement dictionary of this is synclocked during copy.
A cloned .
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ;
otherwise, false.
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ;
otherwise, false.
Compares the with an .
The to compare with the current .
A 32-bit signed integer that indicates the relative order of the objects being compared.
This implementation of a basic frame compares itself by timestamp.
Compares the with the specified .
The to compare with the current .
A 32-bit signed integer that indicates the relative order of the objects being compared.
is not an .
This implementation of a basic frame compares itself by timestamp.
Serves as a hash function for the current .
A hash code for the current .
Hash code based on timestamp of frame.
Compares two timestamps for equality.
The left hand operand.
The right hand operand.
A representing the result of the operation.
Compares two timestamps for inequality.
The left hand operand.
The right hand operand.
A representing the result of the operation.
Returns true if left timestamp is greater than right timestamp.
The left hand operand.
The right hand operand.
A representing the result of the operation.
Returns true if left timestamp is greater than or equal to right timestamp.
The left hand operand.
The right hand operand.
A representing the result of the operation.
Returns true if left timestamp is less than right timestamp.
The left hand operand.
The right hand operand.
A representing the result of the operation.
Returns true if left timestamp is less than or equal to right timestamp.
The left hand operand.
The right hand operand.
A representing the result of the operation.
Represents a real-time queue of instances used by the class.
Creates a new .
Releases the unmanaged resources before the object is reclaimed by .
Gets or sets the number of frames per second to be used by .
Valid frame rates are greater than 0 frames per second.
Gets or sets the maximum time resolution to use when sorting measurements by timestamps into their proper destination frame.
Gets or sets a value to indicate whether to round to the nearest
frame timestamp rather than rounding down to the nearest timestamps.
Gets or sets the to be used by the .
Returns the next in the , if any.
This property is tracked separately from the internal frame collection, as a
result this property may be called at any time without a locking penalty.
Gets the last processed in the .
This property is tracked separately from the internal frame collection, as a
result this property may be called at any time without a locking penalty.
Returns the total number of frames in the .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Examines and returns the status of the .
Number of expected measurements per frame.
Clears the .
Removes current frame from the after it has been processed and assigns a new .
Gets from the queue with the specified timestamp, in ticks. If no frame exists for
the specified timestamp, one will be created.
Timestamp, in ticks, for which to get or create .
Ticks can be any point in time so long time requested is greater than time of last published frame; this queue is
used in a real-time scenario with time moving forward. If a frame is requested for an old timestamp, null will
be returned. Note that frame returned will be "best-fit" for given timestamp based on .
An existing or new from the queue for the specified timestamp.
Represents a device that acts as a source of s.
Gets or sets total data quality errors of this .
Gets or sets total time quality errors of this .
Gets or sets total device errors of this .
Gets or sets total measurements received for this .
Gets or sets total measurements expected to have been received for this .
Gets or sets the number of measurements received while this was reporting errors.
Gets or sets the number of measurements (per frame) defined for this .
Abstract frame interface representing a collection of measurements at an exact moment in time.
Keyed measurements in this .
Represents a concurrent dictionary of measurements, keyed by .
Gets or sets published state of this (pre-processing).
Gets or sets total number of measurements that have been sorted into this .
If this property has not been assigned a value, implementers should return measurement count.
Gets or sets exact timestamp, in , of the data represented in this .
The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets the life-span of this since its creation.
Gets timestamp, in ticks, of when this was created.
Gets or sets reference to last that was sorted into this .
This value is used to help monitor slow moving measurements that are being sorted into the .
Implementers need only track the value.
Method signature for function used to apply a value filter over a sequence of values.
Sequence of values over which to apply filter.
Result of filter applied to sequence of values.
Measurement state flags.
Defines normal state.
Defines bad data state.
Defines suspect data state.
Defines over range error, i.e., unreasonable high value.
Defines under range error, i.e., unreasonable low value.
Defines alarm for high value.
Defines alarm for low value.
Defines warning for high value.
Defines warning for low value.
Defines alarm for flat-lined value, i.e., latched value test alarm.
Defines comparison alarm, i.e., outside threshold of comparison with a real-time value.
Defines rate-of-change alarm.
Defines bad value received.
Defines calculated value state.
Defines calculation error with the value.
Defines calculation warning with the value.
Defines reserved quality flag.
Defines bad time state.
Defines suspect time state.
Defines late time alarm.
Defines future time alarm.
Defines up-sampled state.
Defines down-sampled state.
Defines discarded value state.
Defines reserved time flag.
Defines user defined flag 1.
Defines user defined flag 2.
Defines user defined flag 3.
Defines user defined flag 4.
Defines user defined flag 5.
Defines system error state.
Defines system warning state.
Defines measurement error flag.
Represents an interface for an abstract measurement value measured by a device at an exact time.
This interface abstractly represents a measured value at an exact time interval.
Gets or sets associated metadata values for the .
Gets or sets the primary key of this .
Gets or sets the text based tag name of this .
Gets the adjusted numeric value of this , taking into account the specified and offsets.
Implementers need to account for and in return value, e.g.:
return * +
Defines an offset to add to the value.
Implementers should make sure this value defaults to zero.
Defines a multiplicative offset to apply to the value.
Implementers should make sure this value defaults to one.
Gets or sets associated with this .
Gets the life-span of this since its creation.
Gets timestamp, in ticks, of when this was created.
Gets or sets function used to apply a down-sampling filter over a sequence of values.
Represents the absolute latest measurement values received by a implementation.
Creates a new instance of the class.
Releases the unmanaged resources before the object is reclaimed by .
Gets or sets the for the when
timestamp is outside defined Lag/Lead time bounds.
Gets or sets the to apply to the when
is set to and
timestamp is outside defined Lag/Lead time bounds.
We retrieve adjusted measurement values within time tolerance of concentrator real-time.
A representing the measurement ID.
A representing the adjusted measurement value.
Returns collection of measurement ID's.
Returns ID collection for measurement tags.
Returns the minimum value of all measurements.
This is only useful if all measurements represent the same type of measurement.
Returns the maximum value of all measurements.
This is only useful if all measurements represent the same type of measurement.
Gets or sets function to return real-time.
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to past measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too old.
LagTime must be greater than zero, but it can be less than one.
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
Defines the time sensitivity to future measurement timestamps.
The number of seconds allowed before assuming a measurement timestamp is too advanced.
LeadTime must be greater than zero, but it can be less than one.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Returns measurement list of specified tag, if it exists.
A that indicates the tag to use.
A collection of measurement keys.
Store new measurement.
New measurement value to update.
Value is only stored if it is newer than the cached value.
Retrieves the specified immediate temporal measurement, creating it if needed.
based signal ID of measurement.
A object.
Retrieves the specified immediate temporal measurement, creating it if needed.
Source value.
A object.
Clears the existing measurement cache.
Defines tagged measurements from a data table.
Expects based tag field to be aliased as "Tag" and based measurement ID field to be aliased as "ID".
A to use for defining the tagged measurements.
Associates a new measurement ID with a tag, creating the new tag if needed.
Allows you to define "grouped" points so you can aggregate certain measurements.
A to represent the key.
A ID to associate with the tag.
Calculates an average of all measurements.
This is only useful if all measurements represent the same type of measurement.
An value to get the count of values averaged.
A value representing the average of the measurements.
Calculates an average of all measurements associated with the specified tag.
An value to get the count of values averaged.
The type of measurements to average.
A value representing the average of the tags.
Returns the minimum value of all measurements associated with the specified tag.
A value representing the tag minimum.
The tag group to evaluate.
Returns the maximum value of all measurements associated with the specified tag.
A value representing the tag maximum.
The tag group to evaluate.
Updates the tracked temporal measurements lag time.
New lag time.
Updates the tracked temporal measurements lead time.
New lead time.
Defines a common installer class for the applications based on the time-series framework.
Users may choose to only install service application or its management tools, in either case common
installation steps need to occur, so these steps are managed in this one common base class.
Gets associated application configuration file name.
Called when system settings are loaded.
This method will only be called if implementor overrides with a valid config name.
Open xml document containing configuration settings.
Xml node containing system settings.
Installs the class.
Current state information.
Represents the fundamental binary value interface for a time-series value.
Gets or sets the based signal ID of this .
This is the fundamental identifier of the .
Gets or sets the raw value of this .
Gets or sets exact timestamp, in ticks, of the data represented by this .
The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001.
Get the hash code for the .
Hash code for the .
Implementers should always return the hash code based on of measurement.
Represents the fundamental typed interface for a time-series value.
of the time-series value.
Gets or sets the raw typed value of this .
Represents a basic measurement implementation.
Constructs a new using default settings.
Gets the based signal ID of the implementation.
Gets or sets the raw measurement value that is not offset by and .
Raw value of this (i.e., value that is not offset by and ).
Gets or sets exact timestamp, in ticks, of the data represented by this .
The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets or sets associated metadata values for the implementation.
Gets the primary of this implementation.
Gets the text based tag name of this implementation.
Gets an offset to add to the measurement value. This defaults to 0.0.
Gets a multiplicative offset to apply to the measurement value. This defaults to 1.0.
Gets the adjusted numeric value of this measurement, taking into account the specified and offsets.
Note that returned value will be offset by and .
offset by and (i.e., * + ).
Gets or sets associated with this .
Gets function used to apply a down-sampling filter over a sequence of values.
Gets the life-span of this since its creation.
Gets timestamp, in ticks, of when this was created.
Returns a that represents the current .
A that represents the current .
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ;
otherwise, false.
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ;
otherwise, false.
Compares the with an .
The to compare with the current .
A 32-bit signed integer that indicates the relative order of the objects being compared.
Measurement implementations should compare by hash code.
Compares the with the specified .
The to compare with the current .
A 32-bit signed integer that indicates the relative order of the objects being compared.
is not an .
Measurement implementations should compare by hash code.
Serves as a hash function for the current .
A hash code for the current .
Hash code based on value of measurement.
Compares two values for equality.
A left hand operand.
A right hand operand.
A boolean representing the result.
Compares two values for inequality.
A left hand operand.
A right hand operand.
A boolean representing the result.
Returns true if left value is greater than right value.
A left hand operand.
A right hand operand.
A boolean representing the result.
Returns true if left value is greater than or equal to right value.
A left hand operand.
A right hand operand.
A boolean representing the result.
Returns true if left value is less than right value.
A left hand operand.
A right hand operand.
A boolean representing the result.
Returns true if left value is less than or equal to right value.
A left hand operand.
A right hand operand.
A boolean representing the result.
Represents an undefined measurement.
Creates a copy of the specified measurement.
Specified measurement to clone.
A copy of the object.
Creates a copy of the specified measurement using a new timestamp.
Specified measurement to clone.
New timestamp, in ticks, for cloned measurement.
A copy of the object.
Creates a copy of the specified measurement using a new value and timestamp.
Specified measurement to clone.
New value for cloned measurement.
New timestamp, in ticks, for cloned measurement.
A copy of the object.
Creates a copy of the specified measurement using a new value, timestamp and state flags.
Specified measurement to clone.
New value for cloned measurement.
New timestamp, in ticks, for cloned measurement.
New state flags for cloned measurement.
Determines if should assigned as new (default) or be Or'd with existing flags.
A copy of the object.
Returns a that represents the specified .
to convert to a representation.
Set to true to include measurement's tag name, if defined; otherwise set to false.
A that represents the specified .
Calculates an average of the specified sequence of values.
Sequence of values over which to run calculation.
Average of the specified sequence of values.
Returns the majority value of the specified sequence of values.
Sequence of values over which to run calculation.
Majority value of the specified sequence of values.
Calculates an average of the specified sequence of phase angle values.
Sequence of values over which to run calculation.
Average of the specified sequence of phase angle values.
Phase angles wrap, so this algorithm takes the wrapping into account when calculating the average.
Represents a primary key for a measurement.
Gets or sets ID of signal associated with this .
Gets or sets the numeric ID of this .
Gets or sets the source of this .
This value is typically used to track the archive name in which the measurement, that this represents, is stored.
A unique ID that is assigned at runtime to identify this instance of .
This value will change between life cycles, so it cannot be used to compare
instances that are running out of process or in a separate .
Since each is only tied to a single object,
this provides another unique identifier that is zero indexed.
This allows certain optimizations such as array lookups.
Gets the as they appear in the primary .
This is to be considered the reference value. Adapters are free to change this inside specific instances
This value should only be updated upon change in the primary data source using .
Updates the values of the .
Gets or sets the text based tag name.
Defines an offset to add to the value.
Defines a multiplicative offset to apply to the value.
Defines the to use when downsampling this type of value.
Returns a that represents the current .
A that represents the current .
Serves as a hash function for the current .
A hash code for the current .
Represents an undefined measurement key.
Constructs a new given the specified parameters.
ID of associated signal, if defined.
A string representation of the .
cannot be empty
The value is not in the correct format for a value.
Constructs a new given the specified parameters.
ID of associated signal, if defined.
Source of the measurement that this represents (e.g., name of archive).
Numeric ID of the measurement that this represents.
cannot be empty.
cannot be null.
Constructs a new given the specified parameters.
ID of associated signal, if defined.
A string representation of the .
The measurement key that was created or updated or .
True if the measurement key was successfully created or updated, false otherwise.
cannot be empty.
Measurement key Source cannot be null.
Constructs a new given the specified parameters.
ID of associated signal, if defined.
Source of the measurement that this represents (e.g., name of archive).
Numeric ID of the measurement that this represents.
The measurement key that was created or updated or .
True if the measurement key was successfully created or updated, false otherwise.
cannot be empty.
cannot be null.
Looks up the measurement key associated with the given signal ID.
The signal ID of the measurement key.
The measurement key associated with the given signal ID.
If no measurement key is found with the given signal ID,
this method returns .
Looks up the measurement key associated with the given source and ID.
The source of the signal.
The source-specific unique integer identifier.
The measurement key associated with the given source and ID.
If no measurement key is found with the given source and ID,
this method returns .
Performs a lookup by signal ID and, failing that, attempts to create
the key using the given signal ID and the parsed source, and ID.
The signal ID of the key to be looked up.
A string representation of the .
If the lookup succeeds, an existing measurement key with a matching signalID.
If creation succeeds, a new measurement key with matching signal ID, source, and ID.
Otherwise, .
Performs a lookup by signal ID and, failing that, attempts to
create the key using the given signal ID, source, and ID.
The signal ID of the key to be looked up.
The source to use for the key if the lookup fails.
The ID to use for the key if the lookup fails.
If the lookup succeeds, an existing measurement key with a matching signalID.
If creation succeeds, a new measurement key with matching signal ID, source, and ID.
Otherwise, .
Performs a lookup by source and, failing that, attempts to create
the key using a newly generated signal ID and the parsed source and ID.
A string representation of the .
If the lookup succeeds, an existing measurement key with a matching signalID.
If creation succeeds, a new measurement key with matching signal ID, source, and ID.
Otherwise, .
Performs a lookup by source and, failing that, attempts to create
the key using a newly generated signal ID and the given source and ID.
The source to use for the key if the lookup fails.
The ID to use for the key if the lookup fails.
If the lookup succeeds, an existing measurement key with a matching signalID.
If creation succeeds, a new measurement key with matching signal ID, source, and ID.
Otherwise, .
Converts the string representation of a into its value equivalent.
A string representing the to convert.
A value equivalent the representation contained in .
The value is not in the correct format for a value.
Attempts to convert the string representation of a into its value equivalent.
A string representing the to convert.
Output in which to stored parsed value.
A true if representation contained in could be parsed; otherwise false.
Establish default cache.
The database connection.
The database adapter type.
Measurement table name used to load measurement key cache.
Source tables are expected to have at least the following fields:
ID NVARCHAR Measurement key formatted as: ArchiveSource:PointID
SignalID GUID Unique identification for measurement
Creates the undefined measurement key. Used to initialize .
Attempts to split the given string representation
of a measurement key into a source and ID pair.
Contains classes used to abstractly define time-series measured values and provide mechanisms for managing measurements.
Windows API methods available to time-series library.
Precision input timer.
This class is used to create highly accurate simulated data inputs aligned to the local clock.
One static instance of this internal class is created per encountered frame rate.
Create a new class.
Desired frame rate for .
Releases the unmanaged resources before the object is reclaimed by .
Gets frames per second for this .
Gets array of frame millisecond times for this .
Gets reference count for this .
Gets number of resynchronizations that have occurred for this .
Gets time of last frame, in ticks.
Gets a reference to the frame wait handle.
Gets or sets function used to handle exceptions.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Adds a reference to this .
Removes a reference to this .
Attach to a for the specified .
Desired frames per second for the input timer.
Optional delegate to handle exception reporting from the timer.
/// A that can be used for the specified .
Detach from the .
Timer instance to detach from.
Timer reference will be set to null after detach.
Represents a client that can remotely access the time-series framework service host.
Creates a new instance of the class.
Releases the unmanaged resources before the object is reclaimed by .
Initializes the remoting client, client helper, and error logger.
Handles service start event.
Service start arguments.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Client helper authentication success reception handler.
Sending object.
Event argument.
Client helper authentication failure reception handler.
Sending object.
Event argument.
Client helper service update reception handler.
Sending object.
Event argument containing update type and associated message data.
Client helper service response reception handler.
Sending object.
Event argument containing the service response.
Client helper telnet session established handler.
Sending object.
Event arguments, if any.
Client helper telnet session terminated handler.
Sending object.
Event arguments, if any.
Helper class for calculating device statistics.
The type of the devices whose statistics are to be calculated.
Creates a new instance of the class.
The device whose statistics are to be calculated using this helper.
Gets the device whose statistics are being calculated using this helper.
Gets or sets the number of measurements expected to be received from the device per second.
Increases the count of the number of measurements received from the device.
The number of measurements received from the device since the last time this method was called.
Call this each time measurements have been received by the device in order
to properly track the statistic.
Increases the count of the number of measurements received while the device is reporting errors.
The number of measurements received while the device is reporting errors since the last time this method was called.
Call this each time measurements with errors have been received by the device in order
to properly track the statistic.
Marks the latest timestamp of device measurements used to calculate global timestamp statistics.
Latest timestamp of device measurements.
Updates the statistics for the number of measurements received and the number
of measurements expected in the wrapped by this helper.
Call this periodically, preferably on a slow timer (e.g., once per second),
in order to update the ,
, and
statistics.
Updates the statistics for the number of measurements received and the number
of measurements expected in the wrapped by this helper.
The current time, in ticks.
Call this periodically, preferably on a slow timer (e.g., once per second),
in order to update the ,
, and
statistics. This method is preferred
when tracking statistics for multiple s to reduce the number
of calls to .
Resets the member variables used to track
statistics for the device wrapped by this helper.
Call this when the connection to a device has been
reset to mark a starting point for statistics gathering.
Since the method keeps track
of the time it was last called, it is necessary to call
this method during long periods of downtime where Update
was not being called in order to avoid momentary, unexpectedly
large values to be calculated for measurements expected.
Resets the member variables used to track
statistics for the device wrapped by this helper.
The current time, in ticks.
Call this when the connection to a device has been
reset to mark a starting point for statistics gathering.
Since the method keeps track
of the time it was last called, it is necessary to call
this method during long periods of downtime where Update
was not being called in order to avoid momentary, unexpectedly
large values to be calculated for measurements expected.
This method is preferred when tracking statistics for multiple
s to reduce the number of calls to
.
Method signature for function used to calculate a statistic for a given object.
Source object.
Any needed arguments for statistic calculation.
Actual calculated statistic.
Represents a statistic calculation.
The method to be called to calculate the statistic.
The name of the source of the statistic.
The index of the signal associated with the statistic.
The arguments to be passed into the statistic calculation function.
Target data type of the statistic.
Represents the engine that computes statistics within applications of the TimeSeriesFramework.
Event is raised before statistics calculation.
Event is raised after statistics calculation.
Event is raised when a new statistics source is registered.
Event is raised when a statistics source is unregistered.
Creates a new instance of the class.
Gets or sets based data source available to the .
Returns the detailed status of the statistics engine.
Initializes .
Queues a collection of measurements for processing.
Measurements to queue for processing.
Starts the or restarts it if it is already running.
Stops the .
Loads or reloads system statistics.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of this .
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Static initialization of class.
Gets the statistic measurements and latest values that are registered with the active statistics engine.
Registers the given adapter with the statistics engine as a source of statistics.
The source of the statistics.
The category of the statistics.
The acronym used in signal references.
Format string used to name statistic measurements for this source.
Registers the given object with the statistics engine as a source of statistics.
The source of the statistics.
The name of the source.
The category of the statistics.
The acronym used in signal references.
Format string used to name statistic measurements for this source.
Unregisters the given source, removing it from the list of
statistic sources so that it no longer generates statistics.
The adapter to be unregistered with the statistics engine.
Sources that implement do not need to
explicitly unregister themselves from the statistics engine.
The engine automatically unregisters them by attaching to the
event.
Attempts to lookup statistic source and signal index from a measurement .
Signal reference.
Statistic source category as defined in Statistics table Source column.
Statistic signal index as defined in Statistics table SignalIndex column.
true if lookup succeeds; otherwise, false.
The statistic source acronyms used in measurement signal references are defined dynamically by
statistic sources during registration. This function returns the source category, as defined in
the Statistic table, for a given signal reference to allow for reverse lookups. As a result,
user will need to make sure that all statistic sources have been registered before calling
this function in order to receive accurate results.
Determines whether the given signal reference matches the
signal reference regular expression using the given suffix.
The signal reference to be matched against the regular expression.
The suffix used by a particular type of statistic.
Flag indicating whether the signal reference matches the regular expression.
The format for signal reference of statistics is: ACRONYM!SUFFIX-ST#,
where ACRONYM is the acronym of the measurement's source, SUFFIX
is the suffix given as a parameter to this method, and # is an index
used to differentiate between statistics with the same source and type.
Represents an object that can track the current and previous
state of a statistic and get the difference between them.
Creates a new .
Name of statistic.
Gets the statistical difference between current and previous statistic value.
Difference from last cached statistic value.
Caches statistic values to provide the difference between the
current and previous values of any statistic given that
statistic's source, name, and current value.
Creates a new instance of the .
Gets the statistical difference between current and previous statistic value.
Source Device.
Current statistic value.
Name of statistic calculation.
Difference from last cached statistic value.
Defines a data operations to be performed at startup.
Delegates control to the data operations that are to be performed at startup.
Data operation to validate and ensure there is a node in the database.
Data operation to validate and ensure there is a record in the
ConfigurationEntity table for each of the adapter collections.
Data operation to validate and ensure there is a record
in the ConfigurationEntity table for ActiveMeasurements.
Data operation to validate accounts and groups to ensure
that account names and group names are converted to SIDs.
Data operation to validate and ensure there is a record in the
CustomActionAdapter table for the external and TLS data publishers.
Data operation to validate and ensure that certain records that
are required for statistics calculations exist in the database.
Data operation to validate and ensure that certain records
that are required for alarming exist in the database.
Represents a byte buffer that can be transported through the system as a .
Creates a new .
Creates a new from an existing buffer.
is null.
or is less than 0 -or-
and will exceed length.
Cached buffer image.
Valid length of cached buffer image.
Model for measurements published by the subscriber.
Gets or sets the signal ID of the measurement.
Gets or sets the time that the measurement was taken.
Gets or sets the value of the measurement.
Gets or sets the flags that define the quality of the measurement.
Represents a lookup table that determines whether
a given subscriber has rights to specific signals.
Creates a new instance of the class.
The source of metadata providing the tables required by the rights logic.
The ID of the subscriber whose rights are being looked up.
Gets the function that determines whether the subscriber has rights to a given signal.
Determines whether the subscriber has rights to a given signal.
The ID of the signal.
True if the subscriber has rights; false otherwise.
Represents a client connection to the .
Creates a new instance.
Parent data publisher.
Client ID of associated connection.
command channel used to lookup connection information.
Releases the unmanaged resources before the object is reclaimed by .
Gets client ID of this .
Gets or sets reference to data channel, attaching to or detaching from events as needed, associated with this .
Gets command channel.
Gets publication channel - that is, data channel if defined otherwise command channel.
Gets connected state of the associated client socket.
Gets or sets IsSubscribed state.
Gets or sets flag that indicates if the socket exception for "No client found for ID [Guid]" has been thrown.
Since this message might be thrown many times before the communications channel has had a chance to disconnect
the socket, it is best to stop attempting to send data when this error has been encountered.
Gets or sets the based subscriber ID of this .
Gets or sets the subscriber acronym of this .
Gets or sets the subscriber name of this .
Gets or sets subscriber info for this .
Gets the connection identification of this .
Gets or sets authenticated state of this .
Gets or sets shared secret used to lookup cipher keys only known to client and server.
Gets active and standby keys and initialization vectors.
Gets current cipher index.
Gets time of last cipher key update.
Gets or sets the list of valid IP addresses that this client can connect from.
Gets the IP address of the remote client connection.
Gets or sets subscription associated with this .
Gets the subscriber name of this .
Gets or sets a set of flags that define ways in
which the subscriber and publisher communicate.
Character encoding used to send messages to subscriber.
Gets a formatted message describing the status of this .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Creates or updates cipher keys.
Rotates or initializes the crypto keys for this .
Gets the instance used by this client
connection to send and receive data over the command channel.
The socket instance used by the client to send and receive data over the command channel.
Common static methods and extensions for transport library.
Gets flag that determines if managed encryption should be used.
Gets an AES symmetric algorithm to use for encryption or decryption.
Security modes used by the to secure data sent over the command channel.
No security.
Transport Layer Security.
Pre-shared key.
Server commands received by and sent by .
Solicited server commands will receive a or
response code along with an associated success or failure message. Message type for successful responses will be based
on server command - for example, server response for a successful MetaDataRefresh command will return a serialized
of the available server metadata. Message type for failed responses will always be a string of
text representing the error message.
Authenticate command.
Requests that server authenticate client with the following encrypted authentication packet.
Successful return message type will be string indicating client ID was validated.
Client should not attempt further steps if authentication fails, user will need to take action.
Client should send MetaDataRefresh and Subscribe commands upon successful authentication.
If server is setup to not require authentication, authentication step can be skipped - however
it will be up to the implementation to know if authentication is required - the server cannot be
queried to determine if authentication is required.
It is expected that use of this protocol between gateways over a shared network (i.e., the lower
security zone) will require authentication.
It is expected that use of this protocol between gateway and other systems (e.g., a PDC) in a
private network (i.e., the higher security zone) can be setup to not require authentication.
Meta data refresh command.
Requests that server send an updated set of metadata so client can refresh its point list.
Successful return message type will be a containing server device and measurement metadata.
Received device list should be defined as children of the "parent" server device connection similar to the way
PMUs are defined as children of a parent PDC device connection.
Devices and measurements contain unique Guids that should be used to key metadata updates in local repository.
Optional string based message can follow command that should represent client requested meta-data filtering
expressions, e.g.: "FILTER MeasurementDetail WHERE SignalType <> 'STAT'"
Subscribe command.
Requests a subscription of streaming data from server based on connection string that follows.
It will not be necessary to stop an existing subscription before requesting a new one.
Successful return message type will be string indicating total number of allowed points.
Client should wait for UpdateSignalIndexCache and UpdateBaseTime response codes before attempting
to parse data when using the compact measurement format.
Unsubscribe command.
Requests that server stop sending streaming data to the client and cancel the current subscription.
Rotate cipher keys.
Manually requests that server send a new set of cipher keys for data packet encryption.
Update processing interval.
Manually requests server to update the processing interval with the following specified value.
Define operational modes for subscriber connection.
As soon as connection is established, requests that server set operational
modes that affect how the subscriber and publisher will communicate.
Confirm receipt of a notification.
This message is sent in response to .
Confirm receipt of a buffer block measurement.
This message is sent in response to .
Provides measurements to the publisher over the command channel.
Allows for unsolicited publication of measurement data to the server
so that consumers of data can also provide data to other consumers.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Code for handling user-defined commands.
Server responses sent by and received by .
Command succeeded response.
Informs client that its solicited server command succeeded, original command and success message follow.
Command failed response.
Informs client that its solicited server command failed, original command and failure message follow.
Data packet response.
Unsolicited response informs client that a data packet follows.
Update signal index cache response.
Unsolicited response requests that client update its runtime signal index cache with the one that follows.
Update runtime base-timestamp offsets response.
Unsolicited response requests that client update its runtime base-timestamp offsets with those that follow.
Update runtime cipher keys response.
Response, solicited or unsolicited, requests that client update its runtime data cipher keys with those that follow.
Data start time response packet.
Unsolicited response provides the start time of data being processed from the first measurement.
Processing complete notification.
Unsolicited response provides notification that input processing has completed, typically via temporal constraint.
Buffer block response.
Unsolicited response informs client that a raw buffer block follows.
Notify response.
Unsolicited response provides a notification message to the client.
Configuration changed response.
Unsolicited response provides a notification that the publisher's source configuration has changed and that
client may want to request a meta-data refresh.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
Code for handling user-defined responses.
No operation keep-alive ping.
The command channel can remain quiet for some time, this command allows a period test of client connectivity.
data packet flags.
Determines if data packet is synchronized.
Bit set = synchronized, bit clear = unsynchronized.
Determines if serialized measurement is compact.
Bit set = compact, bit clear = full fidelity.
Determines which cipher index to use when encrypting data packet.
Bit set = use odd cipher index (i.e., 1), bit clear = use even cipher index (i.e., 0).
Determines if data packet payload is compressed.
Bit set = payload compressed, bit clear = payload normal.
Determines if the compressed data payload is in little-endian order.
Bit set = little-endian order compression, bit clear = big-endian order compression.
No flags set.
This would represent unsynchronized, full fidelity measurement data packets.
Operational modes that affect how and communicate.
Operational modes are sent from a subscriber to a publisher to request operational behaviors for the
connection, as a result the operation modes must be sent before any other command. The publisher may
silently refuse some requests (e.g., compression) based on its configuration. Operational modes only
apply to fundamental protocol control.
Mask to get version number of protocol.
Version number is currently set to 0.
Mask to get mode of compression.
GZip and TSSC compression are the only modes currently supported. Remaining bits are
reserved for future compression modes.
Mask to get character encoding used when exchanging messages between publisher and subscriber.
00 = UTF-16, little endian
01 = UTF-16, big endian
10 = UTF-8
11 = ANSI
Determines type of serialization to use when exchanging signal index cache and metadata.
Bit set = common serialization format, bit clear = .NET serialization format. The .NET
serialization format is only for backwards compatibility with older GEP implementations
and considered obsolete, it may be removed from future builds.
Determines whether external measurements are exchanged during metadata synchronization.
Bit set = external measurements are exchanged, bit clear = no external measurements are exchanged
Determines whether internal measurements are exchanged during metadata synchronization.
Bit set = internal measurements are exchanged, bit clear = no internal measurements are exchanged
Determines whether payload data is compressed when exchanging between publisher and subscriber.
Bit set = compress, bit clear = no compression
Determines whether the signal index cache is compressed when exchanging between publisher and subscriber.
Bit set = compress, bit clear = no compression
Determines whether metadata is compressed when exchanging between publisher and subscriber.
Bit set = compress, bit clear = no compression
No flags set.
This would represent protocol version 0,
UTF-16 little endian character encoding,
.NET serialization and no compression.
Enumeration for character encodings supported by the Gateway Exchange Protocol.
UTF-16, little endian
UTF-16, big endian
UTF-8
ANSI
Enumeration for compression modes supported by the Gateway Exchange Protocol.
GZip compression
TSSC compression
No compression
Represents a data publishing server that allows multiple connections for data subscriptions.
Indicates that a new client has connected to the publisher.
is the based subscriber ID.
is the connection identification (e.g., IP and DNS name, if available).
is the subscriber information as reported by the client.
Indicates to the host that processing for an input adapter (via temporal session) has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Maximum packet size before software fragmentation of payload.
Size of client response header in bytes.
Header consists of response byte, in-response-to server command byte, 4-byte int representing payload length.
Creates a new .
Releases the unmanaged resources before the object is reclaimed by .
Gets or sets flag that determines if should require subscribers to authenticate before making data requests.
Gets or sets the security mode of the 's command channel.
Gets or sets flag that determines if ZeroMQ should be used for command channel communications.
Gets or sets flag that determines whether data sent over the data channel should be encrypted.
This value is only relevant if is true.
Gets or sets flag that indicates whether this publisher is publishing
data that this node subscribed to from another node in a shared database.
Gets or sets flag that indicates if this publisher will allow payload compression when requested by subscribers.
Gets or sets the compression strength value to use when compressing data for subscribers.
Gets or sets flag that indicates if this publisher will allow synchronized subscriptions when requested by subscribers.
Gets or sets flag that indicates if this publisher will allow synchronized subscriptions when requested by subscribers.
Gets or sets flag that indicates if this publisher will allow filtering of data which is not a number.
Gets or sets flag that indicates if this publisher will force filtering of data which is not a number.
Gets or sets flag that determines whether to use base time offsets to decrease the size of compact measurements.
Gets or sets the cipher key rotation period.
Gets or sets the set of measurements which are cached by the data
publisher to be published to subscribers immediately upon subscription.
Gets or sets the measurement reporting interval.
This is used to determined how many measurements should be processed before reporting status.
Gets or sets based data source used to load each .
Updates to this property will cascade to all items in this .
Gets the status of this .
Derived classes should provide current status information about the adapter for display purposes.
Gets or sets the name of this .
The assigned name is used as the settings category when persisting the TCP server settings.
Gets or sets semi-colon separated list of SQL select statements used to create data for meta-data exchange.
Gets or sets flag that determines if a subscription is mutual, i.e., bi-directional pub/sub. In this mode one node will
be the owner and set Internal = True and the other node will be the renter and set Internal = False.
This flag is intended to be used in scenarios where a remote subscriber can add new measurements associated with a
source device, e.g., creating new calculated result measurements on a remote machine for load distribution that should
get associated with a device on the local machine, thus becoming part of the local measurement set.
For best results, both the owner and renter subscriptions should be reduced to needed measurements, i.e., renter should
only receive measurements needed for remote calculations and owner should only receive new calculated results. Note that
when used with a TLS-style subscription this can be accomplished by using the subscription UI screens that control the
measurement subscribed flag. For internal subscriptions, reduction of metadata and subscribed measurements will
need to be controlled via connection string with metadataFilters and outputMeasurements, respectively.
Gets flag that determines if subscriptions
are automatically initialized when they are added to the collection.
Gets dictionary of connected clients.
Gets or sets reference to command channel, attaching and/or detaching to events as needed.
Gets flag indicating if publisher is connected and listening.
Gets the total number of buffer block retransmissions on all subscriptions over the lifetime of the publisher.
Gets the total number of bytes sent to clients of this data publisher.
Gets the total number of measurements processed through this data publisher over the lifetime of the publisher.
Gets the minimum value of the measurements per second calculation.
Gets the maximum value of the measurements per second calculation.
Gets the average value of the measurements per second calculation.
Gets the minimum latency calculated over the full lifetime of the publisher.
Gets the maximum latency calculated over the full lifetime of the publisher.
Gets the average latency calculated over the full lifetime of the publisher.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Queues a collection of measurements for processing to each connected to this .
Measurements to queue for processing.
Queues a collection of measurements for processing to each connected to this .
Measurements to queue for processing.
Establish and start listening for client connections.
Terminate and stop listening for client connections.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of the .
Enumerates connected clients.
Enumerates connected clients with active temporal sessions.
Rotates cipher keys for specified client connection.
Enumerated index for client connection.
Gets subscriber information for specified client connection.
Enumerated index for client connection.
Gets temporal status for a specified client connection.
Enumerated index for client connection.
Gets the local certificate currently in use by the data publisher.
The local certificate file read directly from the certificate file as an array of bytes.
Imports a certificate to the trusted certificates path.
The file name to give to the certificate when imported.
The data to be written to the certificate file.
The local path on the server where the file was written.
Gets subscriber status for specified subscriber ID.
Guid based subscriber ID for client connection.
Resets the counters for the lifetime statistics without interrupting the adapter's operations.
Sends a notification to all subscribers.
The message to be sent.
Updates signal index cache based on input measurement keys.
Client ID of connection over which to update signal index cache.
New signal index cache.
Subscribed measurement keys.
Updates the latest measurement cache when the
set of cached measurements may have changed.
Updates each subscription's inputs based on
possible updates to that subscriber's rights.
Gets the text encoding associated with a particular client.
ID of client.
Text encoding associated with a particular client.
Sends the start time of the first measurement in a connection transmission.
ID of client to send response.
Start time, in , of first measurement transmitted.
Sends response back to specified client.
ID of client to send response.
Server response.
In response to command.
true if send was successful; otherwise false.
Sends response back to specified client with a message.
ID of client to send response.
Server response.
In response to command.
Status message to return.
true if send was successful; otherwise false.
Sends response back to specified client with a formatted message.
ID of client to send response.
Server response.
In response to command.
Formatted status message to return.
Arguments for .
true if send was successful; otherwise false.
Sends response back to specified client with attached data.
ID of client to send response.
Server response.
In response to command.
Data to return to client; null if none.
true if send was successful; otherwise false.
Updates latency statistics based on the collection of latencies passed into the method.
The latencies of the measurements sent by the publisher.
Raises the event.
Raises the event.
Subscriber (normally ).
Connection identification (normally ).
Subscriber information (normally ).
Gets meta-data to return to .
Client connection requesting meta-data.
Any meta-data filter expressions requested by client.
Meta-data to be returned to client.
Handles custom commands defined by the user of the publisher API.
Object representing the connection to the data subscriber.
The command issued by the subscriber.
The buffer containing the entire message from the subscriber.
The index indicating where to start reading from the buffer to skip past the message header.
The total number of bytes in the message, including the header.
Represents a data gap recovery module.
Data gaps will be recovered using an unsynchronized temporal subscription.
This class expects that source historian that feeds temporal subscription
will recover data in time-sorted order.
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Default value for .
Provides recovered measurements from temporal subscription.
is a collection of measurements for consumer to process.
Provides status messages to consumer.
is new status message.
Event is raised when there is an exception encountered during processing.
is the exception that was thrown.
Raised after the has been properly disposed.
Creates a new .
Releases the unmanaged resources before the object is reclaimed by .
Log messages generated by an adapter.
Gets or sets name of source connection device (e.g., a data subscriber).
This name will be used to create the .
Value cannot be null or an empty string.
Gets or sets based data source available to this .
Gets or sets connection string that will be used to make a temporal subscription when recovering data for an .
Value cannot be null or an empty string.
Gets or sets the minimum time delay, in seconds, to wait before starting the data recovery for an .
For some archiving systems it may take a few seconds for data to make it to disk and therefore be readily
available for a temporal subscription query. The should be adjusted based
on the nature of the system used to archive data. If the archival system makes data immediately available
because of internal caching or other means, this value can be zero.
Use of this value depends on the local clock, as such the value should be increased by the uncertainty of
accuracy of the local clock. For example, if it is know that the local clock floats +/-5 seconds from
real-time, then increase the desired value of the by 5 seconds.
Value cannot be a negative number.
Gets or sets the interval, in seconds, over which the data monitor will check for new data.
Once a connection is established a timer is enabled to monitor for new incoming data. The data monitoring timer
exists to make sure data is being received so that the process of recovery does not wait endlessly for data that
may never come because of a possible error in the recovery process. The
allows the consumer to adjust the interval over which the timer will check for new incoming data.
It will take some time, perhaps a couple of seconds, to start the temporal subscription and begin the process
of recovering data for an . Make sure the value for is
sufficiently large enough to handle any initial delays in data transmission.
Value cannot be zero or a negative number.
Gets to sets the minimum time span, in seconds, for which a data recovery will be attempted.
Set to zero for no minimum.
Value cannot be a negative number.
Gets to sets the maximum time span, in seconds, for which a data recovery will be attempted.
Set to for no maximum.
Value cannot be zero or a negative number.
Gets or sets logging path to be used to be runtime and outage logs of the subscriber which are required for
automated data recovery.
Leave value blank for default path, i.e., installation folder. Can be a fully qualified path or a path that
is relative to the installation folder, e.g., a value of "ConfigurationCache" might resolve to
"C:\Program Files\MyTimeSeriespPp\ConfigurationCache\".
Gets or sets the filter expression used to define which measurements are being requested for data recovery during an .
Gets or sets the data recovery processing interval, in whole milliseconds, to use in the temporal data
subscription when recovering data for an .
A value of -1 indicates the default processing interval will be requested.
A value of 0 indicates data will be processed as fast as possible.
With the exception of the values of -1 and 0, the value specifies
the desired historical data playback processing interval in milliseconds. This is basically a delay, or timer
interval, over which to process data. Setting this value to -1 means to use the default processing interval
while setting the value to 0 means to process data as fast as possible, i.e., as fast as the historian can
query the data. Depending on the available bandwidth, this parameter may need to be adjusted such that the
data being recovered does not adversely interfere with the ongoing transmission of real-time data.
Gets or sets the flag that determines whether measurement timestamps use millisecond resolution.
If false, time will be of resolution.
If the source and destination historians can handle timestamps at a greater than millisecond resolution then
the can be set to false to ensure that a full resolution timestamp
is delivered through the data recovery process. Setting this property to true allows the temporal subscription
used in the data recovery process to conserve data transmission bandwidth since not as much space will be needed for
a timestamp with only millisecond resolution.
Gets or sets start buffer time, in seconds, to add to start of outage window to ensure all missing data is recovered.
Gets or sets end buffer time, in seconds, to add to end of outage window to ensure all missing data is recovered.
Gets or sets any additional constraint parameters that will be supplied to adapters in temporal
subscription used when recovering data for an .
Gets or sets a boolean value that indicates whether the is enabled.
Gets a flag that indicates whether the object has been disposed.
Gets reference to the data gap for this .
Gets reference to the data gap for this .
Gets the status of the temporal used to query historical data.
Gets the status of this .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes the .
Logs a new data gap for processing.
Start time of data gap.
End time of data gap.
Indicates whether to skip data gap validation and force the outage to be logged.
true if data gap was logged for processing; otherwise, false.
Data gap will not be logged for processing if the and do not represent
a valid time span for recovery according to and .
Removes a data gap from the outage log so that it will not be processed.
Start time of data gap.
End time of data gap.
True if the data gap was successfully removed; false otherwise.
Produces a dump of the contents of the outage log.
The contents of the outage log.
Raises the event.
Raises the event and sends this data to the .
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
should be a constant string value associated with what type of message is being
generated. In general, there should only be a few dozen distinct event names per class. Exceeding this
threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
Represents a data subscribing client that will connect to a data publisher for a data subscription.
Creates a new local concentrator.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Publish of time-aligned collection of values that arrived within the
concentrator's defined .
of measurements with the same timestamp that arrived within that are ready for processing.
Index of within a second ranging from zero to - 1.
Releases the unmanaged resources before the object is reclaimed by .
Releases all the resources used by the object.
EventArgs implementation for handling user commands.
Creates a new instance of the class.
The code for the user command.
The code for the server's response.
Buffer containing the message from the server.
Index into the buffer used to skip the header.
The length of the message in the buffer, including the header.
Gets the code for the user command.
Gets the code for the server's response.
Gets the buffer containing the message from the server.
Gets the index into the buffer used to skip the header.
Gets the length of the message in the buffer, including the header.
Defines default value for .
Defines the default value for the property.
Defines the default value for the property.
Default value for .
Specifies the default value for the property.
Specifies the default value for the property.
Occurs when client connection to the data publication server is established.
Occurs when client connection to the data publication server is terminated.
Occurs when client connection to the data publication server has successfully authenticated.
Occurs when client receives response from the server.
Occurs when client receives message from the server in response to a user command.
Occurs when client receives requested meta-data transmitted by data publication server.
Occurs when first measurement is transmitted by data publication server.
Indicates that processing for an input adapter (via temporal session) has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Occurs when a notification has been received from the .
Occurs when the server has sent a notification that its configuration has changed, this
can allow subscriber to request updated meta-data if desired.
Occurs when number of parsing exceptions exceed during .
Creates a new .
Gets or sets the security mode used for communications over the command channel.
Gets or sets flag that determines if requires subscribers to authenticate before making data requests.
Gets or sets flag that determines if ZeroMQ should be used for command channel communications.
Gets or sets flag that determines if a should be used for connection.
Gets or sets logging path to be used to be runtime and outage logs of the subscriber which are required for
automated data recovery.
Leave value blank for default path, i.e., installation folder. Can be a fully qualified path or a path that
is relative to the installation folder, e.g., a value of "ConfigurationCache" might resolve to
"C:\Program Files\MyTimeSeriespPp\ConfigurationCache\".
Gets or sets flag that determines if should attempt to auto-connection to using defined connection settings.
Gets or sets flag that determines if should
automatically request meta-data synchronization and synchronize publisher
meta-data with its own database configuration.
Gets flag that indicates whether the connection will be persisted
even while the adapter is offline in order to synchronize metadata.
Gets or sets flag that determines if child devices associated with a subscription
should be prefixed with the subscription name and an exclamation point to ensure
device name uniqueness - recommended value is true.
Gets or sets requested meta-data filter expressions to be applied by before meta-data is sent.
Multiple meta-data filters, such filters for different data tables, should be separated by a semicolon. Specifying fields in the filter
expression that do not exist in the data publisher's current meta-data set could cause filter expressions to not be applied and possibly
result in no meta-data being received for the specified data table.
FILTER MeasurementDetail WHERE SignalType <> 'STAT'; FILTER PhasorDetail WHERE Phase = '+'
Gets or sets flag that determines if a subscription is mutual, i.e., bi-directional pub/sub. In this mode one node will
be the owner and set Internal = True and the other node will be the renter and set Internal = False.
This flag is intended to be used in scenarios where a remote subscriber can add new measurements associated with a
source device, e.g., creating new calculated result measurements on a remote machine for load distribution that should
get associated with a device on the local machine, thus becoming part of the local measurement set.
For best results, both the owner and renter subscriptions should be reduced to needed measurements, i.e., renter should
only receive measurements needed for remote calculations and owner should only receive new calculated results. Note that
when used with a TLS-style subscription this can be accomplished by using the subscription UI screens that control the
measurement subscribed flag. For internal subscriptions, reduction of metadata and subscribed measurements will
need to be controlled via connection string with metadataFilters and outputMeasurements, respectively.
Setting to true will force to true
and to false.
Gets or sets flag that informs publisher if base time-offsets can use millisecond resolution to conserve bandwidth.
Gets flag that determines whether the command channel is connected.
Gets flag that determines if this has successfully authenticated with the .
Gets total data packet bytes received during this session.
Gets or sets data loss monitoring interval, in seconds. Set to zero to disable monitoring.
Gets or sets a set of flags that define ways in
which the subscriber and publisher communicate.
Gets or sets the operational mode flag to compress meta-data.
Gets or sets the operational mode flag to compress the signal index cache.
Gets or sets the operational mode flag to compress data payloads.
Gets or sets the operational mode flag to receive internal meta-data.
Gets or sets the operational mode flag to receive external meta-data.
Gets or sets the operational mode flag to use the common serialization format.
Gets or sets the used by the subscriber and publisher.
Gets or sets the used by the subscriber and publisher.
Gets the version number of the protocol in use by this subscriber.
Gets the character encoding defined by the
of the communications stream.
Gets flag indicating if this adapter supports real-time processing.
Setting this value to false indicates that the adapter should not be enabled unless it exists within a temporal session.
As an example, this flag can be used in a gateway system to set up two separate subscribers: one to the PDC for real-time
data streams and one to the historian for historical data streams. In this scenario, the assumption is that the PDC is
the data source for the historian, implying that only local data is destined for archival.
Gets the flag indicating if this adapter supports temporal processing.
Although the data subscriber provisions support for temporal processing by receiving historical data from a remote source,
the adapter opens sockets and does not need to be engaged within an actual temporal , therefore
this method normally returns false to make sure the adapter doesn't get instantiated within a temporal session.
Setting this to true means that a subscriber will be initialized within a temporal session to provide historical
data from a remote source - this should only be enabled in cases where (1) there is no locally defined, e.g., in-process,
historian that can already provide historical data for temporal sessions, and (2) a remote subscriber should be allowed
to proxy temporal requests, e.g., those requested for data gap recovery, to an up-stream subscription. This is useful in
cases where a primary data subscriber that has data gap recovery enabled can also allow a remote subscription to proxy in
data gap recovery requests. It is recommended that remote data gap recovery request parameters be (1) either slightly
looser than those of local system to reduce the possibility of duplicated recovery sessions for the same data loss, or
(2) only enabled in the end-most system that most needs the recovered data, like a historian.
Gets or sets the desired processing interval, in milliseconds, for the adapter.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
interval while a value of 0 means to process data as fast as possible.
Gets or sets the timeout used when executing database queries during meta-data synchronization.
Gets or sets flag that determines if meta-data synchronization should be performed within a transaction.
Gets or sets flag that determines whether to use the local clock when calculating statistics.
Gets or sets number of parsing exceptions allowed during before connection is reset.
Gets or sets time duration, in , to monitor parsing exceptions.
Gets or sets based data source available to this .
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Gets or sets output measurements that the will produce, if any.
Gets connection info for adapter, if any.
Gets the status of this .
Derived classes should provide current status information about the adapter for display purposes.
Gets a flag that determines if this uses an asynchronous connection.
Gets or sets reference to data channel, attaching and/or detaching to events as needed.
Gets or sets reference to command channel, attaching and/or detaching to events as needed.
Gets the total number of measurements processed through this data publisher over the lifetime of the subscriber.
Gets the minimum value of the measurements per second calculation.
Gets the maximum value of the measurements per second calculation.
Gets the average value of the measurements per second calculation.
Gets the minimum latency calculated over the full lifetime of the subscriber.
Gets the maximum latency calculated over the full lifetime of the subscriber.
Gets the average latency calculated over the full lifetime of the subscriber.
Gets real-time as determined by either the local clock or the latest measurement received.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Authenticates subscriber to a data publisher.
Shared secret used to look up private crypto key and initialization vector.
Authentication ID that publisher will use to validate subscriber identity.
true if authentication transmission was successful; otherwise false.
Subscribes (or re-subscribes) to a data publisher for a set of data points.
Configuration object that defines the subscription.
true if subscribe transmission was successful; otherwise false.
Subscribes (or re-subscribes) to a data publisher for a synchronized set of data points.
Configuration object that defines the subscription.
true if subscribe transmission was successful; otherwise false.
Subscribes (or re-subscribes) to a data publisher for an unsynchronized set of data points.
Configuration object that defines the subscription.
true if subscribe transmission was successful; otherwise false.
Subscribes (or re-subscribes) to a data publisher for a remotely synchronized set of data points.
Boolean value that determines if the compact measurement format should be used. Set to false for full fidelity measurement serialization; otherwise set to true for bandwidth conservation.
The desired number of data frames per second.
Allowed past time deviation tolerance, in seconds (can be sub-second).
Allowed future time deviation tolerance, in seconds (can be sub-second).
Filtering expression that defines the measurements that are being subscribed.
Desired UDP return data channel connection string to use for data packet transmission. Set to null to use TCP channel for data transmission.
Boolean value that determines whether or not to use the local clock time as real-time.
Boolean value that determines if bad timestamps (as determined by measurement's timestamp quality) should be ignored when sorting measurements.
Gets or sets flag that determines whether or not to allow incoming measurements with bad timestamps to be sorted by arrival time.
Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame.
Gets or sets flag that allows system to preemptively publish frames assuming all expected measurements have arrived.
Gets the total number of down-sampled measurements processed by the concentrator.
Defines a relative or exact start time for the temporal constraint to use for historical playback.
Defines a relative or exact stop time for the temporal constraint to use for historical playback.
Defines any temporal parameters related to the constraint to use for historical playback.
Defines the desired processing interval milliseconds, i.e., historical play back speed, to use when temporal constraints are defined.
Comma separated list of wait handle names used to establish external event wait handles needed for inter-adapter synchronization.
Maximum wait time for external events, in milliseconds, before proceeding.
true if subscribe transmission was successful; otherwise false.
When the or temporal processing constraints are defined (i.e., not null), this
specifies the start and stop time over which the subscriber session will process data. Passing in null for the
and specifies the subscriber session will process data in standard, i.e., real-time, operation.
With the exception of the values of -1 and 0, the value specifies the desired historical playback data
processing interval in milliseconds. This is basically a delay, or timer interval, over which to process data. Setting this value to -1 means
to use the default processing interval while setting the value to 0 means to process data as fast as possible.
The and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Subscribes (or re-subscribes) to a data publisher for a locally synchronized set of data points.
Boolean value that determines if the compact measurement format should be used. Set to false for full fidelity measurement serialization; otherwise set to true for bandwidth conservation.
The desired number of data frames per second.
Allowed past time deviation tolerance, in seconds (can be sub-second).
Allowed future time deviation tolerance, in seconds (can be sub-second).
Filtering expression that defines the measurements that are being subscribed.
Desired UDP return data channel connection string to use for data packet transmission. Set to null to use TCP channel for data transmission.
Boolean value that determines whether or not to use the local clock time as real-time.
Boolean value that determines if bad timestamps (as determined by measurement's timestamp quality) should be ignored when sorting measurements.
Gets or sets flag that determines whether or not to allow incoming measurements with bad timestamps to be sorted by arrival time.
Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame.
Gets or sets flag that allows system to preemptively publish frames assuming all expected measurements have arrived.
Gets the total number of down-sampled measurements processed by the concentrator.
Defines a relative or exact start time for the temporal constraint to use for historical playback.
Defines a relative or exact stop time for the temporal constraint to use for historical playback.
Defines any temporal parameters related to the constraint to use for historical playback.
Defines the desired processing interval milliseconds, i.e., historical play back speed, to use when temporal constraints are defined.
Comma separated list of wait handle names used to establish external event wait handles needed for inter-adapter synchronization.
Maximum wait time for external events, in milliseconds, before proceeding.
true if subscribe transmission was successful; otherwise false.
When the or temporal processing constraints are defined (i.e., not null), this
specifies the start and stop time over which the subscriber session will process data. Passing in null for the
and specifies the subscriber session will process data in standard, i.e., real-time, operation.
With the exception of the values of -1 and 0, the value specifies the desired historical playback data
processing interval in milliseconds. This is basically a delay, or timer interval, over which to process data. Setting this value to -1 means
to use the default processing interval while setting the value to 0 means to process data as fast as possible.
The and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Subscribes (or re-subscribes) to a data publisher for an unsynchronized set of data points.
Boolean value that determines if the compact measurement format should be used. Set to false for full fidelity measurement serialization; otherwise set to true for bandwidth conservation.
Boolean value that determines if data should be throttled at a set transmission interval or sent on change.
Filtering expression that defines the measurements that are being subscribed.
Desired UDP return data channel connection string to use for data packet transmission. Set to null to use TCP channel for data transmission.
Boolean value that determines if time is a necessary component in streaming data.
When is true, defines the data transmission speed in seconds (can be sub-second).
When is true, defines the allowed time deviation tolerance to real-time in seconds (can be sub-second).
When is true, defines boolean value that determines whether or not to use the local clock time as real-time. Set to false to use latest received measurement timestamp as real-time.
Defines a relative or exact start time for the temporal constraint to use for historical playback.
Defines a relative or exact stop time for the temporal constraint to use for historical playback.
Defines any temporal parameters related to the constraint to use for historical playback.
Defines the desired processing interval milliseconds, i.e., historical play back speed, to use when temporal constraints are defined.
Comma separated list of wait handle names used to establish external event wait handles needed for inter-adapter synchronization.
Maximum wait time for external events, in milliseconds, before proceeding.
true if subscribe transmission was successful; otherwise false.
When the or temporal processing constraints are defined (i.e., not null), this
specifies the start and stop time over which the subscriber session will process data. Passing in null for the
and specifies the subscriber session will process data in standard, i.e., real-time, operation.
With the exception of the values of -1 and 0, the value specifies the desired historical playback data
processing interval in milliseconds. This is basically a delay, or timer interval, over which to process data. Setting this value to -1 means
to use the default processing interval while setting the value to 0 means to process data as fast as possible.
The and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Subscribes (or re-subscribes) to a data publisher for a set of data points.
Boolean value that determines if subscription should be remotely synchronized - note that data publisher may not allow remote synchronization.
Boolean value that determines if the compact measurement format should be used. Set to false for full fidelity measurement serialization; otherwise set to true for bandwidth conservation.
Connection string that defines required and optional parameters for the subscription.
true if subscribe transmission was successful; otherwise false.
Unsubscribes from a data publisher.
true if unsubscribe transmission was successful; otherwise false.
Returns the measurements signal IDs that were authorized after the last successful subscription request.
Returns the measurements signal IDs that were unauthorized after the last successful subscription request.
Resets the counters for the lifetime statistics without interrupting the adapter's operations.
Initiate a meta-data refresh.
Log a data gap for data gap recovery.
The string representing the data gap.
Remove a data gap from data gap recovery.
The string representing the data gap.
Displays the contents of the outage log.
The contents of the outage log.
Gets the status of the temporal used by the data gap recovery module.
Status of the temporal used by the data gap recovery module.
Spawn meta-data synchronization.
to use for synchronization.
This method makes sure only one meta-data synchronization happens at a time.
Sends a server command to the publisher connection with associated data.
to send.
String based command data to send to server.
true if transmission was successful; otherwise false.
Sends a server command to the publisher connection.
to send.
Optional command data to send.
true if transmission was successful; otherwise false.
Attempts to connect to this .
Attempts to disconnect from this .
Gets a short one-line status of this .
Maximum length of the status message.
Text of the status message.
Get message from string based response.
Response buffer.
Start index of response message.
Length of response message.
Decoded response string.
Handles meta-data synchronization to local system.
This function should only be initiated from call to to make
sure only one meta-data synchronization happens at once. Users can override this method to customize
process of meta-data synchronization.
Raises the event.
Raises the event.
Raises the event.
Raises the event.
Response received from the server.
Command that the server responded to.
Raises the event.
The code for the user command.
The code for the server's response.
Buffer containing the message from the server.
Index into the buffer used to skip the header.
The length of the message in the buffer, including the header.
Raises the event.
Meta-data instance to send to client subscription.
Raises the event.
Start time, in , of first measurement transmitted.
Raises the event.
Type name of adapter that sent the processing completed notification.
Raises the event.
Message for the notification.
Raises the event.
Raises event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
Raises the event.
Disposes of any previously defined local concentrator.
Gets file path for any defined logging path.
Path to acquire within logging path.
File path within any defined logging path.
Defines a that supports .
Represents a that can be serialized.
This measurement implementation is serialized through
to allow complete control of binary format. All measurement properties are serialized
at their full resolution and no attempt is made to optimize the binary image for
purposes of size reduction.
Fixed byte length of a .
Creates a new .
Character encoding used to convert strings to binary.
Creates a new from an existing value.
Source value.
Character encoding used to convert strings to binary.
Gets the length of the .
Initializes from the specified binary image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
Not enough buffer available to deserialize measurement.
is null.
or is less than 0 -or-
and will exceed length.
Generates binary image of the and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
is null.
or is less than 0 -or-
and will exceed length.
Field: Bytes:
--------- ---------
Key ID 4
SourceLen 4
Source SourceLen
Signal ID 16
TagLen 4
Tag TagLen
Value 8
Adder 8
Multiplier 8
Ticks 8
Flags 4
Constant Length = 64
Variable Length = SourceLen + TagLen
state flags.
A data range flag was set.
A data quality flag was set.
A time quality flag was set.
A system flag was set.
Calculated value bit was set.
Discarded value bit was set.
Compact measurement timestamp was serialized using base time offset when set.
Use odd time index (i.e., 1) when bit is set; even time index (i.e., 0) when bit is clear.
No flags.
Defines static methods for mapping between compact and full measurement states.
Maps to .
Flags to map.
mapped from .
Maps to .
Flags to map.
mapped from .
Represents a that can be serialized with minimal size.
This measurement implementation is serialized through
to allow complete control of binary format. Only critical measurements properties are
serialized and every attempt is made to optimize the binary image for purposes of size
reduction.
Fixed byte length of a .
Creates a new .
Signal index cache used to serialize or deserialize runtime information.
Set to true to include time in serialized packet; otherwise false.
Base time offset array - set to null to use full fidelity measurement time.
Time index to use for base offset.
Flag that determines if millisecond resolution is in use for this serialization.
Creates a new from an existing value.
Source value.
Signal index cache used to serialize or deserialize runtime information.
Set to true to include time in serialized packet; otherwise false.
Base time offset array - set to null to use full fidelity measurement time.
Time index to use for base offset.
Flag that determines if millisecond resolution is in use for this serialization.
Gets flag that determines if time is serialized into measurement binary image.
Gets the length of the .
Gets offset compressed millisecond-resolution 2-byte timestamp.
Gets offset compressed tick-resolution 4-byte timestamp.
Gets or sets byte level compact state flags with encoded time index and base time offset bits.
Gets or sets the 2-byte run-time signal index for this measurement.
Initializes from the specified binary image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
Not enough buffer available to deserialize measurement.
is null.
or is less than 0 -or-
and will exceed length.
Generates binary image of the and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
is null.
or is less than 0 -or-
and will exceed length.
Field: Bytes:
-------- -------
Flags 1
ID 2
Value 4
[Time] 2?
Constant Length = 7
Variable Length = 0, 2, 4 or 8 (i.e., total size is 7, 9, 11 or 15)
Defines extension functions related to .
Attempts to compress payload of values onto the stream.
Payload of values.
Memory based stream to hold compressed payload.
Compression strength to use.
Flag that determines if time should be included in the compressed payload.
Current .
true if payload was compressed and encoded onto stream; otherwise false.
Compressed payload will only be encoded onto stream if compressed size would be smaller
than normal serialized size.
As an optimization this function uses a compression method that uses pointers to native structures, as such the
endian order encoding of the compressed data will always be in the native-endian order of the operating system.
This will be an important consideration when writing a endian order neutral payload decompressor. To help with
this the actual endian order used during compression is marked in the data flags. However, measurements values
are consistently encoded in big-endian order prior to buffer compression.
Decompresses values from the given buffer.
Buffer with compressed payload.
Current .
Index into buffer where compressed payload begins.
Length of all data within buffer.
Number of compressed measurements in the payload.
Flag that determines if timestamps as included in the payload.
Current .
Decompressed values from the given buffer.
Represents a common set of interfaces for a client adapter subscription to the .
Indicates that a buffer block needed to be retransmitted because
it was previously sent, but no confirmation was received.
Indicates to the host that processing for an input adapter (via temporal session) has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Gets the client TCP connection identifier of this .
Gets the based subscriber ID of this .
Gets the current signal index cache of this .
Gets the input filter requested by the subscriber when establishing this .
Gets or sets flag that determines if payload compression should be enabled in data packets of this .
Gets or sets the compression strength value to use when is true for this .
Gets or sets flag that determines if the compact measurement format should be used in data packets of this .
Gets size of timestamp in bytes.
Gets the status of the active temporal session, if any.
Gets or sets the measurement reporting interval.
Handles the confirmation message received from the
subscriber to indicate that a buffer block was received.
The sequence number of the buffer block.
A list of buffer block sequence numbers for blocks that need to be retransmitted.
Explicitly raises the event.
The to assign to this message
New status message.
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
Explicitly raises the event.
The to assign to this message
Processing .
A fixed string to classify this event; defaults to null.
to use, if any; defaults to .
Explicitly raises the event.
raising the notification.
Event arguments for notification, if any.
Defines static extension functions for implementations.
Returns a new temporal for a .
instance to create temporal for.
New temporal for a .
Disposes a temporal created using .
source instance.
instance to dispose.
Represents a serializable signal ID to index cross reference.
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.
Lookups MeasurementKey.RuntimeID and returns ushort SignalIndex. -1 means it does not exist.
Creates a new instance.
Creates a new local system cache from one that was received remotely.
based data source used to interpret local measurement keys.
Deserialized remote signal index cache.
Gets or sets the based subscriber ID of this .
Gets or sets integer signal index cross reference dictionary.
Gets reference to array of requested input measurement signal IDs that were authorized.
Gets or sets reference to array of requested input measurement signal IDs that were unauthorized.
Gets the current maximum integer signal index.
Gets or sets character encoding used to convert strings to binary.
Gets the length of the binary image.
Gets runtime signal index for given signal ID.
The used to lookup associated runtime signal index.
Runtime signal index for given .
Generates binary image of the and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
Initializes the by parsing the specified containing a binary image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within to read from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
Configuration object for data subscriptions.
Creates a new instance of the class.
Gets or sets the filter expression used to define which
measurements are being requested by the subscriber.
Gets or sets the flag that determines whether to use the
compact measurement format or the full measurement format
for transmitting measurements to the subscriber.
Gets or sets the flag that determines whether the subscriber
is requesting its data over a separate UDP data channel.
Gets or sets the port number that the UDP data channel binds to.
This value is only used when the subscriber requests a separate
UDP data channel.
Gets or sets the allowed past time deviation
tolerance in seconds (can be sub-second).
Gets or sets the allowed future time deviation
tolerance, in seconds (can be sub-second).
Gets or sets the flag that determines whether the server's
local clock is used as real-time. If false, the timestamps
of the measurements will be used as real-time.
Gets or sets the flag that determines whether measurement timestamps use
millisecond resolution. If false, they will use resolution.
This flag determines the size of the timestamps transmitted as part of
the compact measurement format when the server is using base time offsets.
Gets or sets the flag that determines whether to request that measurements
sent to the subscriber should be filtered by the publisher prior to sending them.
Gets or sets the start time of the requested
temporal session for streaming historic data.
When the or temporal processing constraints are defined (i.e., not null), this
specifies the start and stop time over which the subscriber session will process data. Passing in null for the
and specifies the subscriber session will process data in standard, i.e., real-time, operation.
Both the and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Gets or sets the stop time of the requested
temporal session for streaming historic data.
When the or temporal processing constraints are defined (i.e., not null), this
specifies the start and stop time over which the subscriber session will process data. Passing in null for the
and specifies the subscriber session will process data in standard, i.e., real-time, operation.
Both the and parameters can be specified in one of the
following formats:
Time Format
Format Description
-
12-30-2000 23:59:59.033
Absolute date and time.
-
*
Evaluates to .
-
*-20s
Evaluates to 20 seconds before .
-
*-10m
Evaluates to 10 minutes before .
-
*-1h
Evaluates to 1 hour before .
-
*-1d
Evaluates to 1 day before .
Gets or sets the additional constraint parameters
supplied to temporal adapters in a temporal session.
Gets or sets the processing interval requested by the subscriber.
A value of -1 indicates the default processing interval.
A value of 0 indicates data will be processed as fast as
possible.
With the exception of the values of -1 and 0, the value specifies the desired historical playback data
processing interval in milliseconds. This is basically a delay, or timer interval, over which to process data. Setting this value to -1 means
to use the default processing interval while setting the value to 0 means to process data as fast as possible.
Gets or sets the additional connection string parameters to
be applied to the connection string sent to the publisher
during subscription.
Creates a shallow copy of this
object.
The copy of this object.
Configuration object for synchronized data subscriptions.
Creates a new instance of the class.
Flag that determines whether the subscription defined by this object is remotely synchronized or locally synchronized.
Frame rate of the subscription in frames per second.
Gets or sets the flag that determines whether this subscription
is remotely synchronized or locally synchronized.
Gets or sets the frame rate of the subscription in frames per second.
Gets or sets the down-sampling method used when the frame rate of
the subscription is lower than the frame rate of the measurement's
source.
Gets or sets the flag that determines whether frames should be published
as soon as the data is available. If false, frames will be published
when their timestamp expires (realTime > timestamp + lagTime).
Gets or sets the flag that determines whether to allow measurement
sorting based on the measurement's time of arrival, if its timestamp
is unreasonable.
Gets or sets the flag that determines whether to
ignore bad timestamps when sorting measurements.
Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame.
Desired maximum resolution
Value to assign
-
Seconds
.
-
Milliseconds
.
-
Microseconds
.
-
100-Nanoseconds
0
Assigning values less than zero will be set to zero since minimum possible concentrator resolution is one tick (100-nanoseconds). Assigning
values values greater than . will be set to .
since maximum possible concentrator resolution is one second (i.e., 1 frame per second).
Configuration object for unsynchronized data subscriptions.
Creates a new instance of the class.
The flag that determines whether to request that the subscription be throttled.
Gets or sets the flag that determines whether
to request that the subscription be throttled.
Gets or sets the interval at which data should be
published when using a throttled subscription.
Gets or sets the flag that determines whether timestamps are
included in the data sent from the publisher. This value is
ignored if the data is remotely synchronized.
Represents a synchronized client subscription to the .
Indicates that a buffer block needed to be retransmitted because
it was previously sent, but no confirmation was received.
Indicates to the host that processing for an input adapter (via temporal session) has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Creates a new .
Reference to parent.
based client connection ID.
based subscriber ID.
requested by client.
Gets name of the action adapter.
Gets the client TCP connection identifier of this .
Gets the based subscriber ID of this .
Gets the current signal index cache of this .
Gets or sets flag that determines if payload compression should be enabled in data packets of this .
Gets or sets the compression strength value to use when is true for this .
Gets or sets flag that determines if the compact measurement format should be used in data packets of this .
Gets size of timestamp in bytes.
Gets or sets the desired processing interval, in milliseconds, for the adapter.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
interval while a value of 0 means to process data as fast as possible.
Gets or sets primary keys of input measurements the expects, if any.
We override method so assignment can be synchronized such that dynamic updates won't interfere
with filtering in .
Gets the flag indicating if this adapter supports temporal processing.
Although this adapter provisions support for temporal processing by proxying historical data to a remote sink, the adapter
does not need to be automatically engaged within an actual temporal , therefore this method returns
false to make sure the adapter doesn't get automatically instantiated within a temporal session.
Gets a formatted message describing the status of this .
Gets the status of the active temporal session, if any.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Starts the or restarts it if it is already running.
Queues a collection of measurements for processing.
Collection of measurements to queue for processing.
Measurements are filtered against the defined so we override method
so that dynamic updates to keys will be synchronized with filtering to prevent interference.
Handles the confirmation message received from the
subscriber to indicate that a buffer block was received.
The sequence number of the buffer block.
A list of buffer block sequence numbers for blocks that need to be retransmitted.
Publish of time-aligned collection of values that arrived within the
concentrator's defined .
of measurements with the same timestamp that arrived within that are ready for processing.
Index of within a second ranging from zero to - 1.
Represents an action adapter that exists within a temporal to proxy data back to its parent instance.
Gets the flag indicating if this adapter supports temporal processing.
Gets or sets parent subscription for the proxy used to deliver data.
Proxies measurements to parent adapter for processing.
Collection of measurements to queue for processing.
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status for this .
The metadata kept for each pointID.
The encoding commands supported by TSSC. This class is used by
and .
The decoder for the TSSC protocol.
Creates a decoder for the TSSC protocol.
Resets the TSSC Decoder to the initial state.
TSSC is a stateful encoder that requires a state
of the previous data to be maintained. Therefore, if
the state ever becomes corrupt (out of order, dropped, corrupted, or duplicated)
the state must be reset on both ends.
Sets the internal buffer to read data from.
Reads the next measurement from the stream. If the end of the stream has been encountered,
return false.
the id
the timestamp in ticks
the quality
the value
true if successful, false otherwise.
The number of bits in m_bitStreamCache that are valid. 0 Means the bitstream is empty.
A cache of bits that need to be flushed to m_buffer when full. Bits filled starting from the right moving left.
Resets the stream so it can be reused. All measurements must be registered again.
An encoder for the TSSC protocol.
Creates a encoder for the TSSC protocol.
Resets the TSSC Encoder to the initial state.
TSSC is a stateful encoder that requires a state
of the previous data to be maintained. Therefore, if
the state ever becomes corrupt (out of order, dropped, corrupted, or duplicated)
the state must be reset on both ends.
Sets the internal buffer to write data to.
Finishes the current block and returns position after the last byte written.
Adds the supplied measurement to the stream. If the stream is full,
this method returns false.
the id
the timestamp in ticks
the quality
the value
true if successful, false otherwise.
The position in m_buffer where the bit stream should be flushed
-1 means no bit stream position has been assigned.
The number of bits in m_bitStreamCache that are valid. 0 Means the bitstream is empty.
A cache of bits that need to be flushed to m_buffer when full. Bits filled starting from the right moving left.
Resets the stream so it can be reused. All measurements must be registered again.
Represents an unsynchronized client subscription to the .
Indicates that a buffer block needed to be retransmitted because
it was previously sent, but no confirmation was received.
Indicates to the host that processing for an input adapter (via temporal session) has completed.
This event is expected to only be raised when an input adapter has been designed to process
a finite amount of data, e.g., reading a historical range of data during temporal processing.
Creates a new .
Reference to parent.
based client connection ID.
based subscriber ID.
requested by client.
Gets name of the action adapter.
Gets the client TCP connection identifier of this .
Gets the based subscriber ID of this .
Gets the current signal index cache of this .
Gets the input filter requested by the subscriber when establishing this .
Gets or sets flag that determines if payload compression should be enabled in data packets of this .
Gets or sets the compression strength value to use when is true for this .
Gets or sets flag that determines if the compact measurement format should be used in data packets of this .
Gets size of timestamp in bytes.
Gets or sets the desired processing interval, in milliseconds, for the adapter.
With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
interval while a value of 0 means to process data as fast as possible.
Gets or sets primary keys of input measurements the expects, if any.
We override method so assignment can be synchronized such that dynamic updates won't interfere
with filtering in .
Gets the flag indicating if this adapter supports temporal processing.
Although this adapter provisions support for temporal processing by proxying historical data to a remote sink, the adapter
does not need to be automatically engaged within an actual temporal , therefore this method returns
false to make sure the adapter doesn't get automatically instantiated within a temporal session.
Gets a formatted message describing the status of this .
Gets the status of the active temporal session, if any.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initializes .
Starts the or restarts it if it is already running.
Stops the .
Gets a short one-line status of this .
Maximum number of available characters for display.
A short one-line summary of the current status of this .
Queues a collection of measurements for processing.
Collection of measurements to queue for processing.
Measurements are filtered against the defined so we override method
so that dynamic updates to keys will be synchronized with filtering to prevent interference.
Handles the confirmation message received from the
subscriber to indicate that a buffer block was received.
The sequence number of the buffer block.
A list of buffer block sequence numbers for blocks that need to be retransmitted.
Windows form application used to host the time-series framework service.
Reference to instance of .
Creates a new instance of the windows form.
Gets the executable name of the service client that can remotely access the time-series framework service.
Invoked when the debug host is loading. By default this launches the remote service client.
Invoked when the debug host is unloading. By default this shuts down the remote service client.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Configuration data source type enumeration.
Configuration source is a database.
Configuration source is a web-service.
Configuration source is a binary file.
Configuration source is a XML file.
Represents the time-series framework service host.
Creates a new .
Creates a new from specified parameters.
Service host .
Gets the related remote console application name.
Gets access to the .
Gets reference to the based remoting server.
Gets reference to the .
Gets reference to the .
Gets reference to the .
Gets reference to the .
Gets reference to the .
Gets the current node ID.
Gets the current node ID formatted for use in a SQL query string based on .
Gets the currently loaded system configuration .
Gets the defined system .
Gets or sets flag that determines if the local certificate's private key should be verified upon service start.
Event handler for service starting operations.
Event source.
Event arguments containing command line arguments passed into service at startup.
Time-series framework uses this handler to load settings from configuration file as service is starting.
Event handler for service started operation.
Event source.
Event arguments.
Time-series framework uses this handler to handle initialization of system objects.
Event handler for service stopping operation.
Event source.
Event arguments.
Time-series framework uses this handler to un-wire events and dispose of system objects.
Initializes the service helper.
Handle assignment of data source to Iaon session.
New data source to assign.
true if data source was assigned; otherwise, false.
Caches the current system configuration.
Configuration .
This method allows caching of the current system configuration so it can be used if primary configuration source is unavailable.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Handles service start event.
Service startup arguments, if any.
Handles service stop event.
Handles service pause event.
Handles service continue event.
Handles service shut down event.
Event handler for reporting status messages.
Event source of the status message.
Event arguments containing the status message and its type to report.
The time-series framework uses this event to report adapter status messages (e.g., to a log file or console window).
Event handler for processing reported exceptions.
Event source of the exception.
Event arguments containing the exception to report.
The time-series framework uses this event to report exceptions.
Event handler for processing notifications from adapters that configuration has changed.
Event source of the notification.
Event arguments, if any.
The time-series framework uses this event to report configuration changes.
Event handler for processing exceptions encountered while writing entries to any log file.
Event source of the exception.
Event arguments containing the exception to report.
This function is for derived classes wanting access to any logged exception without needing
to override all specific log exception handlers.
Event handler for processing exceptions encountered while writing entries to the status log file.
Event source of the exception.
Event arguments containing the exception to report.
Event handler for processing exceptions encountered while writing entries to the error log file.
Event source of the exception.
Event arguments containing the exception to report.
Event handler for processing exceptions encountered while writing entries to the connection log file.
Event source of the exception.
Event arguments containing the exception to report.
Event handler for scheduled health monitor display.
Scheduled event name.
Scheduled event parameters.
Event handler for scheduled adapter status export.
Scheduled event name.
Scheduled event parameters.
Event handler for scheduled reporting services.
Scheduled event name.
Scheduled event parameters.
Gets requested .
instance containing the client request.
Requested .
Gets requested .
instance containing the client request.
Requested .
Gets requested and its containing .
instance containing the client request.
Containing for .
Requested .
Displays status of specified adapter or collection.
instance containing the client request.
Starts specified adapter.
instance containing the client request.
Stops specified adapter.
instance containing the client request.
Generic adapter request handler.
instance containing the client request.
Action to perform on .
Invokes specified adapter command.
instance containing the client request.
Lists possible commands of specified adapter.
instance containing the client request.
Performs initialization or reinitialization of specified adapter or collection.
instance containing the client request.
Sends remote entry for logging.
Gets adapter input measurements.
Gets adapter output measurements.
Determines support for temporal processing from existing adapters.
instance containing the client request.
Recalculates routing tables.
instance containing the client request.
Manually reloads system configuration.
instance containing the client request.
Updates an option in the configuration file.
instance containing the client request.
Manages the certificate used by the service.
instance containing the client request.
Attempts to authenticate or re-authenticate to network shares.
instance containing the client request.
Attempts to restart the hose service.
instance containing the client request.
Determines whether the requested adapter exists.
instance containing the client request.
True if the requested adapter exists; false otherwise.
Used to ping a device.
instance containing the client request.
True if the requested adapter exists; false otherwise.
Sends an actionable response to client.
instance containing the client request.
Flag that determines if this response to client request was a success.
Sends an actionable response to client with a formatted message.
instance containing the client request.
Flag that determines if this response to client request was a success.
Formatted status message to send with response.
Arguments of the formatted status message.
Sends an actionable response to client with a formatted message and attachment.
instance containing the client request.
Flag that determines if this response to client request was a success.
Attachment to send with response.
Formatted status message to send with response.
Arguments of the formatted status message.
Displays a response message to client requester.
instance containing the client request.
Formatted status message to send to client.
Arguments of the formatted status message.
Displays a broadcast message to all subscribed clients.
Status message to send to all clients.
of message to send.
Displays a broadcast message to all subscribed clients.
Status message to send to all clients.
of message to send.
Determines if messages should be sent logging engine.
Displays a broadcast message to all subscribed clients.
Formatted status message to send to all clients.
of message to send.
Arguments of the formatted status message.
Displays a broadcast message to all subscribed clients.
Formatted status message to send to all clients.
of message to send.
Determines if messages should be sent logging engine.
Arguments of the formatted status message.
Logs an exception to the service helper .
to log.
Required designer variable.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Enumeration that defines how to handle
values that are outside of the defined Lag/Lead time bounds.
Measurement value is set to if it is outside of the
defined time bounds. This is the default behavior.
Measurement value is preserved if it is outside of the time bounds, but the state
flags are set to which defaults to
.
Represents a time constrained measured value.
Constructs a new given the specified parameters.
Past time deviation tolerance, in seconds - this becomes the amount of time to wait before publishing begins.
Future time deviation tolerance, in seconds - this becomes the tolerated +/- accuracy of the local clock to real-time.
Constructs a new given the specified parameters.
Source value.
Past time deviation tolerance, in seconds - this becomes the amount of time to wait before publishing begins.
Future time deviation tolerance, in seconds - this becomes the tolerated +/- accuracy of the local clock to real-time.
Gets or sets the for this when
timestamp is outside defined Lag/Lead time bounds.
Gets or sets the to apply to this when
is set to and
timestamp is outside defined Lag/Lead time bounds.
Allowed past time deviation tolerance in seconds (can be sub-second).
This value defines the time sensitivity to past measurement timestamps.
Defined the number of seconds allowed before assuming a measurement timestamp is too old.
LagTime must be greater than zero, but it can be less than one.
Allowed future time deviation tolerance in seconds (can be sub-second).
This value defines the time sensitivity to future measurement timestamps.
Defined the number of seconds allowed before assuming a measurement timestamp is too advanced.
LeadTime must be greater than zero, but it can be less than one.
Gets numeric adjusted value of this , constrained within specified ticks.
Operation will return NaN if ticks are outside of time deviation tolerances.
Note that returned value will be offset by adder and multiplier.
Timestamp used to constrain (typically set to real-time, i.e. "now").
Value offset by adder and multiplier (i.e., Value * Multiplier + Adder).
Gets numeric value of this , constrained within specified ticks.
Operation will return NaN if ticks are outside of time deviation tolerances.
Timestamp, in ticks, used to constrain (typically set to real-time, i.e. "now").
Raw value of this measurement (i.e., value that is not offset by adder and multiplier).
Sets numeric value and timestamp, as ticks, of this .
Operation will only store a value that is newer than the cached value.
Timestamp, in ticks, used to constrain (typically set to real-time, i.e. "now").
New timestamp, in ticks, for .
New value for , only stored if are newer than current .
New flags for .
true if value was updated; otherwise false.
container used to track values for down-sampling.
Constructs a new given the specified parameters.
Source to track.
to apply.
Gets instance of being tracked.
Gets timestamp of being tracked.
Total number of measurements down-sampled by .
Gets the locking primitive.
Derives measurement value, down-sampling if needed.
New value.
New derived value, or null if value should not be assigned to .