Click or drag to resize
OSIsoft, LLC

AFEventFrame Class

The AFEventFrame is a class representing objects that frame an event with a StartTime and EndTime.

Inheritance Hierarchy

Namespace:  OSIsoft.AF.EventFrame
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
[SerializableAttribute]
public class AFEventFrame : AFBaseElement, 
	IAFTimePeriod, IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFEventFrame>, 
	IEquatable<AFEventFrame>

The AFEventFrame type exposes the following members.

Constructors
  NameDescription
Public methodAFEventFrame(AFDatabase)
Initializes a new instance of the class with default values.
Public methodAFEventFrame(AFDatabase, String)
Initializes a new instance of the class with the specified name.
Public methodAFEventFrame(AFDatabase, String, AFElementTemplate)
Initializes a new instance of the class with the specified name.
Public methodAFEventFrame(AFDatabase, String, AFElementTemplate, AFAnalysis, Boolean)
Initializes a new instance of the class with the specified name.
Top
Properties
  NameDescription
Public propertyAcknowledgedBy
This property indicates by whom the AFEventFrame was acknowledged.
Public propertyAcknowledgedDate
This property indicates when the AFEventFrame was acknowledged.
Public propertyAnalysis
The AFAnalysis which created this object.
Public propertyAreValuesCaptured
This property indicates whether the AFEventFrame has captured its AFAttribute values.
Public propertyAttributes
This is a collection of attributes that are owned by this element.
(Inherited from AFBaseElement.)
Public propertyCanBeAcknowledged
This property indicates whether the AFEventFrame can be acknowledged.
Public propertyCategories
This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
(Inherited from AFBaseElement.)
Public propertyCategoriesString
This read-only property returns the list of categories in a string separated by semicolons.
(Inherited from AFBaseElement.)
Public propertyCheckOutInfo
This read-only property returns the checked out status information for the object.
Public propertyDatabase
This read-only property returns the AFDatabase where this object is defined.
(Inherited from AFBaseElement.)
Public propertyDefaultAttribute
The default AFAttribute for the AFBaseElement.
(Inherited from AFBaseElement.)
Public propertyDefaultInputPort
The default input AFPort for the AFBaseElement.
(Inherited from AFBaseElement.)
Public propertyDefaultOutputPort
The default output AFPort for the AFBaseElement.
(Inherited from AFBaseElement.)
Public propertyDefaultUndirectedPort
The default undirected AFPort for the AFBaseElement.
(Inherited from AFBaseElement.)
Public propertyDescription
Read/write property that provides a more detailed description of the object.
(Inherited from AFBaseElement.)
Public propertyDuration
This is a read-only property which returns the period's StartTime and EndTime values as a time range.
Public propertyEndTime
This read-only property represents the end time of the period.
Public propertyEventFrames
This is a collection of child event frames that have been added to this event frame.
Public propertyExtendedProperties
A dictionary of extended properties that can be used to store application specific information.
(Inherited from AFBaseElement.)
Public propertyHasChildElements
This read-only property returns if the event frame has child elements.
Public propertyHasChildEventFrames
This read-only property returns if the event frame has child event frames.
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 propertyIsAcknowledged
This property indicates whether the AFEventFrame has been acknowledged.
Public propertyIsAnnotated
This property indicates whether this element has any annotations.
(Inherited from AFBaseElement.)
Public propertyIsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public propertyIsDirty
This read-only property indicates whether the object has been modified since the last save to the PI AF Server.
Public propertyIsLocked
This property indicates whether the AFEventFrame has been locked.
Public propertyIsNew
This read-only property indicates whether the object is new and has never been saved to the PI AF Server.
Public propertyIsRoot
This property indicates if the AFEventFrame is a root object owned by the AFDatabase.
Public propertyIsTemporary
This property indicates whether the AFEventFrame is temporary. A temporary AFEventFrame cannot be saved to the server.
Public propertyName
Read/write property that identifies the name of the object.
(Inherited from AFBaseElement.)
Public propertyParent
This read-only property is returns the parent AFEventFrame that owns the event frame if it is referenced by another event frame.
Public propertyParents
This is a collection of all AFEventFrame objects that reference this event frame.
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.
(Inherited from AFBaseElement.)
Public propertyPrimaryReferencedElement
The primary referenced AFElement associated with the event frame.
Public propertyReferencedElements
This is a collection of elements that are referenced by this event frame.
Public propertySecurity
This read-only property returns the AFSecurity information for the object.
Public propertySeverity
This is the severity level associated with the event.
Public propertyStartTime
This read-only property represents the start time of the period.
Public propertyTemplate
The AFElementTemplate that was used to define this object.
(Inherited from AFBaseElement.)
Public propertyTimeRange
This is a read-only property which returns the period's StartTime and EndTime values as a time range.
Public propertyType
This read-only property specifies the base type of the element.
(Inherited from AFBaseElement.)
Public propertyUniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)
Top
Methods
  NameDescription
