PIOutputAdapter Class

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersOutputAdapterBase
      PIAdaptersPIOutputAdapter

public class PIOutputAdapter : OutputAdapterBase

Public Class PIOutputAdapter
	Inherits OutputAdapterBase

public ref class PIOutputAdapter : public OutputAdapterBase

type PIOutputAdapter = 
    class
        inherit OutputAdapterBase
    end

PIAdapters.PIOutputAdapter = function();

Type.createClass(
	'PIAdapters.PIOutputAdapter',
	GSF.TimeSeries.Adapters.OutputAdapterBase);

View Source

	Name	Description
	PIOutputAdapter	Creates a new PIOutputAdapter

Top

	Name	Description
	AddTagCompressionState	Gets or sets the flag that determines if the compression enabled state should be added for new tags.
	ArchiveFilterDataTypes	Gets or sets the data types to archive. Value of * (or empty string) means all values archived, DIGI means only archive digital values. Separate multiple values with a comma, for example: DIGI,VPHM,FREQ.
	ArchiveOnChangeDataTypes	Gets or sets the data types to only archive on change. Empty string value means all values archived, * means archive all values on change, DIGI means only archive digital values on change. Separate multiple values with a comma, for example: DIGI,VPHM,FREQ.
	AutoCreateTags	Gets or sets whether this adapter should automatically create new tags when managing metadata for PI points.
	AutoRemoveTags	Gets or sets whether this adapter should automatically remove PI tags that no longer exist locally in metadata.
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	AutoUpdateTags	Gets or sets whether this adapter should automatically update existing tags when managing metadata for PI points.
	BadDataValueStatus	Gets or sets the PI AF value status to use when storing measurements that have been marked as having bad data.
	BadTimeValueStatus	Gets or sets the PI AF value status to use when storing measurements that have been marked as having bad time.
	CompDevDataTypeMap	Gets or sets the defined compression deviations for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled.
	ConnectionAttemptInterval	Gets or sets the connection attempt interval, in milliseconds, for the data output adapter. (Inherited from OutputAdapterBase)
	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)
	ConnectTimeout	Gets or sets the timeout interval (in milliseconds) for the adapter's connection.
	DataSource	Gets or sets DataSet based data source available to this PIOutputAdapter. (Overrides OutputAdapterBaseDataSource)
	DigitalBitExcludedExpressions	Gets or sets the semicolon separated regular expressions for excluding digital labels from being expanded to tags.
	DigitalBitStateExpressionMap	Gets or sets the semicolon separated pre-existing digital bit state set names mapped to a regular expression for matching digital labels. Use format "DigitalStateName=Expression;DigitalStateName=Expression;...". Use "*" for default expression.
	DigitalBitTagNameExpressionMap	Gets or sets the semicolon separated digital state set name to tag name expression map. One expression should exist for each state defined in DigitalBitStateExpressionMap. Use format "DigitalStateName=Expression;DigitalStateName=Expression;...". Use "*" for default expression.
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	EnableTimeReasonabilityCheck	Gets or sets flag that indicates if incoming timestamps to the historian should be validated for reasonability.
	ExpandDigitalBitsToTags	Gets or sets flag that determines if digital bits should be expanded to tags.
	ExpandQualityBitsToTags	Gets or sets flag that determines if IEEE C37.118 quality bits should be expanded to tags.
	ExpandStatusBitsToTags	Gets or sets flag that determines if IEEE C37.118 status bits should be expanded to tags.
	FutureTimeReasonabilityLimit	Gets or sets the maximum number of seconds that a future timestamp, as compared to local clock, will be considered valid.
	ID	Gets or sets numeric ID associated with this AdapterBase. (Inherited from AdapterBase)
	IEEEC37118DigitalStates	Gets or sets the comma separated digital state set names for IEEE C37.118 status states. Specify digital state set name for each of the following digital states using value of 'X' (without quotes) as the name to indicate state is not mapped: CompositeQual, ConfigChange, ConnectState, DataSorting, DataValid, LeapSecond, NominalFreq, PMUError, SyncError, Timelock, TimeQuality, and Trigger. If digital state sets are predefined, state values are expected to be zero based and incremented by one for each value. If specified digital set name does not exist, it will be created.
	IEEEC37118TagNameExpressions	Gets or sets the semicolon separated tag naming expressions for IEEE C37.118 status states. Specify tag naming expression for each of the following digital states: CompositeQual, ConfigChange, ConnectState, DataSorting, DataValid, LeapSecond, NominalFreq, PMUError, SyncError, Timelock, TimeQuality, and Trigger. Expression can be left blank if no digital state name is mapped for the corresponding state in IEEEC37118DigitalStates.
	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 PIOutputAdapter expects. (Overrides AdapterBaseInputMeasurementKeys)
	InputMeasurementKeyTypes	Gets or sets input measurement SignalType's for each of the InputMeasurementKeys, if any.
	InputSourceIDs	Gets or sets Source values used to filter input measurements. (Inherited from OutputAdapterBase)
	InternalProcessQueue	Allows derived class access to internal processing queue. (Inherited from OutputAdapterBase)
	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)
	MaximumPointResolution	Gets or sets the maximum time resolution, in seconds, for data points being archived, e.g., a value 1.0 would mean that data would be archived no more than once per second. A zero value indicates that all data should be archived.
	MeasurementReportingInterval	Gets or sets the measurement reporting interval. (Inherited from AdapterBase)
	MetadataRefreshOperation	Gets the operation that calls ExecuteMetadataRefresh. (Inherited from OutputAdapterBase)
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OutputIsForArchive	Returns true to indicate that this PIOutputAdapter is sending measurements to a historian, OSIsoft PI. (Overrides OutputAdapterBaseOutputIsForArchive)
	OutputMeasurements	Gets or sets output measurements that the AdapterBase will produce, if any. (Inherited from OutputAdapterBase)
	Password	Gets or sets the password used for the adapter's PI connection.
	PastTimeReasonabilityLimit	Gets or sets the maximum number of seconds that a past timestamp, as compared to local clock, will be considered valid.
	PIPointClass	Gets or sets the point class string used when automatically creating new PI points during the metadata update. On the PI server, this class should inherit from classic.
	PIPointSource	Gets or sets the point source string used when automatically creating new PI points during the metadata update
	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 output adapter. (Inherited from OutputAdapterBase)
	ReplaceValues	Gets or sets flag that determines if existing PI values should be replaced when UseCompression is enabled.
	RequestedInputMeasurementKeys	Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from OutputAdapterBase)
	RequeueOnException	Gets or sets whether or not to automatically place measurements back into the processing queue if an exception occurs while processing. Defaults to false. (Inherited from OutputAdapterBase)
	RunMetadataSync	Gets or sets whether this adapter should automatically manage metadata for PI points.
	RunTime	Gets the total amount of time, in seconds, that the adapter has been active. (Inherited from AdapterBase)
	ServerName	Gets or sets the name of the PI server for the adapter's PI connection.
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. (Inherited from AdapterBase)
	SkipAnalogAlternateTagSync	Gets or sets flag that determines if tag synchronization should skip analogs when alternate tag field is being used.
	SkipDigitalAlternateTagSync	Gets or sets flag that determines if tag synchronization should skip digitals when alternate tag field is being used.
	SpanDataTypeMap	Gets or sets the defined value spans for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled.
	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 output source. (Overrides OutputAdapterBaseStatus)
	StepEnabledDataTypeMap	Gets or sets the defined step enabled for values for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled.
	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 OutputAdapterBase implementation supports temporal processing. (Inherited from OutputAdapterBase)
	SyncAlternateTagOnly	Gets or sets flag that determines if tag synchronization should only use alternate tag fields.
	TagMapCacheFileName	Gets or sets the filename to be used for tag map cache.
	TagNamePrefixRemoveCount	Gets or sets the number of tag name prefixes, e.g., "SOURCE!", applied by subscriptions to remove from PI tag names.
	UpdateExistingDescriptorState	Gets or sets the flag that determines if the descriptor state should be updated for existing tags.
	UpdateExistingTagCompressionState	Gets or sets the flag that determines if the compression enabled state, per UseCompression flag, should be adjusted for existing tags, overriding existing configuration.
	UseAsyncConnect	Returns false to indicate that this PIOutputAdapter will connect synchronously. (Overrides OutputAdapterBaseUseAsyncConnect)
	UseCompression	Gets or sets the flag that determines if compression will be used during archiving when compression is configured for tag. If disabled, configured tag compression and ReplaceValues setting are ignored.
	UserName	Gets or sets the name of the PI user ID for the adapter's PI connection.
	WriteDigitalWord	Gets or sets flag that determines if digital word should be written to PI as a separate tag. Commonly disabled if digital bits are expanded to tags, see ExpandDigitalBitsToTags.
	WriteQualityWord	Gets or sets flag that determines if quality word should be written to PI as a separate tag. Commonly disabled if IEEE C37.118 quality bits are expanded to tags, see ExpandQualityBitsToTags.
	WriteStatusWord	Gets or sets flag that determines if status word should be written to PI as a separate tag. Commonly disabled if IEEE C37.118 status bits are expanded to tags, see ExpandStatusBitsToTags.
	ZeroValueDataTypeMap	Gets or sets the defined zero values for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled.

