PIAdapters Represents a connection to a PI server that handles open, close and executes operations. Default value for . Raised when has been disconnected from server. Creates a new OSI-PI connection. Gets PI server object for this PI connection. Gets or sets the name of the PI server for the adapter's PI connection. Gets or sets the name of the PI user ID for the adapter's PI connection. Gets or sets the password used for the adapter's PI connection. Gets or sets the timeout interval (in milliseconds) for the adapter's connection. Gets flag that determines if is currently connected to . 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. Attempts to open . Closes . Compares the current object with another object of the same type. A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter. Zero This object is equal to . Greater than zero This object is greater than . An object to compare with this object. Represents a pool of instances. Default value for . Default value for . Raised when a has been disconnected from server. Creates a new . Creates a new . Minimum pool size to maintain. Releases the unmanaged resources before the object is reclaimed by . Gets minimum pool size for the . Gets or sets maximum accessibility count for each . Gets current size of connection pool. 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. Gets a connection from the pool or creates a new one if all current connections are being used at peak access. Name of the PI server for the adapter's PI connection. Name of the PI user ID for the adapter's PI connection. Password used for the adapter's PI connection. Timeout interval (in milliseconds) for the adapter's connection. A from the pool. Failed to get a pooled PI connection. Returns to the pool. to return to the pool. Provided PIConnection does not belong to this connection pool. Enumeration that defines the available operations for PI tag removal during metadata synchronization. Do not remove any existing PI tags. This is the default operation. Remove any PI tags where the PI point source matches the setting defined in the PI output adapter and the PI tag no longer exists in the local metadata. This is the recommended option when it is desirable that any locally defined tags that get removed also get removed from PI. This is the least aggressive tag removal synchronization operation. Only PI tags that have a matching point source name will be considered for removal. After point source match, then any PI tags where existing measurement signal ID is not found in any extended descriptors will be removed. Note that removal of any point tags in PI metadata will cause history for removed tags to be inaccessible. Remove any PI tags where existing measurement signal ID is not found in any extended descriptors. Use with caution as metadata in PI will be updated to exactly match local metadata. WARNING: Do not use this option if target PI instance is used for storage of any data other than this local PI adapter. This is the most aggressive tag removal synchronization operation. Any PI tags that do not exist in local metadata will be removed from PI. This option ensures that PI metadata will exactly match local metadata. Note that removal of any point tags in PI metadata will cause history for removed tags to be inaccessible. Defines the available digital state sets for IEEE C37.118 connection states, quality and status word bits. These digital state sets are used to expand the status word bits into individual digital tags as well as other pertinent information related to an IEEE C37.118 connection. These digital state sets are based on, and are compatible with, the digital state sets defined for the IEEE C37.118 Interface to the PI System. Represents the composite quality status digital state. Digital tag receives a composite status from the Data Valid, PMU Error, Sync Error and Data Sorting flags. If any of these flags are set, the value of this tag will be set to 1. Otherwise, it will be zero. Represents the configuration change status bit digital state. Digital tag that is set to 1 when the configuration change flag (bit 10) in the STAT word is true. Represents the connect state status bit digital state. Digital tag receives the current connection state. Represents the data sorting status bit digital state. Digital tag receives the Data Sorting bit (12) from the STAT word. Represents the data valid status bit digital state. Digital tag receives the Data Validity bit (15) from the STAT word. Represents the leap second status bits digital state. Digital tag receives the Leap Second quality bits (6-4) from the time quality flags. Represents the nominal frequency status bit digital state. Nominal line frequency (FNOM) from last CONFIG block. Represents the PMU error status bit digital state. Digital tag receives the PMU Error bit (14) from the STAT word. Represents the time sync error status bit digital state. Digital tag receives the PMU Sync Error bit (13) from the STAT word. Represents the timelock status bits digital state. Digital tag receives the Unlocked Time quality bits (5-4) from the STAT word. Represents the time quality status bits digital state. Digital tag receives the Time Quality bits (3-0) from the time quality flags. Represents the trigger status bits digital state. Digital tag receives the Trigger Reason bits (3-0) from the STAT word Exports measurements to PI if the point tag or alternate tag corresponds to a PI point's tag name. Creates a new Gets or sets based data source available to this . Gets or sets primary keys of input measurements the expects. Gets or sets input measurement 's for each of the , if any. Returns true to indicate that this is sending measurements to a historian, OSIsoft PI. Returns false to indicate that this will connect synchronously. Gets or sets the name of the PI server for the adapter's PI connection. Gets or sets the name of the PI user ID for the adapter's PI connection. Gets or sets the password used for the adapter's PI connection. Gets or sets the timeout interval (in milliseconds) for the adapter's connection. Gets or sets whether this adapter should automatically manage metadata for PI points. Gets or sets whether this adapter should automatically create new tags when managing metadata for PI points. Gets or sets whether this adapter should automatically update existing tags when managing metadata for PI points. Gets or sets whether this adapter should automatically remove PI tags that no longer exist locally in metadata. Gets or sets flag that determines if tag synchronization should only use alternate tag fields. Gets or sets flag that determines if tag synchronization should skip digitals when alternate tag field is being used. Gets or sets flag that determines if tag synchronization should skip analogs when alternate tag field is being used. Gets or sets the number of tag name prefixes, e.g., "SOURCE!", applied by subscriptions to remove from PI tag names. Gets or sets the point source string used when automatically creating new PI points during the metadata update 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. 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. Gets or sets flag that determines if existing PI values should be replaced when UseCompression is enabled. Gets or sets the PI AF value status to use when storing measurements that have been marked as having bad data. This defaults to meaning values are stored with normal status quality in PI. Gets or sets the PI AF value status to use when storing measurements that have been marked as having bad time. This defaults to meaning values are stored with normal status quality in PI. Gets or sets the flag that determines if the descriptor state should be updated for existing tags. Gets or sets the flag that determines if the compression enabled state should be added for new tags. Gets or sets the flag that determines if the compression enabled state, per UseCompression flag, should be adjusted for existing tags, overriding existing configuration. Gets or sets the defined compression deviations for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled. Gets or sets the defined value spans for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled. Gets or sets the defined step enabled for values for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled. Gets or sets the defined zero values for data types used when AddTagCompressionState or UpdateExistingTagCompressionState is enabled. 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. 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. Gets or sets the filename to be used for tag map cache. 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. Gets or sets flag that indicates if incoming timestamps to the historian should be validated for reasonability. Gets or sets the maximum number of seconds that a past timestamp, as compared to local clock, will be considered valid. Gets or sets the maximum number of seconds that a future timestamp, as compared to local clock, will be considered valid. Gets or sets flag that determines if IEEE C37.118 status bits should be expanded to tags. 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 . Gets or sets flag that determines if IEEE C37.118 quality bits should be expanded to tags. 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 . 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. 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 . Gets or sets flag that determines if digital bits should be expanded to tags. 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 . 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. Gets or sets the semicolon separated digital state set name to tag name expression map. One expression should exist for each state defined in . Use format "DigitalStateName=Expression;DigitalStateName=Expression;...". Use "*" for default expression. Gets or sets the semicolon separated regular expressions for excluding digital labels from being expanded to tags. Returns the detailed status of the data output source. 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. Gets full archive queue status. Attempts to lookup PI tag in PI server metadata. PI tag name to lookup in PI server. Queues a point tag for value tracing. Point tag name to trace. Clears any point tags queued for value tracing. Show configured status word measurements and related bit measurements. Show configured quality word measurements and related bit measurements. Returns a brief status of this Maximum number of characters in the status string Short status. Initializes this . Connects to the configured PI server. Closes this connections to the PI server. Queues a collection of measurements for processing. Measurements are automatically filtered to the defined . Measurements to queue for processing. Sorts measurements and sends them to the configured PI server in batches Measurements to queue Sends updated metadata to PI. Accesses local output adapter instances (normally only one). Predefined digital state set AF enumeration values for IEEE C37.118 connection states, quality and status word bits, see . Retrieves historical OSI-PI data using AF-SDK. Creates a new instance of the . Gets or sets the name of the PI server for the adapter's PI connection. Gets or sets the name of the PI user ID for the adapter's PI connection. Gets or sets the password used for the adapter's PI connection. Gets or sets the timeout interval (in milliseconds) for the adapter's connection Gets or sets value paging factor to read more data per page from PI. Gets the flag indicating if this adapter supports temporal processing. Returns the detailed status of the data input source. 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 this . HistorianID, Server, Port, Protocol, or InitiateConnection is missing from the . Gets a short one-line status of this . Maximum length of the status message. Text of the status message. Attempts to connect to this . Commnad that reads the PI Buffer for the specified time range and tags. The start Time of the requested data. The end time for the data requested. The list of PI Tags of the data requested separated by ;. A string representing the read buffer data as comma-separated values in form tag:data1,time1;data2,time2 \newLine Retrieves historical OSI-PI data using AF-SDK. Creates a new instance of the . Gets or sets instance name defined for this . Gets or sets the name of the PI server for the adapter's PI connection. Gets or sets the name of the PI user ID for the adapter's PI connection. Gets or sets the password used for the adapter's PI connection. Gets or sets the timeout interval (in milliseconds) for the adapter's connection Gets or sets the publication interval for this . Gets the start time for reading data. Gets the stop time for reading data. Gets or sets a value that determines whether timestamps are simulated for the purposes of real-time concentration. Gets or sets value paging factor to read more data per page from PI. Gets or sets value that determines if the input data should be replayed repeatedly. Gets or sets the number of tag name prefixes, e.g., "SOURCE!", applied by subscriptions to remove from PI tag names. Gets the flag indicating if this adapter supports temporal processing. Gets or sets the desired processing interval, in milliseconds, for the adapter. Except for 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 this uses an asynchronous connection. Returns the detailed status of the data input source. 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 this . HistorianID, Server, Port, Protocol, or InitiateConnection is missing from the . Gets a short one-line status of this . Maximum length of the status message. Text of the status message. Attempts to connect to this . Attempts to disconnect from this . Uses PI event pipes to deliver real-time PI data to GSF host Receives real-time updates from PI Returns false to indicate that this does NOT connect asynchronously Returns false to indicate that this does NOT support temporal processing. Temporal processing is supported in a separate adapter that is not driven by event pipes. Gets or sets the measurements that this has been requested to provide Gets or sets the name of the PI server for the adapter's PI connection. Gets or sets the name of the PI user ID for the adapter's PI connection. Gets or sets the password used for the adapter's PI connection. Gets or sets the timeout interval (in milliseconds) for the adapter's connection Last timestamp received from PI Returns the status of the adapter 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. Reads values from the connection string and prepares this for connecting to PI Connects to the configured PI server. Disconnects from the configured PI server if a connection is open Returns brief status with measurements processed Reads a series of record values from a in time sorted order. Gets or sets the source points that this scanner is reading from. Gets or sets the minimum value of the timestamps of the data points returned by the scanner. Gets or sets the maximum value of the timestamps of the data points returned by the scanner. Gets or sets the handler used to manage any exceptions that may occur while reading data. Reads all instances in time sorted order as a yielding enumerable. Defines a paging factor used to load more data into a page. Each recorded in time-sorted order for the specified and time-range. Reads all instances in time sorted order as a yielding enumerable using PI InterpolatedValues API. Defines a paging factor used to load more data into a page. Defines the interval used for interpolation. Each recorded in time-sorted order for the specified and time-range.