AFPorts Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The collection of AFPort objects is maintained by an
AFElementTemplate.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFPort
OSIsoft.AFAFNamedCollectionAFPort
OSIsoft.AF.ModelingAFPorts
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFPort
OSIsoft.AFAFNamedCollectionAFPort
OSIsoft.AF.ModelingAFPorts
Namespace: OSIsoft.AF.Modeling
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFPorts : AFNamedCollection<AFPort>
Public NotInheritable Class AFPorts Inherits AFNamedCollection(Of AFPort) Dim instance As AFPorts
public ref class AFPorts sealed : public AFNamedCollection<AFPort^>
[<SealedAttribute>] type AFPorts = class inherit AFNamedCollection<AFPort> end
The AFPorts 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.
|
| Element |
This property returns the AFBaseElement object which owns this collection.
|
| ElementTemplate |
This property returns the AFElementTemplate which owns this collection.
|
| 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.) |
| 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.
|
| Add(String, String, AFPortType, Boolean) |
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 ports is used when creating the connections between elements within a model. Therefore, the port must be defined before it can be used to make a connection with one of the AFConnections.Add Overload methods.
Each element template has its own collection of connection ports, which is independent of the ports owned by any other element template.
Examples
// This example demonstrates how to add a port and set its properties. // Get the Database PISystems myPISystems = new PISystems(); AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase; // Create Receipt Truck Template AFElementTemplate RecTruckTempl = myDB.ElementTemplates.Add("MyReceiptTruck"); RecTruckTempl.Description = "Receipt Truck Element Template"; // Create a Port AFPort RecTruckPort = RecTruckTempl.Ports.Add("Rec"); RecTruckPort.Description = "Receipt Port"; RecTruckPort.Type = AFPortType.Output; RecTruckPort.MaxConnections = 5; RecTruckTempl.DefaultOutputPort = RecTruckPort; // Display the name and description of the Port Console.WriteLine("Port Name = {0}", RecTruckPort.Name); Console.WriteLine("Description = {0}", RecTruckPort.Description);
' This example demonstrates how to add a port and set its properties. ' Get the Database Dim myPISystems As New PISystems Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase ' Create Receipt Truck Template Dim RecTruckTempl As AFElementTemplate = myDB.ElementTemplates.Add("MyReceiptTruck") RecTruckTempl.Description = "Receipt Truck Element Template" ' Create a Port Dim RecTruckPort As AFPort = RecTruckTempl.Ports.Add("Rec") RecTruckPort.Description = "Receipt Port" RecTruckPort.Type = AFPortType.Output RecTruckPort.MaxConnections = 5 RecTruckTempl.DefaultOutputPort = RecTruckPort ' Display the name and description of the Port Console.WriteLine("Port Name = {0}", RecTruckPort.Name) Console.WriteLine("Description = {0}", RecTruckPort.Description)
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.