AGI STK Objects 11 Send comments on this topic.
IAgStkObject Interface
Windows






Windows & Linux

Description

Represents the instance of STK object.

Object Model










Public Methods

Public Method CopyObjectCopy and paste the current instance of STK Object. The copied object will be pasted as the sibling of the instance being copied.
Public Method CreateOnePointAccessCreates one point access to the supplied object name. The Remove method in IAgOnePtAccess should be called when you are done with the data.
Public Method ExportExports the object to a file.
Public Method GetAccessReturns an IAgStkAccess object.
Public Method GetAccessToObjectReturns an IAgStkAccess object.
Public Method IsAccessSupportedUsed to determine whether or not the object supports Access.
Public Method IsObjectCoverageSupportedUsed to determine whether or not the object supports ObjectCoverage.
Public Method IsVgtSupportedReturns whether the object supports Vector Geometry.
Public Method UnloadRemoves the object from the scenario.

Public Properties

Public Property AccessConstraintsGet the constraints imposed on the object.
Public Property CentralBodyNameThe object's central body.
Public Property ChildrenReturns a collection of direct descendants of the current object.
Public Property ClassNameReturns a class name of the object (i.e. Aircraft, Facility.)
Public Property ClassTypeReturns a class type of the object (i.e. eAircraft, eFacility etc.)
Public Property DataProvidersReturns the object representing a list of available data providers for the object.
Public Property HasChildrenReturns true if the object has direct descendants.
Public Property InstanceNameA name of the object.
Public Property LongDescriptionA long description of the object.
Public Property MetadataGets the object's metadata. Metadata is a collection of keys and their associated values.
Public Property ObjectCoverageReturns an IAgStkObjectCoverage object.
Public Property ObjectFilesReturns the list of files that constitute an object.
Public Property ParentReturns the parent object or null if the object has become orphaned. The exception is AgStkObjectRoot object which is a topmost element and does not have a parent.
Public Property PathReturns the object path.
Public Property RootReturns the Root object or null.
Public Property ShortDescriptionThe short description of the object.
Public Property VgtReturns an instance of Vector Geometry Tool provider.

Example

Add Metadata To Object
[C#]Copy Code
stkObject.Metadata.Set("key""value"); 
 

Add ReadOnly Metadata To Object
[C#]Copy Code
stkObject.Metadata.Set("key""value"); 
stkObject.Metadata.SetReadOnly("key"true); 
 

Remove Metadata From Object
[C#]Copy Code
stkObject.Metadata.RemoveKey("key"); 
 

Iterate Metadata Keys
[C#]Copy Code
foreach (string key in stkObject.Metadata.Keys) 

    Console.WriteLine("Key: {0}, Value: {1}", key, stkObject.Metadata[key]); 

 

Check If Metadata Is ReadOnly
[C#]Copy Code
if (stkObject.Metadata.GetReadOnly("test")) 

    Console.WriteLine("The test Metadata element is ReadOnly."); 

 

Check If Metadata Contains Key
[C#]Copy Code
if (stkObject.Metadata.Contains("test")) 

    Console.WriteLine("The collection contains the test element."); 

 

Add Metadata To Object
[Visual Basic .NET]Copy Code
stkObject.Metadata.[Set]("key", "value")

Add ReadOnly Metadata To Object
[Visual Basic .NET]Copy Code
stkObject.Metadata.[Set]("key", "value")
stkObject.Metadata.SetReadOnly("key", True)

Remove Metadata From Object
[Visual Basic .NET]Copy Code
stkObject.Metadata.RemoveKey("key")

Iterate Metadata Keys
[Visual Basic .NET]Copy Code
For Each key As String In stkObject.Metadata.Keys
    Console.WriteLine("Key: {0}, Value: {1}", key, stkObject.Metadata(key))
Next

Check If Metadata Is ReadOnly
[Visual Basic .NET]Copy Code
If stkObject.Metadata.GetReadOnly("test") Then
    Console.WriteLine("The test Metadata element is ReadOnly.")
End If

Check If Metadata Contains Key
[Visual Basic .NET]Copy Code
If stkObject.Metadata.Contains("test") Then
    Console.WriteLine("The collection contains the test element.")
End If

Create a New AdvCAT Object
[MATLAB]Copy Code
% IAgScenario scenario: Scenario object 
advCAT = scenario.Children.New('eAdvCAT','AdvCAT'); 
 
 
Create a New AdvCAT Object
[Python]Copy Code
# IAgScenario scenario: Scenario object 
advCAT = scenario.Children.New(0,0) # eAdvCAT, AdvCAT 
 
 

CoClasses that Implement IAgStkObject

© 2018 Analytical Graphics, Inc. All Rights Reserved.