Click or drag to resize
OSIsoft, LLC

OSIsoft.AF Namespace

The top-level OSIsoft.AF namespace contains the main classes that are used by all the other namespaces within the AF SDK. It also contains the PISystems collection which is the top level of the AF SDK hierarchy.
Classes
  ClassDescription
Public classAFActiveDirectoryProperties
The AFActiveDirectoryProperties object is used to get and set the Active Directory configuration properties used by the PI AF Server to access contact information.
Public classCode exampleAFCategories
The AFDatabase object maintains the collection of all global AFCategory collections defined on a database.
Public classCode exampleAFCategory
The AFCategory represents a user-defined value used to categorize objects within the AF SDK. Use it to group objects by categories when generating reports or when making queries.
Public classAFChangedEventArgs
Provides data for the Changed event.
Public classCode exampleAFCheckOutInfo
The AFCheckOutInfo object is used to represent the checked out status information of the current object.
Public classAFCollection
Base class used for all collections in the AF SDK.
Public classAFCollectionT
Provides the abstract base class used for all collections in the AF SDK that are indexed by unique identifier.
Public classAFCollectionListT
A generic list of objects that does not have name lookup. This collection can be a user-defined collection of objects which belong to different objects.
Public classAFConnectionInfo
The AFConnectionInfo object is used to provide the connection configuration information and status to the PI AF Server.
Public classCode exampleAFContact
A AFContact provides contact information maintained by AF.
Public classAFCsvColumn
Class used to represent individual columns when using CSV import and export.
Public classAFCsvColumns
A collection of AFCsvColumn objects.
Public classCode exampleAFDatabase
The AFDatabase represents a single database (data archive) in a PI AF Server.
Public classCode exampleAFDatabases
The collection of AFDatabase objects maintained by the SDK for elements on the PISystem.
Public classAFErrorsTKey
This class is used to return error information.
Public classAFEventArgs
Base class for EventArgs that can be associated with an event in the SDK.
Public classAFGlobalRestorer
The AFGlobalRestorer is used to restore objects persisted using the IPIPersist interface.
Public classAFGlobalSettings
All the global application settings.
Public classAFKeyedResultsTKey, TResult
This class is used to return a dictionary of results along with error information.
Public classCode exampleAFLibraries
The collection of AFLibrary objects that provides application and domain specific information that can be loaded into a PISystem.
Public classCode exampleAFLibrary
The AFLibrary is a collection of application or domain information that can be imported into an PISystem.
Public classAFListResultsTKey, TResult
This class is used to return a list of results along with error information.
Public classAFNamedCollectionT
Provides the abstract base class used for all collections in the AF SDK that are indexed by unique identifier and name.
Public classAFNamedCollectionListT
A generic list of objects that support name lookups. This collection can be a user-defined collection of objects which belong to different objects.
Public classAFNameSubstitution
This class provides support for the name substitution used with setting the names of objects.
Public classAFObject
Base class used for all objects in the AF SDK.
Public classCode exampleAFPlugIn
The AFPlugIn contains the information about a AF plugin that is defined and installed on the PI AF Server.
Public classAFPlugInLoadPropertiesAttribute
Attribute used on an AFPlugIn assembly to specify the AFPlugInLoadProperties used to control the loading of the plugin.
Public classAFPlugInNonEditableConfigAttribute
Attribute used on an AFPlugIn to indicate that the editing of its configuration is not allowed in the user interface.
Public classCode exampleAFPlugIns
This collection contains the list of AFPlugIn objects that are installed on the server's workstation.
Public classAFProgressEventArgs
Provides data for a progress event.
Public classAFSDKExtension
Static class provides extension methods for classes within the AF SDK.
Public classAFSecurity
The AFSecurity object provides access and control to the security aspects of the associated object.
Public classCode exampleAFSecurityIdentities
The collection of AFSecurityIdentity objects is maintained by the PISystem (PI AF Server).
Public classCode exampleAFSecurityIdentity
The AFSecurityIdentity object represents a security identity on a PISystem (PI AF Server).
Public classCode exampleAFSecurityMapping
The AFSecurityMapping object represents a mapping between a Windows identity and an AFSecurityIdentity on a PISystem (PI AF Server).
Public classCode exampleAFSecurityMappings
The AFSecurityMappings collection represents the available AFSecurityMapping objects on a particular PISystem (PI AF Server).
Public classAFSecurityRightsExtension
Static class provides extension methods for AFSecurityRights enumeration.
Public classNumericStringComparerT
Represents a numeric string comparison operation that uses special case-insensitive comparison rules for strings with numeric values.
Public classCode examplePISystem
The PISystem represents a single logical data store for the AF SDK.
Public classCode examplePISystems
The global collection of PISystem objects maintained by the AF SDK represents the known systems available from a workstation for client applications.
Public classUniversalComparerT
A universal comparer that can be used to compare any two objects for equivalence using any combination of properties.
Structures
  StructureDescription
