Click or drag to resize
Grid Solutions Framework

RandomValueInputAdapter Class

Represents a class used to stream in random values for input measurements.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersInputAdapterBase
      TestingAdaptersRandomValueInputAdapter

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

The RandomValueInputAdapter type exposes the following members.

Constructors
 NameDescription
Public methodRandomValueInputAdapter Creates a new RandomValueInputAdapter.
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 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 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 propertyInterpointDelay Gets or sets number of milliseconds between points.
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 propertyMeasurementReportingInterval Gets or sets the measurement reporting interval.
(Inherited from AdapterBase)
Public propertyName Gets or sets the name of this RandomValueInputAdapter.
(Overrides AdapterBaseName)
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 propertyPointsToSend Gets or sets number of test points to send.
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 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.
(Overrides InputAdapterBaseStatus)
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)
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 InputAdapterBase object and optionally releases the managed resources.
(Inherited from InputAdapterBase)
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 RandomValueInputAdapter.
(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 Intializes RandomValueInputAdapter.
(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 InputAdapterBase and initiates connection cycle to data input source.
(Inherited from InputAdapterBase)
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 memberDefaultInterpointDelay Specifies the default value for the InterpointDelay property.
Public fieldStatic memberDefaultPointsToSend Specifies the default value for the DefaultPointsToSend property.
Top
Remarks

Example connection string using manually defined measurements:
outputMeasurements={P3:1345,60.0,1.0;P3:1346;P3:1347}
When defined manually 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 DataSource table:
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:
NameTypeDescription.
IDNVARCHARMeasurement key formatted as: ArchiveSource:PointID.
PointTagNVARCHARPoint tag of measurement.
AdderFLOATAdder to apply to value, if any (default to 0.0).
MultiplierFLOATMultipler to apply to value, if any (default to 1.0).

Note that the random value produced for the points will be a number between 0 to 1, use the Adder and Multipler to narrow down the range for your point. For example, to produce random frequency values between 59.95 and 60.05 you would use the following point definition:
outputMeasurements={LocalDevArchive:2,59.95,0.1}

See Also