Click or drag to resize
OSIsoft, LLC

PICollectiveMember Class

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: 2.10.6.195
Syntax
[SerializableAttribute]
public sealed class PICollectiveMember : AFObject, 
	IComparable<PICollectiveMember>, IEquatable<PICollectiveMember>

The PICollectiveMember type exposes the following members.

Properties
  NameDescription
Public propertyCollective
The PICollective that owns the collective member.
Public propertyConnectionTimeOut
The property that is the timeout used to connect to the PICollectiveMember on the remote host.
Public propertyDescription
Read/write property that provides a more detailed description of the object.
Public propertyHost
This property is the name of the host machine where the PIServer for this PICollectiveMember is executing.
Public propertyID
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.)
Public propertyIdentity
This read-only property contains identity of the object.
(Inherited from AFObject.)
Public propertyIsConnected
Indicates if the collective member is being used as the connection to the PIServer.
Public propertyIsConnectedToPrimary
Indicates if the client is connected to the primary server within the collective.
Public propertyIsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public propertyName
Read/write property that identifies the name of the object.
Public propertyOperationTimeOut
This property that is the timeout used to perform operations on the PICollectiveMember.
Public propertyPIServer
This read-only property allows access to the PIServer associated with this object.
Public propertyPISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public propertyPort
This property is the port number used to connect to the PIServer for this PICollectiveMember on the remote host.
Public propertyPriority
Indicates the priority order in which to select a collective member.
Public propertyServerRole
The role of the collective member server within the PICollective.
Public propertyServerVersion
Read-only property that contains a string that uniquely identifies the current server version.
Public propertyUniqueID
Read-only property that provides the collective member's unique identifier as a String.
(Overrides AFObjectUniqueID.)
Top
Methods
  NameDescription
Public methodCompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public methodCompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public methodCode exampleConnect
Directly connects to the specific server within the PICollective using default credentials to allow sending and retrieving data.
Public methodCode exampleConnect(NetworkCredential)
Directly connects to the specific server within the PICollective using the specified PI User credentials to allow sending and retrieving data.
Public methodCode exampleConnect(Boolean, IWin32Window)
Directly connects to the specific server within the PICollective with a credential prompt if necessary to allow sending and retrieving data.
Public methodCode exampleConnect(NetworkCredential, PIAuthenticationMode)
Directly connects to the specific server within the PICollective using the specified credentials to allow sending and retrieving data.
Public methodCode exampleConnectDirect
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.
Public methodCode exampleConnectDirect(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.
Public methodCode exampleConnectDirect(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.
Public methodCode exampleConnectDirect(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.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.)
Public methodEquals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodEquals(PICollectiveMember)
Indicates whether the current object is equal to another object of the same type.
Public methodGetBufferStatus
This method gets the PIBufferStatus for the corresponding PICollectiveMember.
Public methodGetHashCode
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.)
Public methodGetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public methodGetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public methodGetPath(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.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodPersist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public methodToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Top
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.

Note Notes to Callers
This method, property, or class is only available in the .NET 4 version of the SDK.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence