Click or drag to resize
OSIsoft, LLC

PIPointSource Class

The PIPointSource object represents a point source on a PIServer.

Inheritance Hierarchy
SystemObject
  OSIsoft.AF.PIPIPointSource

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
public sealed class PIPointSource : IComparable, 
	IComparable<PIPointSource>, IEquatable<PIPointSource>

The PIPointSource type exposes the following members.

Properties
  NameDescription
Public propertyDescription
This property identifies the Description of the PIPointSource.
Public propertyName
This property identifies the name of the PIPointSource.
Public propertyPointCount
The point count associated with the PIPointSource.
Public propertyServer
The PIServer for this PIPointSource.
Top
Methods
  NameDescription
Public methodCompareTo(Object)
Compares this instance with a specified Object.
Public methodCompareTo(PIPointSource)
Compares this instance with a specified PIPointSource.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(PIPointSource)
Indicates whether the current object is equal to another object of the same type.
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.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current object.
(Overrides ObjectToString.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic memberGreaterThan
The greater than relation operator (>) compares its operands to determine which one is greater than the other.
Public operatorStatic memberGreaterThanOrEqual
The greater than or equal relation operator (>=) compares its operands to determine which one is greater than or equal to the other.
Public operatorStatic memberInequality
The inequality operator (!=) compares its operands to determine if they are not equal.
Public operatorStatic memberLessThan
The less than relation operator (<) compares its operands to determine which one is less than the other.
Public operatorStatic memberLessThanOrEqual
The less than or equal relation operator (<=) compares its operands to determine which one is less than or equal to the other.
Top
Remarks
The PIPointSource represents a PointSource Attribute associated with a PIPoint. Each PIPoint belongs to a specific PIPointSource on a PIServer. The total number of points associated with the point source is available in the PointCount property.

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

Examples
// Get the PIPointSources from the PIServer on the local computer
PISystems myPISystems = new PISystems();
PISystem myPISystem = myPISystems.DefaultPISystem;
PIServer myPIServer = PIServer.FindPIServer(myPISystem, piServerName);

// Display information about each PIPointSource and its properties
PIPointSources pointsources = myPIServer.PointSources;
Console.WriteLine("Found {0} pointsources", pointsources.Count);
foreach (PIPointSource pointsource in pointsources)
{
    Console.WriteLine(pointsource.Name);
    Console.WriteLine("  Description: {0}", pointsource.Description);
    Console.WriteLine("  PointCount: {0}", pointsource.PointCount);
    Console.WriteLine();
}
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
See Also
Enabling Operational Intelligence