Description

Creates an event recorded on a specified clock via signal transmission from an original time instant recorded on different clock.

Syntax

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

[Visual Basic .NET]

Public Function CreateEventSignaled( _
   ByVal Name As String, _
   ByVal Description As String _
) As IAgCrdnEvent

[C#]
public IAgCrdnEvent CreateEventSignaled( string Name, string Description );

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

[Java]
public IAgCrdnEvent createEventSignaled( String Name, String Description );

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

[Unmanaged C++]

public: HRESULT CreateEventSignaled(
   BSTR Name, 
   BSTR Description, 
   IAgCrdnEvent ** 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 signaled event.

[C#] Copy Code

IAgCrdnProvider satelliteVgtProvider = stkRoot.GetObjectFromPath("Satellite/LEO").Vgt; 

IAgCrdnProvider aircraftVgtProvider = stkRoot.GetObjectFromPath("Aircraft/UAV").Vgt; 

 

IAgCrdnEvent timeEvent = satelliteVgtProvider.Events.Factory.CreateEventSignaled("MyEventSignaled", "MyDescription"); 

IAgCrdnEventSignaled asSignaled = timeEvent as IAgCrdnEventSignaled; 

 

asSignaled.OriginalTimeInstant = aircraftVgtProvider.Events["EphemerisStartTime"]; 

asSignaled.BaseClockLocation = satelliteVgtProvider.Points["Center"]; 

asSignaled.TargetClockLocation = aircraftVgtProvider.Points["Center"]; 

 

asSignaled.SignalSense = AgECrdnSignalSense.eCrdnSignalSenseTransmit; 

IAgCrdnSignalDelayBasic basicSignalDelay = asSignaled.SignalDelay as IAgCrdnSignalDelayBasic; 

basicSignalDelay.SpeedOption = AgECrdnSpeedOptions.eCrdnCustomTransmissionSpeed; 

 

// Uses current Time unit preference, this code snippet assumes seconds. 

basicSignalDelay.TimeDelayConvergence = 0.002; 

 

IAgCrdnEventFindOccurrenceResult occurrence = timeEvent.FindOccurrence(); 

if (occurrence.IsValid) 

{ 

    Console.WriteLine("Event occurred at: " + occurrence.Epoch); 

}