Public methodStatic memberAcknowledge(IListAFEventFrame)
Acknowledge all AFEventFrame objects in the collection.
Public methodAcknowledge(String, NullableAFTime)
Acknowledges a single AFEventFrame.
Public methodCode exampleApplyChanges
This method applies the changes to the object and makes those changes available to other objects for the current user.
Public methodCaptureValues
Capture and cache the AFAttribute values with a AFDataReference using the default non-cached data provider.
Public methodCaptureValues(IAFDataProvider)
Capture and cache the AFAttribute values with a AFDataReference using the specified IAFDataProvider.
Public methodChangeReferenceType
Change the existing AFReferenceType between a child event frame.
Public methodCode exampleCheckIn
This method checks in (commits) all the changes to the object by saving the information to persistent storage.
Public methodCheckOut
This method locks the object so that its configuration can be modified.
Public methodStatic memberCheckOutEventFrames
Check out the objects with the specified unique identifiers at the specified query date.
Public methodCompareTo(Object)
Compares this instance with a specified Object.
(Overrides AFObjectCompareTo(Object).)
Public methodCompareTo(AFEventFrame)
Compares this instance with a specified AFEventFrame.
Public methodCompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public methodCreateElementTemplate
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.)
Public methodDelete
Deletes this event frame from the AFDatabase.
Public methodStatic memberCode exampleDeleteEventFrames
Delete the objects with the specified unique identifiers.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides AFObjectEquals(Object).)
Public methodEquals(AFEventFrame)
Indicates whether the current object is equal to another object of the same type.
Public methodEquals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic memberFindEventFrame(PISystem, Guid)
Retrieves the AFEventFrame object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic memberFindEventFrame(PISystem, Guid, Object)
Retrieves the AFEventFrame object with the specified unique identifier at the specified query date.
Public methodStatic memberFindEventFrames(PISystem, Guid, Object)
Performs a search within the PISystem to retrieve a collection of AFEventFrame objects with the specified list of unique identifiers.
Public methodStatic memberFindEventFrames(AFDatabase, AFEventFrame, String, AFSearchField, Boolean, AFSortField, AFSortOrder, Int32, Int32)
Performs a paged text search within the AFDatabase to retrieve a collection of AFEventFrame objects which have a field that matches the specified query string.
Public methodStatic memberFindEventFrames(AFDatabase, AFEventFrame, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFCategory, AFElementTemplate, Boolean) Obsolete.
Retrieves a paged list of AFEventFrame objects limited to the specified count beginning at the requested time in the specified direction that match the specified filtering conditions.
Public methodStatic memberFindEventFrames(AFDatabase, AFEventFrame, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFCategory, AFElementTemplate, AFElementTemplate, Boolean) Obsolete.
Retrieves a paged list of AFEventFrame objects limited to the specified count beginning at the requested time in the specified direction that match the specified filtering conditions including referenced element template filter.
Public methodStatic memberFindEventFrames(AFDatabase, AFEventFrame, AFSearchMode, Object, Object, String, String, AFCategory, AFElementTemplate, AFDurationQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32) Obsolete.
Retrieves a paged list of AFEventFrame objects that match the specified filtering conditions.
Public methodStatic memberFindEventFrames(AFDatabase, AFEventFrame, AFSearchMode, Object, Object, String, String, AFCategory, AFElementTemplate, AFElementTemplate, AFDurationQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32) Obsolete.
Retrieves a paged list of AFEventFrame objects that match the specified filtering conditions including referenced element template filter.
Public methodStatic memberFindEventFramesByAnalysis(AFAnalysis, AFSearchMode, Object, Object, AFSortField, AFSortOrder, Int32, Int32) Obsolete.
Retrieves a paged list of AFEventFrame objects that were created by the specified AFAnalysis that match the specified filtering conditions.
Public methodStatic memberFindEventFramesByAnalysis(AFAnalysis, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFCategory, AFElementTemplate, Boolean) Obsolete.
Retrieves a paged list of AFEventFrame objects that were created by the specified AFAnalysis limited to the specified count beginning at the requested time in the specified direction.
Public methodStatic memberFindEventFramesByAttribute(AFEventFrame, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFDurationQuery, AFAttributeValueQuery, Boolean) Obsolete.
Performs a search on the event frame's information and attribute value within the AFDatabase to retrieve a paged list of AFEventFrame objects limited to the specified count beginning at the requested time in the specified direction.
Public methodStatic memberFindEventFramesByAttribute(AFEventFrame, AFSearchMode, Object, Object, String, String, AFDurationQuery, AFAttributeValueQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32) Obsolete.
Performs a search on the event frame's information and attribute value within the AFDatabase to retrieve a paged collection of AFEventFrame objects.
Public methodStatic memberFindEventFramesByExtendedProperty(AFDatabase, String, IEnumerableGuid, Int32)
Retrieves a list of AFEventFrame objects that have the specified extended property Guid values defined for the event frame.
Public methodStatic memberFindEventFramesByExtendedProperty(AFDatabase, String, IEnumerableString, Int32)
Retrieves a list of AFEventFrame objects that have the specified extended property string values defined for the event frame.
Public methodStatic memberFindEventFramesByPath(IEnumerableString, AFObject)
Retrieves the AFEventFrame objects identified by the path strings as keyed results.
Public methodStatic memberFindEventFramesByPath(IEnumerableString, AFObject, IDictionaryString, String)
Retrieves the AFEventFrame objects identified by the path strings as a list.
Public methodStatic memberFindEventFramesByReferenceType Obsolete.
Retrieves a collection of AFEventFrame objects that are referenced by the AFReferenceType from the specified searchRoot.
Public methodGetAnnotations
Retrieves a collection of existing AFAnnotation objects belonging to this AFBaseElement.
(Inherited from AFBaseElement.)
Public methodGetAttributeByTrait
Retrieves the child AFAttribute with the specified AFAttributeTrait.
(Inherited from AFBaseElement.)
Public methodGetAttributesByTrait
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
(Inherited from AFBaseElement.)
Public methodStatic memberGetAttributeValues
This method gets a collection of AFValue objects for the specified attributes. The collection will be the same length and in the same order as the objectIds collection.
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 AFObjectGetHashCode.)
Public methodGetParents(AFCategory)
Retrieves a collection of AFEventFrame objects that reference this event frame using the specified AFCategory.
Public methodGetParents(AFReferenceType)
Retrieves a collection of AFEventFrame objects that reference this event frame using the specified AFReferenceType.
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 methodGetPaths
Get all the relative paths to this AFEventFrame.
Public methodGetReferenceTypes
Retrieves a collection of all AFReferenceType objects that represent types of references from this event frame to its child event frames.
Public methodGetReferenceTypes(AFEventFrame)
Retrieves a collection of AFReferenceType objects that represent types of references between this event frame and the specified related event frame.
Public methodGetSecurity
Gets the AFSecurity information of the specified security item associated with the object.
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.
(Inherited from AFBaseElement.)
Public methodStatic memberLoadEventFrames(IListAFEventFrame)
Loads the specified list AFEventFrame objects.
Public methodStatic memberLoadEventFrames(PISystem, Guid, Object)
Loads the AFEventFrame objects with the specified unique identifiers at the specified query date.
Public methodStatic memberCode exampleLoadEventFramesToDepth
Loads the specified list AFEventFrame objects and their child event frames to the hierarchical depth specified.
Public methodLock
Locks this event frame so that no further changes can be made.
Public methodPersist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public methodRefresh
Refreshes the client with any changes that have been made to the object since loaded.
Public methodSetEndTime
Set the time that represents the time that the period ended.
Public methodSetStartTime
Set the time that represents the time that the period started.
Public methodToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Public methodUndoCheckOut
This method discards all the changes to the object and all sub-objects since the last call to CheckOut. Any changes since the check out will be lost.
Public methodUnlock
Unlocks a locked event frame so that further changes can be made.
Top
Events
  NameDescription
