AFAttributeList Class
- Last UpdatedNov 18, 2025
- 8 minute read
- PI System
- AF SDK 2024 R2
- Developer
A collection of AFAttribute objects. This collection can be
a user created collection of attributes which belong to different objects.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFAttribute
OSIsoft.AFAFNamedCollectionAFAttribute
OSIsoft.AFAFNamedCollectionListAFAttribute
OSIsoft.AF.AssetAFAttributeList
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFAttribute
OSIsoft.AFAFNamedCollectionAFAttribute
OSIsoft.AFAFNamedCollectionListAFAttribute
OSIsoft.AF.AssetAFAttributeList
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFAttributeList : AFNamedCollectionList<AFAttribute>, ISerializable, IPIPersist
<SerializableAttribute> Public NotInheritable Class AFAttributeList Inherits AFNamedCollectionList(Of AFAttribute) Implements ISerializable, IPIPersist Dim instance As AFAttributeList
[SerializableAttribute] public ref class AFAttributeList sealed : public AFNamedCollectionList<AFAttribute^>, ISerializable, IPIPersist
[<SealedAttribute>] [<SerializableAttribute>] type AFAttributeList = class inherit AFNamedCollectionList<AFAttribute> interface ISerializable interface IPIPersist end
The AFAttributeList type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFAttributeList |
Initializes a new empty instance of the AFAttributeList collection
|
| AFAttributeList(IEnumerableAFAttribute) |
Initializes a new instance of the AFAttributeList collection with
the items in the specified AFAttributes collection.
|
| AFAttributeList(AFObject) |
Initializes a new instance of the AFAttributeList collection
with the specified parent and without any items.
|
| AFAttributeList(IEnumerableString, AFObject) |
Initializes a new instance of the AFAttributeList collection with
the items identified by the path strings.
|
| AFAttributeList(IEnumerableString, AFObject, IDictionaryString, String) |
Initializes a new instance of the AFAttributeList collection with
the items identified by the path strings and returns the list of errors.
|
Properties
| Name | Description | |
|---|---|---|
 | Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) |
| Data |
This read-only property returns the data access object for this AFAttributeList.
|
| Identity |
This read-only property contains identity of the object.
(Inherited from AFCollection.) |
| IsDeleted |
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.) |
| ItemGuid | Returns the item in the collection associated with the passed in ID. (Inherited from AFCollectionT.) |
| ItemInt32 | Returns the item located at the passed in index. (Inherited from AFCollectionT.) |
| ItemString |
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.) |
| ItemIdentity |
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFNamedCollectionListT.) |
| PISystem |
This read-only property allows access to the PISystem
associated with this collection.
(Inherited from AFCollection.) |
Methods
| Name | Description | |
|---|---|---|
| Add(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) |
| Add(IEnumerableString, AFObject) |
Retrieves the AFAttribute objects identified by the path strings and
adds them to the collection.
|
| Add(String, AFObject) |
Retrieves the AFAttribute object identified by the path string and
adds it to the collection.
|
| Add(IEnumerableString, AFObject, IDictionaryString, String) |
Retrieves the AFAttribute objects identified by the path strings and
adds them to the collection and returns the list of errors.
|
| AddRange |
Adds the items of the specified collection to the end of the collection.
(Inherited from AFNamedCollectionListT.) |
| AsReadOnly |
Returns a read-only IList{T} wrapper for the current collection.
(Inherited from AFNamedCollectionListT.) |
| Clear |
Removes all items from the collection.
(Inherited from AFCollectionT.) |
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.) |
| Contains(T) |
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.) |
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.) |
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
(Inherited from AFCollectionT.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.) |
| 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.
(Inherited from AFCollection.) |
| GetPIPoint |
Returns the PIPoint that each AFAttribute in the list represents.
|
| GetRawPIPoint | Obsolete.
Returns the PISDK.PIPoint that each attribute in the list represents.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue |
This method gets the value for each attribute in the list.
|
| GetValue(AFCase) |
This method gets the value for each attribute in the list based upon its data
reference configuration and the specified AFCase context.
|
| GetValue(AFTime) |
This method gets the value for each attribute in the list based upon its data
reference configuration and the specified AFTime context.
|
| GetValue(AFTimeRange) |
This method gets the value for each attribute in the list based upon its data
reference configuration and the specified AFTimeRange context.
|
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
(Inherited from AFCollectionT.) |
| Insert |
Inserts an item into the collection at the specified index.
(Inherited from AFNamedCollectionListT.) |
| Persist |
This method returns the persistence string for the object.
|
| Remove(Guid) |
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.) |
| Remove(T) |
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.) |
| Remove(String) |
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.) |
| RemoveAt |
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.) |
| Sort |
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.) |
| Sort(IComparerT) |
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.) |
| Sort(Int32, Int32, IComparerT) |
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFCollection.) |
Remarks
This collection can be used to contain a list of unrelated attributes.
This feature is useful when gathering the input values of a number of attributes
at one time via the GetValue Overload
methods of this collection.
Examples
See Retrieving Values
for an example of using the AttributeList to retrieve values in bulk.