|
Random
|
Represents a class used to stream in random values for input measurements.
Inheritance Hierarchy
SystemObject
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersInputAdapterBase
TestingAdaptersRandomValueInputAdapter
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersInputAdapterBase
TestingAdaptersRandomValueInputAdapter
Namespace: TestingAdapters
Assembly: TestingAdapters (in TestingAdapters.dll) Version: 2.4.218-beta
SyntaxThe RandomValueInputAdapter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RandomValueInputAdapter | Creates a new RandomValueInputAdapter. |
Properties| Name | Description | |
|---|---|---|
 | AutoStart |
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase) |
 | ConnectionAttemptInterval |
Gets or sets the connection attempt interval, in milliseconds, for the data input source.
(Inherited from InputAdapterBase) |
| ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from AdapterBase) |
| ConnectionString |
Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase) |
| DataSource |
Gets or sets DataSet based data source available to this AdapterBase.
(Inherited from AdapterBase) |
| EnableConnectionErrors |
When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
(Inherited from InputAdapterBase) |
| Enabled |
Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase) |
| ID |
Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase) |
| InitializationTimeout |
Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase) |
| Initialized |
Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the AdapterBase expects, if any.
(Inherited from InputAdapterBase) |
| InterpointDelay | Gets or sets number of milliseconds between points. |
| IsConnected |
Gets flag that determines if InputAdapterBase is connected.
(Inherited from InputAdapterBase) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase) |
| Log |
Log messages generated by an adapter.
(Inherited from AdapterBase) |
| MeasurementReportingInterval |
Gets or sets the measurement reporting interval.
(Inherited from AdapterBase) |
| Name |
Gets or sets the name of this RandomValueInputAdapter.
(Overrides AdapterBaseName) |
| OutputMeasurements |
Gets or sets output measurements that the AdapterBase will produce, if any.
(Inherited from AdapterBase) |
| OutputSourceIDs |
Gets or sets Source values used to filter output measurements.
(Inherited from InputAdapterBase) |
| PointsToSend | Gets or sets number of test points to send. |
| ProcessedMeasurements |
Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase) |
| ProcessingInterval |
Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from AdapterBase) |
| RequestedOutputMeasurementKeys |
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from InputAdapterBase) |
| RunTime |
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase) |
| Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase) |
| StartTime |
Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase) |
| StartTimeConstraint |
Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase) |
| Status |
Returns the detailed status of the data input source.
(Overrides InputAdapterBaseStatus) |
| StopTime |
Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase) |
| StopTimeConstraint |
Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase) |
| SupportsTemporalProcessing |
Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing) |
| UseAsyncConnect |
Gets flag that determines if the data input connects asynchronously.
(Overrides InputAdapterBaseUseAsyncConnect) |
Methods| Name | Description | |
|---|---|---|
 | AttemptConnection |
Attempts to connect to data input source.
(Overrides InputAdapterBaseAttemptConnection) |
| AttemptDisconnection |
Attempts to disconnect from data input source.
(Overrides InputAdapterBaseAttemptDisconnection) |
| Dispose |
Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the InputAdapterBase object and optionally releases the managed resources.
(Inherited from InputAdapterBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase) |
| GetHashCode |
Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase) |
| GetShortStatus |
Gets a short one-line status of this RandomValueInputAdapter.
(Overrides AdapterBaseGetShortStatus(Int32)) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IncrementProcessedMeasurements |
Safely increments the total processed measurements.
(Inherited from AdapterBase) |
| Initialize |
Intializes RandomValueInputAdapter.
(Overrides InputAdapterBaseInitialize) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterBase) |
| OnConnected |
Called when data input source connection is established.
(Inherited from InputAdapterBase) |
| OnDisconnected |
Called when data input source is disconnected.
(Inherited from InputAdapterBase) |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase) |
| OnNewMeasurements |
Raises the NewMeasurements event.
(Inherited from InputAdapterBase) |
| OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase) |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from AdapterBase) |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises the ProcessException event.
(Inherited from AdapterBase) |
| OnProcessingComplete |
Raises the ProcessingComplete event.
(Inherited from InputAdapterBase) |
| OnStatusMessage(String) | Obsolete. Raises the StatusMessage event. (Inherited from AdapterBase) |
| OnStatusMessage(String, Object) | Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterBase) |
| OnStatusMessage(MessageLevel, String, String, MessageFlags) |
Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase) |
| SetInitializedState |
Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase) |
| SetTemporalConstraint |
Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase) |
| Start |
Starts this InputAdapterBase and initiates connection cycle to data input source.
(Inherited from InputAdapterBase) |
| Stop |
Stops this InputAdapterBase and disconnects from data input source.
(Inherited from InputAdapterBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase) |
| Disposed |
Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase) |
| NewMeasurements |
Provides new measurements from input adapter.
(Inherited from InputAdapterBase) |
| OutputMeasurementsUpdated |
Event is raised when OutputMeasurements are updated.
(Inherited from AdapterBase) |
| ProcessException |
Event is raised when there is an exception encountered while processing.
(Inherited from AdapterBase) |
| ProcessingComplete |
Indicates to the host that processing for the input adapter has completed.
(Inherited from InputAdapterBase) |
| StatusMessage |
Provides status messages to consumer.
(Inherited from AdapterBase) |
Fields| Name | Description | |
|---|---|---|
  | DefaultInterpointDelay | Specifies the default value for the InterpointDelay property. |
| DefaultPointsToSend | Specifies the default value for the DefaultPointsToSend property. |
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:
| 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 | Multipler 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