Click or drag to resize
Grid Solutions Framework

MovingValueInputAdapter Class

Represents a class used to stream a series of values that move randomly but change gradually.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersInputAdapterBase
      TestingAdaptersMovingValueInputAdapter

Namespace: TestingAdapters
Assembly: TestingAdapters (in TestingAdapters.dll) Version: 2.4.181-beta
Syntax
public class MovingValueInputAdapter : InputAdapterBase
View Source

The MovingValueInputAdapter type exposes the following members.

Constructors
 NameDescription
Public methodMovingValueInputAdapterInitializes a new instance of the MovingValueInputAdapter class
Top
Properties
 NameDescription
Public propertyAutoStart Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase)
Protected propertyConnectionAttemptInterval Gets or sets the connection attempt interval, in milliseconds, for the data input source.
(Inherited from InputAdapterBase)
Public propertyConnectionInfo Gets connection info for adapter, if any.
(Inherited from AdapterBase)
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase)
Public propertyConnectOnDemand Gets or sets the flag that determines whether adapter will only connect when measurements are requested.
Public propertyDataSource Gets or sets DataSet based data source available to this AdapterBase.
(Inherited from AdapterBase)
Protected propertyEnableConnectionErrors When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
(Inherited from InputAdapterBase)
Public propertyEnabled Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase)
Public propertyID Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase)
Public propertyIncludeTime Gets or sets the flag that determines whether time will be included in the published measurements. False will set all time values to zero.
Public propertyInitializationTimeout Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase)
Public propertyInitialized Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase)
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the AdapterBase expects, if any.
(Inherited from InputAdapterBase)
Public propertyIsConnected Gets flag that determines if InputAdapterBase is connected.
(Inherited from InputAdapterBase)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase)
Protected propertyLog Log messages generated by an adapter.
(Inherited from AdapterBase)
Public propertyMaxHoldTime Gets or sets the smallest possible amount of time that the values will stay the same before moving again, in seconds.
Public propertyMaxMoveTime Gets or sets the largest possible amount of time that the values will move between two held values, in seconds.
Public propertyMaxValue Gets or sets the largest possible value generated by the adapter.
Public propertyMeasurementReportingInterval Gets or sets the measurement reporting interval.
(Inherited from AdapterBase)
Public propertyMinHoldTime Gets or sets the smallest possible amount of time that the values will stay the same before moving again, in seconds.
Public propertyMinMoveTime Gets or sets the smallest possible amount of time that the values will move between two held values, in seconds.
Public propertyMinValue Gets or sets the smallest possible value generated by the adapter.
Public propertyName Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase)
Public propertyOutputMeasurements Gets or sets output measurements that the AdapterBase will produce, if any.
(Inherited from AdapterBase)
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from InputAdapterBase)
Public propertyProcessedMeasurements Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from AdapterBase)
Public propertyPublishRate Gets or sets the number of values generated by the adapter per second.
Public propertyRandomNumberSeed Gets or sets the initial random number seed. Set to -1 for timer based seed.
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from InputAdapterBase)
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase)
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase)
Public propertyStartTime Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertyStatus Returns the detailed status of the data input source.
(Inherited from InputAdapterBase)
Public propertyStopTime Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing)
Protected propertyUseAsyncConnect Gets flag that determines if the data input connects asynchronously.
(Overrides InputAdapterBaseUseAsyncConnect)
Public propertyValueWraps Gets or sets the flag that determines whether the value can wrap from min to max or vice-versa.
Top
Methods
 NameDescription
Protected methodAttemptConnection Attempts to connect to data input source.
(Overrides InputAdapterBaseAttemptConnection)
Protected methodAttemptDisconnection Attempts to disconnect from data input source.
(Overrides InputAdapterBaseAttemptDisconnection)
Public methodDispose Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the MovingValueInputAdapter object and optionally releases the managed resources.
(Overrides InputAdapterBaseDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase)
Public methodGetHashCode Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase)
Public methodGetShortStatus Gets a short one-line status of this MovingValueInputAdapter.
(Overrides AdapterBaseGetShortStatus(Int32))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodIncrementProcessedMeasurements Safely increments the total processed measurements.
(Inherited from AdapterBase)
Public methodInitialize Initializes MovingValueInputAdapter.
(Overrides InputAdapterBaseInitialize)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterBase)
Protected methodOnConnected Called when data input source connection is established.
(Inherited from InputAdapterBase)
Protected methodOnDisconnected Called when data input source is disconnected.
(Inherited from InputAdapterBase)
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase)
Protected methodOnNewMeasurements Raises the NewMeasurements event.
(Inherited from InputAdapterBase)
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase)
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnProcessingComplete Raises the ProcessingComplete event.
(Inherited from InputAdapterBase)
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(String, Object)Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase)
Public methodSetInitializedState Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase)
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase)
Public methodStart Starts this adapter and initiates connection cycle to data input source.
(Overrides InputAdapterBaseStart)
Public methodStop Stops this InputAdapterBase and disconnects from data input source.
(Inherited from InputAdapterBase)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase)
Public eventDisposed Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase)
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase)
Public eventNewMeasurements Provides new measurements from input adapter.
(Inherited from InputAdapterBase)
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterBase)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterBase)
Public eventProcessingComplete Indicates to the host that processing for the input adapter has completed.
(Inherited from InputAdapterBase)
Public eventStatusMessage Provides status messages to consumer.
(Inherited from AdapterBase)
Top
Fields
 NameDescription
Public fieldStatic memberDefaultIncludeTime Default value for the IncludeTime property.
Public fieldStatic memberDefaultMaxHoldTime Default value for the MaxHoldTime property.
Public fieldStatic memberDefaultMaxMoveTime Default value for the MaxMoveTime property.
Public fieldStatic memberDefaultMaxValue Default value for the MaxValue property.
Public fieldStatic memberDefaultMinHoldTime Default value for the MinHoldTime property.
Public fieldStatic memberDefaultMinMoveTime Default value for the MinMoveTime property.
Public fieldStatic memberDefaultMinValue Default value for the MinValue property.
Public fieldStatic memberDefaultPublishRate Default value for the PublishRate property.
Public fieldStatic memberDefaultRandomNumberSeed Default value for the RandomNumberSeed property.
Public fieldStatic memberDefaultValueWraps Default value for the ValueWraps property.
Top
See Also