Public eventCode exampleChanged
Event is raised when the object or one of its sub-objects is changed.
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
Use the PISystem.Supports method to check if the PISystem supports the EventFrame feature. The AFEventFrameSearch class can be used for finding event frames.
Examples
// This example demonstrates how to create an EventFrame and display its information.

// Get the Database
PISystems myPISystems = new PISystems();
AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase;

// Create an EventFrame
AFEventFrame myEventFrame = new AFEventFrame(myDB, "MyEventFrame*");
myEventFrame.SetStartTime("T-1w");
myEventFrame.SetEndTime(AFTime.Now);
myEventFrame.Description = "This is my EventFrame";
myEventFrame.CheckIn();

// Search for EventFrames
AFNamedCollectionList<AFEventFrame> list = AFEventFrame.FindEventFrames(myDB, null, AFTime.Now, 0, 200,
    AFEventFrameSearchMode.BackwardFromStartTime, null, null, null, null, false);

// Display EventFrame Information
foreach (AFEventFrame CurEventFrame in list)
{
    Console.WriteLine("Name of EventFrame = {0}", CurEventFrame.Name);
    Console.WriteLine("StartTime = {0}, EndTime = {1}",
        CurEventFrame.StartTime, CurEventFrame.EndTime);
    Console.WriteLine("Description = {0}", CurEventFrame.Description);
}
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, 2.4
See Also
Enabling Operational Intelligence