AFTransfer Properties
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFTransfer type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AcknowledgedBy |
This property indicates by whom the AFEventFrame was acknowledged.
(Inherited from AFEventFrame.) | |
| AcknowledgedDate |
This property indicates when the AFEventFrame was acknowledged.
(Inherited from AFEventFrame.) | |
| Analysis |
The AFAnalysis which created this object.
(Inherited from AFEventFrame.) | |
| AreValuesCaptured |
This property indicates whether the AFEventFrame has captured its
AFAttribute values.
(Inherited from AFEventFrame.) | |
| Attributes |
This is a collection of attributes that are owned by this element.
(Inherited from AFBaseElement.) | |
| CanBeAcknowledged |
This property indicates whether the AFEventFrame can be acknowledged.
(Inherited from AFEventFrame.) | |
| Categories |
This is a user-defined collection of categories for the object that can be used for
querying and/or reporting purposes.
(Inherited from AFBaseElement.) | |
| CategoriesString |
This read-only property returns the list of categories in a string separated by semicolons.
(Inherited from AFBaseElement.) | |
| CheckOutInfo |
This read-only property returns the checked out status information for the object.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
(Inherited from AFBaseElement.) | |
| DefaultAttribute |
The default AFAttribute for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| DefaultInputPort |
The default input AFPort for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| DefaultOutputPort |
The default output AFPort for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| DefaultUndirectedPort |
The default undirected AFPort for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| Description |
Read/write property that provides a more detailed description of the object.
(Inherited from AFBaseElement.) | |
| Destination |
This read-only property returns the element that is the destination of the transfer.
| |
| DestinationPort |
This read-only property returns the port that is the destination of the transfer.
| |
| Duration |
This is a read-only property which returns the period's StartTime and
EndTime values as a time range.
(Inherited from AFEventFrame.) | |
| EndTime |
This read-only property represents the end time of the period.
(Inherited from AFEventFrame.) | |
| EventFrames |
This is a collection of child event frames that have been added to this event frame.
(Inherited from AFEventFrame.) | |
| ExtendedProperties |
A dictionary of extended properties that can be used to store application specific information.
(Inherited from AFBaseElement.) | |
| HasChildElements |
This read-only property returns if the event frame has child elements.
(Inherited from AFEventFrame.) | |
| HasChildEventFrames |
This read-only property returns if the event frame has child event frames.
(Inherited from AFEventFrame.) | |
| ID |
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.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsAcknowledged |
This property indicates whether the AFEventFrame has been acknowledged.
(Inherited from AFEventFrame.) | |
| IsAnnotated |
This property indicates whether this element has any annotations.
(Inherited from AFBaseElement.) | |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDirty |
This read-only property indicates whether the object has been modified since the
last save to the PI AF Server.
| |
| IsLocked |
This property indicates whether the AFEventFrame has been locked.
(Inherited from AFEventFrame.) | |
| IsNew |
This read-only property indicates whether the object is new and has never been saved
to the PI AF Server.
| |
| IsRoot |
This property indicates if the AFEventFrame is a root object owned by
the AFDatabase.
(Inherited from AFEventFrame.) | |
| IsTemporary |
This property indicates whether the AFEventFrame is temporary.
A temporary AFEventFrame cannot be saved to the server.
(Inherited from AFEventFrame.) | |
| Name |
Read/write property that identifies the name of the object.
(Inherited from AFBaseElement.) | |
| Parent |
This read-only property is returns the parent AFEventFrame that owns the event frame if it
is referenced by another event frame.
(Inherited from AFEventFrame.) | |
| Parents |
This is a collection of all AFEventFrame objects that reference this event frame.
(Inherited from AFEventFrame.) | |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| Ports |
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.) | |
| PrimaryReferencedElement |
The primary referenced AFElement associated with the event frame.
(Inherited from AFEventFrame.) | |
| ReferencedElements |
This is a collection of elements that are referenced by this event frame.
(Inherited from AFEventFrame.) | |
| Security |
This read-only property returns the AFSecurity information for the object.
| |
| Severity |
This is the severity level associated with the event.
(Inherited from AFEventFrame.) | |
| Source |
This read-only property returns the element that is the source of the transfer.
| |
| SourcePort |
This read-only property returns the port that is the source of the transfer.
| |
| StartTime |
This read-only property represents the start time of the period.
(Inherited from AFEventFrame.) | |
| Template |
The AFElementTemplate that was used to define this object.
(Inherited from AFBaseElement.) | |
| TimeRange |
This is a read-only property which returns the period's StartTime and
EndTime values as a time range.
(Inherited from AFEventFrame.) | |
| Type |
This read-only property specifies the base type of the element.
(Inherited from AFBaseElement.) | |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |