Click or drag to resize
OSIsoft, LLC

AFBaseElement Class

The AFBaseElement is a logical grouping of attributes associated with an element, model, transfer, or similar objects.

Inheritance Hierarchy

Namespace:  OSIsoft.AF.Asset
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public abstract class AFBaseElement : AFObject, 

The AFBaseElement type exposes the following members.

Public propertyAttributes
This is a collection of attributes that are owned by this element.
Public propertyCategories
This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
Public propertyCategoriesString
This read-only property returns the list of categories in a string separated by semicolons.
Public propertyDatabase
This read-only property returns the AFDatabase where this object is defined.
Public propertyDefaultAttribute
The default AFAttribute for the AFBaseElement.
Public propertyDefaultInputPort
The default input AFPort for the AFBaseElement.
Public propertyDefaultOutputPort
The default output AFPort for the AFBaseElement.
Public propertyDefaultUndirectedPort
The default undirected AFPort for the AFBaseElement.
Public propertyDescription
Read/write property that provides a more detailed description of the object.
Public propertyExtendedProperties
A dictionary of extended properties that can be used to store application specific information.
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 propertyIsAnnotated
This property indicates whether this element has any annotations.
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 propertyPISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public propertyPorts
This is a collection of AFPort objects representing the possible connection ports for this element. Ports are used in a AFModel to define an AFConnection between AFBaseElement object.
Public propertyTemplate
The AFElementTemplate that was used to define this object.
Public propertyType
This read-only property specifies the base type of the element.
Public propertyUniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)
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 methodCreateElementTemplate
Create an AFElementTemplate based upon the element.
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 methodGetAnnotations
Retrieves a collection of existing AFAnnotation objects belonging to this AFBaseElement.
Public methodGetAttributeByTrait
Retrieves the child AFAttribute with the specified AFAttributeTrait.
Public methodGetAttributesByTrait
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
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 methodIsTypeOf
Checks if the current AFBaseElement is derived from the specified AFElementTemplate.
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.)

An element can be created from a template, or, without a template. When based on a template, the element will derive its initial definition of Categories, Attributes, and Ports from the template. Later modifications to the template will be propagated to all elements created from it. If the template allows it, or, if the element was not created from a template, the element's ports and attributes can be augmented with additional members. When based on a template, the template also defines the DefaultAttribute, DefaultInputPort, DefaultOutputPort, and DefaultUndirectedPort properties.

The following object types are also element: AFElement, AFTransfer, and AFModel. These objects are created with a template which specifies the type of element to create in the AFElementTemplate.InstanceType.

Version Information


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, 2.4
See Also
Enabling Operational Intelligence