Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

TABLE OF CONTENTS

AFAttribute Methods

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 10 minute read
AFAttribute Methods

The AFAttribute type exposes the following members.

Methods

  NameDescription
Public method
CompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public method
CompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.)
Public method
Equals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic member
FindAttribute(String, AFObject)
Retrieves the AFAttribute object identified by the path string relative to the specified object.
Public methodStatic member
FindAttribute(AFBaseElement, AFAttributeTemplate)
Retrieves the AFAttribute object created from the specified AFAttributeTemplate.
Public methodStatic member
FindAttribute(AFBaseElement, Guid)
Retrieves the AFAttribute with the specified unique identifier.
Public methodStatic member
FindAttributes
Finds a list of AFAttribute objects identified by the path, relative from the specified object.
Public methodStatic member
FindAttributesByPath(IEnumerableString, AFObject)
Retrieves the AFAttribute objects identified by the path strings as keyed results.
Public methodStatic member
FindAttributesByPath(IEnumerableString, AFObject, IDictionaryString, String)
Retrieves the AFAttribute objects identified by the path strings as a list.
Public methodStatic member
FindCaseAttributes(AFAnalysis, AFSearchMode, Object, Object, String, AFCategory, AFElementTemplate, String, AFCategory, TypeCode, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFCaseAFAttribute objects matching the specified filters.
Public methodStatic member
FindCaseAttributes(AFAnalysis, AFSearchMode, Object, Object, String, String, AFCategory, AFElementTemplate, String, String, AFCategory, TypeCode, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFCaseAFAttribute objects matching the specified filters.
Public methodStatic member
FindElementAttributes(AFDatabase, AFElement, String, AFCategory, AFElementTemplate, AFElementType, String, AFCategory, TypeCode, Boolean, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFElementAFAttribute objects matching the specified filters.
Public methodStatic member
FindElementAttributes(AFDatabase, AFElement, String, AFCategory, AFElementTemplate, AFElementType, String, AFCategory, TypeCode, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32)
Retrieves a paged collection of AFElementAFAttribute objects matching the specified filters.
Public methodStatic member
FindElementAttributes(AFDatabase, AFElement, String, String, AFCategory, AFElementTemplate, AFElementType, String, String, AFCategory, TypeCode, Boolean, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFElementAFAttribute objects matching the specified filters.
Public methodStatic member
FindElementAttributes(AFDatabase, AFElement, String, String, AFCategory, AFElementTemplate, AFElementType, String, String, AFCategory, TypeCode, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32)
Retrieves a paged collection of AFElementAFAttribute objects matching the specified filters.
Public methodStatic member
FindEventFrameAttributes(AFDatabase, AFSearchMode, Object, Object, AFEventFrame, String, String, AFCategory, AFElementTemplate, AFDurationQuery, String, AFCategory, TypeCode, Boolean, AFSortField, AFSortOrder, Int32, Int32)
Retrieves a paged collection of AFEventFrameAFAttribute objects matching the specified filters.
Public methodStatic member
FindEventFrameAttributes(AFDatabase, AFSearchMode, Object, Object, AFEventFrame, String, String, String, AFCategory, AFElementTemplate, AFDurationQuery, String, String, AFCategory, TypeCode, Boolean, AFSortField, AFSortOrder, Int32, Int32)
Retrieves a paged collection of AFEventFrameAFAttribute objects matching the specified filters.
Public methodStatic member
FindNotificationAttributes(AFDatabase, String, AFCategory, AFElementTemplate, String, AFCategory, TypeCode, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFNotificationAFAttribute objects matching the specified filters.
Public methodStatic member
FindNotificationAttributes(AFDatabase, String, String, AFCategory, AFElementTemplate, String, String, AFCategory, TypeCode, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFNotificationAFAttribute objects matching the specified filters.
Public methodStatic member
FindTransferAttributes(AFDatabase, AFSearchMode, Object, Object, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate, String, AFCategory, TypeCode, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFTransferAFAttribute objects matching the specified filters.
Public methodStatic member
FindTransferAttributes(AFDatabase, AFSearchMode, Object, Object, String, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate, String, String, AFCategory, TypeCode, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFTransferAFAttribute objects matching the specified filters.
Public method
GetAttributeByTrait
Retrieves the child AFAttribute with the specified AFAttributeTrait.
Public method
GetAttributesByTrait
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
Public method
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.)
Public method
GetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public method
GetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public method
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.)
Public method
GetPaths
Get all the relative paths to this AFAttribute.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
GetValue
This method gets the value for an attribute based upon the data reference configuration in the units of the DefaultUOM for the attribute.
Public method
GetValue(AFCase)
This method gets the value for an attribute based upon the data reference configuration and the specified AFCase context in the units of the DefaultUOM for the attribute.
Public method
GetValue(AFTime)
This method gets the value for an attribute based upon the data reference configuration and the specified AFTime context in the units of the DefaultUOM for the attribute.
Public method
GetValue(AFTimeRange)
This method gets the value for an attribute based upon the data reference configuration and the specified AFTimeRange context in the units of the DefaultUOM for the attribute.
Public method
GetValue(UOM)
This method gets the value for an attribute based upon the data reference configuration in the specified units-of-measure.
Public method
GetValue(AFCase, UOM)
This method gets the value for an attribute based upon the data reference configuration and the specified AFCase context in the specified units-of-measure.
Public method
GetValue(AFTime, UOM)
This method gets the value for an attribute based upon the data reference configuration and the specified AFTime context in the specified units-of-measure.
Public method
GetValue(AFTimeRange, UOM)
This method gets the value for an attribute based upon the data reference configuration and the specified AFTimeRange context in the specified units-of-measure.
Public method
GetValue(Object, Object, UOM) Obsolete.
This method gets the value for an attribute based upon the data reference configuration and the specified AFCase context in the specified units-of-measure.
Public method
GetValues(AFAnalysis, IListAFCase, UOM)
This method gets a collection of AFValue objects for an attribute in each of the cases.
Public method
GetValues(AFTimeRange, Int32, UOM)
This method gets a collection of AFValue objects for an attribute based upon the data reference configuration within the specified AFTimeRange context.
Public method
GetValues(Object, AFTimeRange, Int32, UOM) Obsolete.
This method gets a collection of AFValue objects for an attribute based upon the data reference configuration within the specified AFTimeRange context.
Public method
IsSupportedDataMethod
Tests if the attribute supports the specified set of AFDataMethods. The result of this method is consistent with the SupportedDataMethods property, but this method allows omission of testing unnecessary modes.
Public method
Persist
This method returns the persistence string for the object.
(Overrides AFObjectPersist.)
Public method
RawPIPointPath
Returns the path to the PIPoint that the attribute represents.
Public method
ResetToTemplate
This method will reset the AFAttribute back to its template default values.
Public methodStatic member
SetConfigStrings
Set the ConfigString values for the specified list of attributes.
Public method
SetValue(AFValue)
This method sets the value for an attribute based upon the data reference configuration using the specified AFValue object.
Public method
SetValue(Object, UOM)
This method sets the value for an attribute based upon the data reference configuration with a default timestamp and the specified unit-of-measure.
Public method
SetValue(AFCase, AFValue)
This method sets the value for an attribute into the result set of the specified caseContext using the specified AFValue object. Values written into the case can be subsequently output to associated data references by invoking AFCase.Publish method.
Public method
SetValue(Object, Object, UOM) Obsolete.
This method sets the value for an attribute based upon the data reference configuration with a default timestamp and the specified unit-of-measure.
Public method
SetValue(AFCase, AFValue, UOM) Obsolete.
This method sets the value for an attribute based into the result set of the specified AFCase context using the specified AFValue object. Values written into the case can be subsequently output to associated data references by invoking AFCase.Publish method.
Public method
SetValue(AFCase, Object, UOM)
This method sets the value for an attribute into the result set of the specified caseContext with a default timestamp and the specified unit-of-measure. Values written into the case can be subsequently output to associated data references by invoking AFCase.Publish method.
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFObject.)

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in