PICollectiveMember Class
- Last UpdatedNov 18, 2025
- 8 minute read
- PI System
- AF SDK 2024 R2
- Developer
The PICollectiveMember object is used to provide the
information about the member server defined within the
PICollective.
Inheritance Hierarchy
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class PICollectiveMember : AFObject, IComparable<PICollectiveMember>, IEquatable<PICollectiveMember>
<SerializableAttribute> Public NotInheritable Class PICollectiveMember Inherits AFObject Implements IComparable(Of PICollectiveMember), IEquatable(Of PICollectiveMember) Dim instance As PICollectiveMember
[SerializableAttribute] public ref class PICollectiveMember sealed : public AFObject, IComparable<PICollectiveMember^>, IEquatable<PICollectiveMember^>
[<SealedAttribute>] [<SerializableAttribute>] type PICollectiveMember = class inherit AFObject interface IComparable<PICollectiveMember> interface IEquatable<PICollectiveMember> end
The PICollectiveMember type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Collective |
The PICollective that owns the collective member.
|
| ConnectionTimeOut |
The property that is the timeout used to connect to the PICollectiveMember
on the remote host.
|
| Description |
Read/write property that provides a more detailed description of the object.
|
| Host |
This property is the name of the host machine where the PIServer
for this PICollectiveMember is executing.
|
| 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.
(Inherited from AFObject.) |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) |
| IsConnected |
Indicates if the collective member is being used as the connection to the PIServer.
|
| IsConnectedToPrimary |
Indicates if the client is connected to the primary server within the collective.
|
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) |
| Name |
Read/write property that identifies the name of the object.
|
| OperationTimeOut |
This property that is the timeout used to perform operations on the PICollectiveMember.
|
| PIServer |
This read-only property allows access to the PIServer associated with this
object.
|
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) |
| Port |
This property is the port number used to connect to the PIServer
for this PICollectiveMember on the remote host.
|
| Priority |
Indicates the priority order in which to select a collective member.
|
| ServerRole |
The role of the collective member server within the PICollective.
|
| ServerVersion |
Read-only property that contains a string that uniquely identifies the current
server version.
|
| UniqueID |
Read-only property that provides the collective member's unique identifier as a String.
(Overrides AFObjectUniqueID.) |
Methods
| Name | Description | |
|---|---|---|
 | CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
 | Connect |
Directly connects to the specific server within the PICollective using default credentials
to allow sending and retrieving data.
|
| Connect(NetworkCredential) |
Directly connects to the specific server within the PICollective using the specified
PI User credentials to allow sending and retrieving data.
|
| Connect(String) |
Directly connects to the specific server within the PICollective using the specified
credentials to allow sending and retrieving data.
|
| Connect(Boolean, IWin32Window) |
Directly connects to the specific server within the PICollective with a credential prompt
if necessary to allow sending and retrieving data.
|
| Connect(NetworkCredential, PIAuthenticationMode) |
Directly connects to the specific server within the PICollective using the specified
credentials to allow sending and retrieving data.
|
| Connect(String, String) |
Directly connects to the specific server within the PICollective using the specified
credentials to allow sending and retrieving data.
|
| Connect(Boolean, IWin32Window, Boolean) |
Directly connects to the specific server within the PICollective with a credential prompt
if necessary to allow sending and retrieving data.
|
| ConnectDirect |
Creates an independent direct connection to the specific server of the PICollective using
default credentials to allow sending and retrieving data for multiple collective members.
|
| ConnectDirect(NetworkCredential) |
Creates an independent direct connection to the specific server of the PICollective using
the specified PI User credentials to allow sending and retrieving data for multiple collective members.
|
| ConnectDirect(Boolean, IWin32Window) |
Creates an independent direct connection to the specific server of the PICollective with a
credential prompt if necessary to allow sending and retrieving data for multiple collective members.
|
| ConnectDirect(NetworkCredential, PIAuthenticationMode) |
Creates an independent direct connection to the specific server of the PICollective using
the specified credentials to allow sending and retrieving data for multiple collective members.
|
| ConnectDirect(Boolean, IWin32Window, Boolean) |
Creates an independent direct connection to the specific server of the PICollective with a
credential prompt if necessary to allow sending and retrieving data for multiple collective members.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| Equals(PICollectiveMember) |
Indicates whether the current object is equal to another object of the same type.
|
| GetBufferStatus |
This method gets the PIBufferStatus for the corresponding PICollectiveMember.
|
| 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 AFObject.) |
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) |
| GetPath(AFEncodeType, AFObject) |
Returns the path to the object relative from another object,
using the name and/or id as specified
by encodeType.
(Inherited from AFObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
Remarks
This class provides information about the member server defined with the
PICollective. This object is used to check status and change
configuration options, but it is not a replacement for a PIServer
object used to communicate with a PIServer. A PIServer
representing the PICollective and connected to one of the
collective members can be obtained from the PIServers collection.
 Notes to Callers |
|---|
| This method, property, or class is not available in the legacy .NET 3.5 version of the SDK. |