Click or drag to resize
OSIsoft, LLC

OSIsoft.AF.PI Namespace

The OSIsoft.AF.PI namespace provides a set of classes that can be used to manage connections and access information about a PI Data Archive.
Classes
  ClassDescription
Public classPIAuthenticationException
Represents an authentication error returned from the PIServer.
Public classPIBufferException
Represents an error related to buffering PI data writes.
Public classPICollective
The PICollective object is used to provide the information and status about the PIServer collective.
Public classPICollectiveMember
The PICollectiveMember object is used to provide the information about the member server defined within the PICollective.
Public classPICollectiveMembers
A collection of PICollectiveMember objects maintained by the PICollective.
Public classPICommonPointAttributes
This class contains information about common PIPoint attributes.
Public classPIConfigurationException
Represents a configuration error reading the list of configured PIServers.
Public classPIConnectFailedEventArgs
Provides data for the ConnectFailed event.
Public classPIConnectionException
Represents a connection error attempting to communicate with the specified PIServer.
Public classPIConnectionInfo
The PIConnectionInfo object is used to provide the connection configuration information and status to the PIServer.
Public classPIDatabaseSecurities
The PIDatabaseSecurities collection represents the available PIDatabaseSecurity objects on a particular PIServer.
Public classCode examplePIDatabaseSecurity
The PIDatabaseSecurity object represents an access control to a PIServer table resource.
Public classCode examplePIDataPipe
The PIDataPipe is used to subscribe for data change events on a list of PIPoint instances. The PIPoint instances do not have to be associated with the same PIServer. PIDataPipe instances can sign up for archive, snapshot or timeseries events. The pipe type is specified when the data pipe object is constructed.
Public classPIException
Represents an error returned from the PIServer.
Public classCode examplePIIdentities
The PIIdentities collection represents the available PIIdentity objects on a particular PIServer.
Public classCode examplePIIdentity
The PIIdentity object represents an identity on a PIServer.
Public classCode examplePIIdentityMapping
The PIIdentityMapping object represents a mapping between Windows identity and PIIdentity on a PIServer.
Public classCode examplePIIdentityMappings
The PIIdentityMappings collection represents the available PIIdentityMapping objects on a particular PIServer.
Public classPIPagingConfiguration
The PIPagingConfiguration is used to describe how PIPointList and AFListData data access calls should page results for better performance.
Public classCode examplePIPoint
The PIPoint object represents a point on a PIServer.
Public classPIPointChangesCookie
The PIPointChangesCookie is used in subsequent calls to FindChangedPIPoints(Int32, Object, PIPointChangesCookie, IEnumerablePIPoint) to retrieve changes that have occurred, since the last call was made. This object is serializable, so that consumers can serialize the object before shutdown and reconstitute it on startup.
Public classCode examplePIPointClass
The PIPointClass object represents a point class on a PIServer.
Public classCode examplePIPointClasses
The PIPointClasses collection represents the available PIPointClass objects on a particular PIServer.
Public classPIPointInvalidException
The PIPoint is no longer valid on the PIServer. Most likely, the point is deleted on the server.
Public classCode examplePIPointList
The PIPointList object represents a list of PIPoint objects. The PIPoints can be on different PIServer. PIPointList supports duplicate PIPoint in the list.
Public classCode examplePIPointSource
The PIPointSource object represents a point source on a PIServer.
Public classPIPointSources
The PIPointSources collection represents the point sources that have been created on a particular PIServer.
Public classPISerializationException Obsolete.
Represents a serialization error in data returned from the PIServer.
Public classCode examplePIServer
The PIServer object represents a single PI Data Archive.
Public classCode examplePIServers
The global collection of PIServer objects that represents the known PI Data Archive servers available from a workstation for client applications.
Public classCode examplePIStateSets
The PIStateSets collection represents the available State Sets on a particular PIServer. The State Sets are represented as a collection of AFEnumerationSet objects.
Public classPITimeoutException
Represents a timeout error returned from the PIServer.
Public classPIVersionNotSupportedException
Represents an error when the version of the PIServer is not supported.
Structures
  StructureDescription
Public structurePIBufferStatus
The BufferStatus contains buffering-related information of the PI Buffer Subsystem or a PIServer.
Public structurePIPointChangeInfo
The PIPointChangeInfo structure is used when returning information about PI Points that have changed in the PIServer.
Public structurePIPointQuery
PIPoint attribute value search query structure.
Enumerations
  EnumerationDescription
Public enumerationPIAuthenticationMode
The authentication mode to use when making an explicit connection to a PIServer.
Public enumerationPIAuthenticationOption
Defines the authentication options used when making a connection to a PIServer.
Public enumerationPIBufferHealthStatus
This enumeration defines the possible values for the Health.
Public enumerationPIConnectionResult
Defines the results of a connection attempt to a PIServer.
Public enumerationPIIdentityMappingType
This enumeration defines the types of PIIdentityMapping.
Public enumerationPIIdentityType
This enumeration defines the types of PIIdentity.
Public enumerationPIPageType
The PIPageType is used to determine how partial results from list data access calls should be grouped while being returned to the client. Choosing the appropriate partition type will improve performance.
Public enumerationPIPointType
This enumeration defines the values for the PIPoint.PointType property.
Public enumerationPIServerFeature
This enumeration represents the features that are supported for the PIServer.
Enabling Operational Intelligence