AF SDK Reference

AFPathToken Structure

Save PDF

Save PDF

AFPathToken Structure

Represents a path token from parsing an object path.

Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

[SerializableAttribute]
public struct AFPathToken : IEquatable<AFPathToken>

<SerializableAttribute>
Public Structure AFPathToken
	Implements IEquatable(Of AFPathToken)

Dim instance As AFPathToken

[SerializableAttribute]
public value class AFPathToken : IEquatable<AFPathToken>

[<SealedAttribute>]
[<SerializableAttribute>]
type AFPathToken =  
    struct
        interface IEquatable<AFPathToken>
    end

The AFPathToken type exposes the following members.

	Name	Description
	AFPathToken(String, NullableInt32, Boolean)	Creates an AFPathToken instance representing a PIPoint.
	AFPathToken(AFIdentity, AFPathFilterType, String, Int32)	Creates an AFPathToken instance with an AFPathFilter.
	AFPathToken(AFIdentity, String, NullableGuid, Boolean, Boolean)	Creates an AFPathToken instance representing an AFObject.

	Name	Description
	AttributeIsPreferred	Indicates if an AFAttribute is the preferred returned object.
	Filters	The list of path filters to be used when searching for the object.
	HasPointID	Indicates if the PointID has a value. Only valid if Identity is PIPoint.
	ID	The unique identifier for the desired object.
	Identity	The AFIdentity of the desired object.
	Name	The name that identifies the desired object.
	NameIsPreferred	Indicates whether the Name or ID is preferred when searching for the object.
	NeedsToBeSorted	Indicates if the list of found objects needs to be sorted before applying the Filters.
	PointID	The unique identifier for the desired PIPoint. Only valid if Identity is PIPoint.

	Name	Description
	AddFilter	Add a filter to the token's list of Filters.
	Equals(Object)	Determines whether the specified Object is equal to the current object. (Overrides ValueTypeEquals(Object).)
	Equals(AFPathToken)	Indicates whether the current object is equal to another object of the same type.
	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 ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ParsePath	Parses the specified path to an object into path tokens.
	ToString	Returns a String that represents the current object. (Overrides ValueTypeToString.)

	Name	Description
	Equality	The equality operator (==) compares its operands to determine if they are equal.
	Inequality	The inequality operator (!=) compares its operands to determine if they are not equal.

This structure represents the information about a path token created when parsing the path to an object.

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6