AF SDK Reference

AFObject Class

Save PDF

TABLE OF CONTENTS

AFObject Class

Save PDF

Last UpdatedNov 18, 2025
7 minute read

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: 3.1.1.1182

Syntax

[SerializableAttribute]
public abstract class AFObject : IComparable<AFObject>, 
	IComparable, IEquatable<AFObject>, ISerializable, IPIPersist

<SerializableAttribute>
Public MustInherit Class AFObject
	Implements IComparable(Of AFObject), IComparable, 
	IEquatable(Of AFObject), ISerializable, IPIPersist

Dim instance As AFObject

[SerializableAttribute]
public ref class AFObject abstract : IComparable<AFObject^>, 
	IComparable, IEquatable<AFObject^>, ISerializable, IPIPersist

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type AFObject =  
    class
        interface IComparable<AFObject>
        interface IComparable
        interface IEquatable<AFObject>
        interface ISerializable
        interface IPIPersist
    end

The AFObject type exposes the following members.

Properties

	Name	Description
	ID	Read-only property that provides a unique identifier for the object to be used for quick access that is not dependent upon the index.
	Identity	This read-only property contains identity of the object.
	IsDeleted	This read-only property indicates whether the object has been deleted.
	PISystem	This read-only property allows access to the PISystem associated with this object.
	UniqueID	Read-only property that provides the object's ID as a String.

Methods

	Name	Description
	CompareTo(Object)	Compares this instance with a specified Object.
	CompareTo(AFObject)	Compares this instance with a specified AFObject.
	Equals(Object)	Determines whether the specified Object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(AFObject)	Indicates whether the current object is equal to another object of the same type.
	FindObject(String)	Finds the object identified by the full path.
	FindObject(String, AFObject)	Finds the object identified by the path, relative from the specified object.
	FindObject(IListAFPathToken, AFObject)	Finds the object identified by the list of parsed path tokens relative from an optional object.
	FindObjects(String)	Finds a list of objects identified by the full path.
	FindObjects(String, AFObject)	Finds a list of objects identified by the path, relative from the specified object.
	FindObjects(IListAFPathToken, AFObject)	Finds a list of objects identified by the list of parsed path tokens relative from an optional object.
	GenerateUniqueName	Generate a unique name for the items in the specified list.
	GetHashCode	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.)
	GetPath	Returns the full path to the object, using just the names.
	GetPath(AFObject)	Returns the path to the object relative from another object.
	GetPath(AFEncodeType, AFObject)	Returns the path to the object relative from another object, using the name and/or id as specified by encodeType.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Persist	This method returns the persistence string for the object.
	ToString	Returns a String that represents the current object. (Overrides ObjectToString.)
	ValidateName(String, String)	Helper function to validate the name according to the default rules for valid names in the AF SDK.
	ValidateName(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.

Operators

	Name	Description
	Equality	The equality operator (==) compares its operands to determine if they are equal.
	GreaterThan	The greater than relation operator (>) compares its operands to determine which one is greater than the other.
	GreaterThanOrEqual	The greater than or equal relation operator (>=) compares its operands to determine which one is greater than or equal to the other.
	Inequality	The inequality operator (!=) compares its operands to determine if they are not equal.
	LessThan	The less than relation operator (<) compares its operands to determine which one is less than the other.
	LessThanOrEqual	The less than or equal relation operator (<=) compares its operands to determine which one is less than or equal to the other.

Remarks

This base class provides common functionality and implementation for all AF SDK objects (not collections) in the SDK.

Version Information

AFSDK

Inheritance Hierarchy

AF SDK Reference

AFObject Class

Table of Contents

AFObject Class

Inheritance Hierarchy

Syntax

Properties

Methods

Operators

Remarks

Version Information

AFSDK

See Also

Reference

Other Resources

Inheritance Hierarchy

In This Topic

Related Links