AFLayers Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The collection of AFLayer objects.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFLayer
OSIsoft.AFAFNamedCollectionAFLayer
OSIsoft.AF.ModelingAFLayers
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFLayer
OSIsoft.AFAFNamedCollectionAFLayer
OSIsoft.AF.ModelingAFLayers
Namespace: OSIsoft.AF.Modeling
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFLayers : AFNamedCollection<AFLayer>
Public NotInheritable Class AFLayers Inherits AFNamedCollection(Of AFLayer) Dim instance As AFLayers
public ref class AFLayers sealed : public AFNamedCollection<AFLayer^>
[<SealedAttribute>] type AFLayers = class inherit AFNamedCollection<AFLayer> end
The AFLayers type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) |
| Database |
This read-only property returns the AFDatabase where this object is defined.
|
| 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 AFCollection.) |
| Model |
This property returns the AFModel object which owns the layer collection.
|
| 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(String) |
The Add method creates a new object and adds it to the collection.
|
| 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.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
(Inherited from AFCollectionT.) |
| 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
The collection of AFLayers is maintained by an AFModel object. Each model owns a collection of layers that is unique. Thus, two models can contain a layer with the same name.
To add layers to the collection, use the Add(String) method. An element is placed on a layer when you use one of the AFElements.Add Overload methods from the layer's AFLayer.Elements property.
Examples
// This example demonstrates how to create a layer and add an element to it. // Get the Database PISystems myPISystems = new PISystems(); AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase; // Create an Element AFElement myElement = myDB.Elements.Add("MyElement"); // Create a Model AFElementTemplate modelTempl = myDB.ElementTemplates.Add("ModelTemplate"); modelTempl.InstanceType = typeof(AFModel); AFModel myModel = myDB.Elements.Add("MyModel", modelTempl) as AFModel; myDB.ApplyChanges(); // Add Elements to Model myModel.Elements.Add(myElement); // Create a Layer AFLayer myLayer = myModel.Layers.Add("MyLayer"); // Add an Element to a Layer myLayer.Elements.Add(myElement);
' This example demonstrates how to create a layer and add an element to it. ' Get the Database Dim myPISystems As New PISystems Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase ' Create an Element Dim myElement As AFElement = myDB.Elements.Add("MyElement") ' Create a Model Dim modelTempl As AFElementTemplate = myDB.ElementTemplates.Add("ModelTemplate") modelTempl.InstanceType = GetType(AFModel) Dim myModel As AFModel = CType(myDB.Elements.Add("MyModel", modelTempl), AFModel) myDB.ApplyChanges() ' Add Elements to Model myModel.Elements.Add(myElement) ' Create a Layer Dim myLayer As AFLayer = myModel.Layers.Add("MyLayer") ' Add an Element to a Layer myLayer.Elements.Add(myElement)
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.