Description

Create an event array by taking start and/or stop times of every interval in the specified reference interval list and adding them to array.

Syntax

[Visual Basic .NET]
Public Function CreateEventArrayStartStopTimes( _ ByVal Name As String, _ ByVal Description As String _ ) As IAgCrdnEventArray

[Visual Basic .NET]

Public Function CreateEventArrayStartStopTimes( _
   ByVal Name As String, _
   ByVal Description As String _
) As IAgCrdnEventArray

[C#]
public IAgCrdnEventArray CreateEventArrayStartStopTimes( string Name, string Description );

[Managed C++]
public: IAgCrdnEventArray^ CreateEventArrayStartStopTimes( String __gc ^ Name, String __gc ^ Description );

[Managed C++]

public: IAgCrdnEventArray^ CreateEventArrayStartStopTimes(
   String __gc ^ Name, 
   String __gc ^ Description
);

[Java]
public IAgCrdnEventArray createEventArrayStartStopTimes( String Name, String Description );

[Unmanaged C++]
public: HRESULT CreateEventArrayStartStopTimes( BSTR Name, BSTR Description, IAgCrdnEventArray ** ReturnValue );

[Unmanaged C++]

public: HRESULT CreateEventArrayStartStopTimes(
   BSTR Name, 
   BSTR Description, 
   IAgCrdnEventArray ** ReturnValue
);

Parameters

Name
Description

Remarks

Spaces and most punctuation ( except for "-_().") cannot be used as a part of a component name when creating new components via VGT API.

Example

Create and configure start stop times event array.

[C#] Copy Code

IAgCrdnEventArray eventArray = provider.EventArrays.Factory.CreateEventArrayStartStopTimes("MyEventArrayStartStopTimes",  "MyDescription"); 

IAgCrdnEventArrayStartStopTimes asStartStopTimes = eventArray as IAgCrdnEventArrayStartStopTimes; 

 

asStartStopTimes.ReferenceIntervals = provider.EventIntervalLists["LightingIntervals.Sunlight"]; 

asStartStopTimes.StartStopOption = AgECrdnStartStopOption.eCrdnStartStopOptionCountStartOnly; 

 

IAgCrdnFindTimesResult timeArrays = eventArray.FindTimes(); 

if (timeArrays.IsValid) 

{ 

    Console.WriteLine("Times"); 

    int numTimes = timeArrays.Times.GetLength(0); 

    for (int i = 0; i < numTimes; ++i) 

    { 

        Console.WriteLine(timeArrays.Times.GetValue(i)); 

    } 

 

    foreach (IAgCrdnInterval timeArray in timeArrays.Intervals) 

    { 

        Console.WriteLine("Start: " + timeArray.Start); 

        Console.WriteLine("Stop: " + timeArray.Stop); 

    } 

}