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

AF SDK Reference

AFEventFrames Class

  • Last UpdatedNov 18, 2025
  • 8 minute read
AFEventFrames Class
The collection of AFEventFrame objects.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFCollection
    OSIsoft.AFAFCollectionAFEventFrame
      OSIsoft.AFAFNamedCollectionAFEventFrame
        OSIsoft.AF.EventFrameAFEventFrames

Namespace:  OSIsoft.AF.EventFrame
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public sealed class AFEventFrames : AFNamedCollection<AFEventFrame>
Public NotInheritable Class AFEventFrames
	Inherits AFNamedCollection(Of AFEventFrame)

Dim instance As AFEventFrames
public ref class AFEventFrames sealed : public AFNamedCollection<AFEventFrame^>
[<SealedAttribute>]
type AFEventFrames =  
    class
        inherit AFNamedCollection<AFEventFrame>
    end

The AFEventFrames type exposes the following members.

Properties

  NameDescription
Public property
Count
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.)
Public property
Database
This read-only property returns the AFDatabase where this object is defined.
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFCollection.)
Public property
IsDeleted
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.)
Public property
ItemGuid
Returns the item in the collection associated with the passed in ID.
(Inherited from AFCollectionT.)
Public property
ItemInt32
Returns the item located at the passed in index.
(Inherited from AFCollectionT.)
Public property
ItemString
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.)
Public property
ItemIdentity
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.)
Public property
KeepInMemory
This property allows the collection to keep its items locked in memory.
Public property
Parent
This read-only property returns the parent AFEventFrame which owns this collection.
Public property
PISystem
This read-only property allows access to the PISystem associated with this collection.
(Inherited from AFCollection.)

Methods

  NameDescription
Public method
Add(String)
This method is used to create a new AFEventFrame without specifying a template.
Public method
Add(AFEventFrame)
The Add method adds an existing AFEventFrame to the collection.
Public method
Add(String, AFElementTemplate)
This method is used to create a new AFEventFrame based upon the specified template.
Public method
Add(String, AFReferenceType)
This method is used to create a new AFEventFrame based upon the specified reference type, but without specifying a template.
Public method
Add(AFEventFrame, AFReferenceType)
This method adds an existing AFEventFrame to the collection using the specified reference type.
Public method
Add(String, AFElementTemplate, AFAnalysis)
This method is used to create a new AFEventFrame based upon the specified template.
Public method
Add(String, AFElementTemplate, AFReferenceType)
This method is used to create a new AFEventFrame based upon the specified template and reference type.
Public method
Add(String, AFElementTemplate, AFReferenceType, AFAnalysis)
This method is used to create a new AFEventFrame based upon the specified template and reference type.
Public method
Clear
Removes all items from the collection.
(Inherited from AFCollectionT.)
Public method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.)
Public method
Contains(T)
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.)
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.)
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from AFCollectionT.)
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.)
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 AFCollection.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
(Inherited from AFCollectionT.)
Public method
Refresh
Refresh the collection to make sure it's list of items is up-to-date.
Public method
Remove(Guid)
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(T)
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(String)
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.)
Public method
RemoveAt
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.)
Public method
Sort
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.)
Public method
Sort(IComparerT)
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
Sort(Int32, Int32, IComparerT)
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFCollection.)

Remarks

The AFEventFrame.EventFrames collection is the full list of event frames related to the parent event frame. A new or existing AFEventFrame is added to the hierarchy using one of the Add Overload methods.

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);
}
' This example demonstrates how to create an EventFrame and display its information.

' Get the Database
Dim myPISystems As New PISystems
Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase

' Create an EventFrame
Dim myEventFrame As AFEventFrame = New AFEventFrame(myDB, "MyEventFrame*")
myEventFrame.SetStartTime("T-1w")
myEventFrame.SetEndTime(AFTime.Now)
myEventFrame.Description = "This is my EventFrame"
myEventFrame.CheckIn()

' Search for EventFrames
Dim list As AFNamedCollectionList(Of AFEventFrame) = AFEventFrame.FindEventFrames(myDB, Nothing, AFTime.Now, 0, 200,
                    AFEventFrameSearchMode.BackwardFromStartTime, Nothing, Nothing, Nothing, Nothing, False)

' Display EventFrame Information
For Each CurEventFrame As AFEventFrame 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)
Next

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

Version Information

AFSDK


See Also

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