Top

	Name	Description
	AttemptConnection	Connects to the configured PI server. (Overrides OutputAdapterBaseAttemptConnection)
	AttemptDisconnection	Closes this PIOutputAdapter connections to the PI server. (Overrides OutputAdapterBaseAttemptDisconnection)
	ClearTracedMeasurements	Clears any point tags queued for value tracing.
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the PIOutputAdapter object and optionally releases the managed resources. (Overrides OutputAdapterBaseDispose(Boolean))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteMetadataRefresh	Sends updated metadata to PI. (Overrides OutputAdapterBaseExecuteMetadataRefresh)
	Finalize	Releases the unmanaged resources before the AdapterBase object is reclaimed by GC. (Inherited from AdapterBase)
	Flush	Blocks the current thread, if the OutputAdapterBase is connected, until all items in OutputAdapterBase queue are processed, and then stops processing. (Inherited from OutputAdapterBase)
	GetArchiveQueueStatus	Gets full archive queue status.
	GetHashCode	Serves as a hash function for the current AdapterBase. (Inherited from AdapterBase)
	GetShortStatus	Returns a brief status of this PIOutputAdapter (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	Initializes this PIOutputAdapter. (Overrides OutputAdapterBaseInitialize)
	LookupPITag	Attempts to lookup PI tag in PI server metadata.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnConfigurationChanged	Raises ConfigurationChanged event. (Inherited from AdapterBase)
	OnConnected	Called when data output source connection is established. (Inherited from OutputAdapterBase)
	OnDisconnected	Called when data input source is disconnected. (Inherited from OutputAdapterBase)
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event. (Inherited from AdapterBase)
	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)
	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)
	OnUnprocessedMeasurements	Raises the UnprocessedMeasurements event. (Inherited from OutputAdapterBase)
	ProcessMeasurements	Sorts measurements and sends them to the configured PI server in batches (Overrides OutputAdapterBaseProcessMeasurements(IMeasurement))
	QueueMeasurementForProcessing	Queues a single measurement for processing. Measurement is automatically filtered to the defined InputMeasurementKeys. (Inherited from OutputAdapterBase)
	QueueMeasurementsForProcessing	Queues a collection of measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys. (Overrides OutputAdapterBaseQueueMeasurementsForProcessing(IEnumerableIMeasurement))
	RefreshMetadata	Initiates request for metadata refresh for OutputAdapterBase, if implemented. (Inherited from OutputAdapterBase)
	RemoveMeasurements	This removes a range of measurements from the internal measurement queue. (Inherited from OutputAdapterBase)
	SetInitializedState	Manually sets the initialized state of the AdapterBase. (Inherited from AdapterBase)
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter. (Inherited from AdapterBase)
	ShowQualityWordMeasurements	Show configured quality word measurements and related bit measurements.
	ShowStatusWordMeasurements	Show configured status word measurements and related bit measurements.
	Start	Starts this OutputAdapterBase and initiates connection cycle to data output stream. (Inherited from OutputAdapterBase)
	Stop	Stops this OutputAdapterBase and disconnects from data output stream. (Inherited from OutputAdapterBase)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TraceMeasurement	Queues a point tag for value tracing.

Top

	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)
	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)
	StatusMessage	Provides status messages to consumer. (Inherited from AdapterBase)
	UnprocessedMeasurements	Event is raised every five seconds allowing host to track total number of unprocessed measurements. (Inherited from OutputAdapterBase)

Top

	Name	Description
	C37118DigitalStateSetValues	Predefined digital state set AF enumeration values for IEEE C37.118 connection states, quality and status word bits, see C37118DigitalStateSets.
	Instances	Accesses local output adapter instances (normally only one).

Top

Reference

PIAdapters Namespace