AFTransfer Class

<SerializableAttribute>
Public NotInheritable Class AFTransfer
	Inherits AFEventFrame
	Implements IComparable(Of AFTransfer)

Dim instance As AFTransfer

[SerializableAttribute]
public ref class AFTransfer sealed : public AFEventFrame, 
	IComparable<AFTransfer^>

[<SealedAttribute>]
[<SerializableAttribute>]
type AFTransfer =  
    class
        inherit AFEventFrame
        interface IComparable<AFTransfer>
    end

' This example will create a transfer (source to destination) and then display its information.

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

' Create an Element Template with Ports
Dim myElemTempl As AFElementTemplate = myDB.ElementTemplates.Add("MyTemplate")
myElemTempl.Ports.Add("OutPort", "An output port", AFPortType.Output, isDefault:=True)
myElemTempl.Ports.Add("InPort", "An input port", AFPortType.Input, isDefault:=True)

' Create source and destination Elements
Dim srcElement As AFElement = myDB.Elements.Add("srcElement", myElemTempl)
Dim destElement As AFElement = myDB.Elements.Add("destElement", myElemTempl)

' Create a Transfer Element Template
Dim myTransTempl As AFElementTemplate = myDB.ElementTemplates.Add("MyTransferTemplate")
myTransTempl.InstanceType = GetType(AFTransfer)

' Create a Transfer.
Dim myTransfer As AFTransfer = myDB.AddTransfer("MyTransfer", myTransTempl)
myTransfer.Description = "This is my transfer."
myTransfer.SetSource(srcElement.DefaultOutputPort)
myTransfer.SetDestination(destElement.DefaultInputPort)
myTransfer.SetStartTime(System.DateTime.UtcNow.AddDays(-0.95))
myTransfer.SetEndTime(System.DateTime.UtcNow.AddDays(-0.9))

' Get the Transfers Collection
Dim Transfers As AFNamedCollectionList(Of AFTransfer) = AFTransfer.FindTransfers(myDB,
    AFSearchMode.Overlapped, System.DateTime.UtcNow.AddDays(-1.05),
    System.DateTime.UtcNow, "", Nothing, Nothing, Nothing, Nothing,
    AFSortField.Name, AFSortOrder.Descending, Int32.MaxValue)

' Display Information on each Transfer.
Console.WriteLine("Number of Transfers = {0}", Transfers.Count)
Dim CurTransfer As AFTransfer
For Each CurTransfer In Transfers
    Console.WriteLine("Transfer Name = {0}", CurTransfer.Name)
    Console.WriteLine("Description = {0}", CurTransfer.Description)
    Console.WriteLine("Source element = {0}", CurTransfer.Source.Name)
    Console.WriteLine("Source port = {0}", CurTransfer.SourcePort.Name)
    Console.WriteLine("Destination element = {0}", CurTransfer.Destination.Name)
    Console.WriteLine("Destination port = {0}", CurTransfer.DestinationPort.Name)
    Console.WriteLine("Start Time = {0}", CurTransfer.StartTime.LocalTime)
    Console.WriteLine("End Time = {0}", CurTransfer.EndTime.LocalTime)
Next CurTransfer

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.