Click or drag to resize
OSIsoft, LLC

AFObject Class

Base class used for all objects in the AF SDK.
Inheritance Hierarchy
SystemObject
  OSIsoft.AFAFObject
    More...

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
[SerializableAttribute]
public abstract class AFObject : IComparable<AFObject>, 
	IComparable, IEquatable<AFObject>, ISerializable, IPIPersist

The AFObject type exposes the following members.

Properties
  NameDescription
Public propertyID
Read-only property that provides a unique identifier for the object to be used for quick access that is not dependent upon the index.
Public propertyIdentity
This read-only property contains identity of the object.
Public propertyIsDeleted
This read-only property indicates whether the object has been deleted.
Public propertyPISystem
This read-only property allows access to the PISystem associated with this object.
Public propertyUniqueID
Read-only property that provides the object's ID as a String.
Top
Methods
  NameDescription
Public methodCompareTo(Object)
Compares this instance with a specified Object.
Public methodCompareTo(AFObject)
Compares this instance with a specified AFObject.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(AFObject)
Indicates whether the current object is equal to another object of the same type.
Public methodStatic memberFindObject(String)
Finds the object identified by the full path.
Public methodStatic memberFindObject(String, AFObject)
Finds the object identified by the path, relative from the specified object.
Public methodStatic memberFindObject(IListAFPathToken, AFObject)
Finds the object identified by the list of parsed path tokens relative from an optional object.
Public methodStatic memberFindObjects(String)
Finds a list of objects identified by the full path.
Public methodStatic memberFindObjects(String, AFObject)
Finds a list of objects identified by the path, relative from the specified object.
Public methodStatic memberFindObjects(IListAFPathToken, AFObject)
Finds a list of objects identified by the list of parsed path tokens relative from an optional object.
Public methodStatic memberGenerateUniqueName
Generate a unique name for the items in the specified list.
Public methodGetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.)
Public methodGetPath
Returns the full path to the object, using just the names.
Public methodGetPath(AFObject)
Returns the path to the object relative from another object.
Public methodGetPath(AFEncodeType, AFObject)
Returns the path to the object relative from another object, using the name and/or id as specified by encodeType.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodPersist
This method returns the persistence string for the object.
Public methodToString
Returns a String that represents the current object.
(Overrides ObjectToString.)
Public methodStatic memberValidateName(String, String)
Helper function to validate the name according to the default rules for valid names in the AF SDK.
Public methodStatic memberValidateName(AFIdentity, String, String)
Helper function to validate the name according to the rules for valid names of the specified object type in the AF SDK.
Top
Operators
  NameDescription
Public operatorStatic memberEquality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic memberGreaterThan
The greater than relation operator (>) compares its operands to determine which one is greater than the other.
Public operatorStatic memberGreaterThanOrEqual
The greater than or equal relation operator (>=) compares its operands to determine which one is greater than or equal to the other.
Public operatorStatic memberInequality
The inequality operator (!=) compares its operands to determine if they are not equal.
Public operatorStatic memberLessThan
The less than relation operator (<) compares its operands to determine which one is less than the other.
Public operatorStatic memberLessThanOrEqual
The less than or equal relation operator (<=) compares its operands to determine which one is less than or equal to the other.
Top
Remarks
This base class provides common functionality and implementation for all AF SDK objects (not collections) in the SDK.
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Inheritance Hierarchy
SystemObject
  OSIsoft.AFAFObject
    OSIsoft.AFAFCategory
    OSIsoft.AFAFContact
    OSIsoft.AFAFDatabase
    OSIsoft.AFAFLibrary
    OSIsoft.AFAFPlugIn
    OSIsoft.AFAFSecurityIdentity
    OSIsoft.AFAFSecurityMapping
    OSIsoft.AF.AnalysisAFAdjustment
    OSIsoft.AF.AnalysisAFAnalysis
    OSIsoft.AF.AnalysisAFAnalysisRule
    OSIsoft.AF.AnalysisAFAnalysisService
    OSIsoft.AF.AnalysisAFAnalysisTemplate
    OSIsoft.AF.AnalysisAFResult
    OSIsoft.AF.AssetAFAttribute
    OSIsoft.AF.AssetAFAttributeTemplate
    OSIsoft.AF.AssetAFBaseElement
    OSIsoft.AF.AssetAFDataReference
    OSIsoft.AF.AssetAFElementTemplate
    OSIsoft.AF.AssetAFEnumerationSet
    OSIsoft.AF.AssetAFEnumerationValue
    OSIsoft.AF.AssetAFReferenceType
    OSIsoft.AF.AssetAFTable
    OSIsoft.AF.AssetAFTableConnection
    OSIsoft.AF.CollectiveAFCollective
    OSIsoft.AF.CollectiveAFCollectiveMember
    OSIsoft.AF.ModelingAFConnection
    OSIsoft.AF.ModelingAFLayer
    OSIsoft.AF.ModelingAFPort
    OSIsoft.AF.NotificationAFDeliveryChannel
    OSIsoft.AF.NotificationAFDeliveryFormat
    OSIsoft.AF.NotificationAFNotificationContact
    OSIsoft.AF.NotificationAFNotificationContactTemplate
    OSIsoft.AF.NotificationAFNotificationContent
    OSIsoft.AF.NotificationAFNotificationRule
    OSIsoft.AF.NotificationAFNotificationRuleSubscriber
    OSIsoft.AF.NotificationAFNotificationRuleTemplate
    OSIsoft.AF.PIPICollective
    OSIsoft.AF.PIPICollectiveMember
    OSIsoft.AF.PIPIServer
    OSIsoft.AFPISystem
    OSIsoft.AF.TimeAFTimeRule
    OSIsoft.AF.UnitsOfMeasureUOM
    OSIsoft.AF.UnitsOfMeasureUOMBaseClass
    OSIsoft.AF.UnitsOfMeasureUOMClass
    OSIsoft.AF.UnitsOfMeasureUOMDatabase
    OSIsoft.AF.UnitsOfMeasureUOMGroup
Enabling Operational Intelligence