Public structureCode exampleAFChangeInfo
The AFChangeInfo structure is used when returning information about objects that have changed in the server.
Public structureAFPathFilter
A filter to restrict the objects found from a path.
Public structureAFPathToken
Represents a path token from parsing an object path.
Public structureAFPlugInSupportAssembly
Information about a support assembly for an AFPlugIn.
Public structureAFSecurityEntry
Public structureAFSecurityRightsToken
A security rights token is used to check security for an object.
Interfaces
  InterfaceDescription
Public interfaceIAFChangedEvent
This interface defines the Changed event that is implemented on objects that support notification of changes.
Public interfaceIAFList
An interface implemented by all collections in the AF SDK.
Public interfaceIAFNamedCollectionT
An interface for named collections that support looking up by ID and Name.
Public interfaceIAFSecurable
This interface defines the properties and methods for objects which support security.
Public interfaceIAFTransactable
This interface defines the properties and methods for objects which support being transacted.
Public interfaceIPIPersist
The IPIPersist interface allows a persistence string for an object to be obtained.
Enumerations
  EnumerationDescription
Public enumerationAFChangeAction
Specifies how the AFObject is changed.
Public enumerationAFChangeInfoAction
The action that caused a object to be changed.
Public enumerationAFCheckedOutMode
Defines the different modes that can be specified when checking in or finding modified objects.
Public enumerationAFConnectionPreference
Defines the connection preference when connecting to an AFCollective or PICollective.
Public enumerationAFConnectionProtocol
Defines the connection protocol used to communicate with the PI AF Server.
Public enumerationAFContactType
This enumeration specifies the type of AFContact.
Public enumerationAFEncodeType
Defines the different ways a reference to an object can be encoded using one of the AFObjectGetPath methods.
Public enumerationAFErrorStatus
Defines the possible values for the error status.
Public enumerationAFIdentity
This is the enumeration used for the Identity property.
Public enumerationAFNameSubstitutionFilters
These filters are used when requesting the list of substitution patterns.
Public enumerationAFNameSubstitutionType
The type of substitution used by the AFNameSubstitution class.
Public enumerationAFPathFilterType
The type of filter used when parsing an object path.
Public enumerationAFPlugInLoadProperties
This enumeration specifies the properties for loading the assembly containing the AFPlugIn.
Public enumerationAFProgressStatus
Specifies the status of a operation.
Public enumerationAFSearchField
Defines the fields of the object that are searched.
Public enumerationAFSecurityItem
The AFSecurityItem is an enumeration of the possible values for specifying security item in the method.
Public enumerationAFSecurityOperation
The operation used when adding user security rights to objects.
Public enumerationAFSecurityRights
The AFSecurityRights is an enumeration of the possible values for specifying security access rights of objects.
Public enumerationAFSessionSortField
Defines the AFSession field that is sorted.
Public enumerationAFSortField
Defines the field that is sorted.
Public enumerationAFSortOrder
Defines the sort order.
Public enumerationAFVerifySignatureLevel
This enumeration specifies the possible levels used when verifying the signature of an assembly.
Public enumerationPIExportMode
Indicates the type of export to perform when using an ExportXml method. Since this is a bit mask, several of these values can be set at the same time.
Public enumerationPIImportMode
Indicates the type of import to perform when using an ImportXml or ImportCsvmethod. Since this is a bit mask, several of these values can be set at the same time.
Public enumerationPISystemFeatures
This enumeration represents the features that may be enabled or disabled for the PISystem.
Public enumerationPISystemsAFDirectoryOptions
Defines the directory options used when looking up a PISystem in the PISystems collection or a PIServer in the PIServers collection.
Enabling Operational Intelligence