Description

Represents the instance of STK object.

Public Methods

CopyObject	Copy and paste the current instance of STK Object. The copied object will be pasted as the sibling of the instance being copied.
CreateOnePointAccess	Creates one point access to the supplied object name. The Remove method in IAgOnePtAccess should be called when you are done with the data.
Export	Exports the object to a file.
GetAccess	Returns an IAgStkAccess object associated with this STK object and another STK object specified using its path. The path can be fully-qualified or truncated. See remarks section for more info.
GetAccessToObject	Returns an IAgStkAccess object associated with this STK object and another STK object. See remarks section for more info.
IsAccessSupported	Determine whether or not the object supports Access.
IsObjectCoverageSupported	Determine whether or not the object supports ObjectCoverage.
IsVgtSupported	Returns whether the object supports Vector Geometry.
Unload	Removes the object from the scenario.

AccessConstraints	Get the constraints imposed on the object.
CentralBodyName	The object's central body.
Children	Returns a collection of direct descendants of the current object.
ClassName	Returns a class name of the object (i.e. Aircraft, Facility.).
ClassType	Returns a class type of the object (i.e. eAircraft, eFacility etc.).
DataProviders	Returns the object representing a list of available data providers for the object.
HasChildren	Returns true if the object has direct descendants.
InstanceName	A name of the object.
LongDescription	A long description of the object.
Metadata	Gets the object's metadata. Metadata is a collection of keys and their associated values.
ObjectCoverage	Returns an IAgStkObjectCoverage object.
ObjectFiles	Returns the list of files that constitute an object.
Parent	Returns 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.
Path	Returns the object path.
Root	Returns the Root object or null.
ShortDescription	The short description of the object.
Vgt	Returns an instance of Vector Geometry Tool provider.

Implemented Interface
IAgLifetimeInformation

Add Metadata To Object

[C#]

stkObject.Metadata.Set("key", "value");

Add ReadOnly Metadata To Object

[C#]

stkObject.Metadata.Set("key", "value");
stkObject.Metadata.SetReadOnly("key", true);

Remove Metadata From Object

[C#]

stkObject.Metadata.RemoveKey("key");

Iterate Metadata Keys

[C#]

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

Check If Metadata Is ReadOnly

[C#]

if (stkObject.Metadata.GetReadOnly("test"))
{
    Console.WriteLine("The test Metadata element is ReadOnly.");
}

Check If Metadata Contains Key

[C#]

if (stkObject.Metadata.Contains("test"))
{
    Console.WriteLine("The collection contains the test element.");
}

Add Metadata To Object

[Visual Basic .NET]

stkObject.Metadata.[Set]("key", "value")

Add ReadOnly Metadata To Object

[Visual Basic .NET]

stkObject.Metadata.[Set]("key", "value")
stkObject.Metadata.SetReadOnly("key", True)

Remove Metadata From Object

[Visual Basic .NET]

stkObject.Metadata.RemoveKey("key")

Iterate Metadata Keys

[Visual Basic .NET]

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]

If stkObject.Metadata.GetReadOnly("test") Then
	Console.WriteLine("The test Metadata element is ReadOnly.")
End If

Check If Metadata Contains Key

[Visual Basic .NET]

If stkObject.Metadata.Contains("test") Then
	Console.WriteLine("The collection contains the test element.")
End If

Create a New AdvCAT Object

[Python - STK API]

# IAgScenario scenario: Scenario object
advCAT = scenario.Children.New(AgESTKObjectType.eAdvCat, 'MyAdvCAT')

Create a New AdvCAT Object

[MATLAB]

% IAgScenario scenario: Scenario object
advCAT = scenario.Children.New('eAdvCAT', 'AdvCAT');

STK Objects	Send comments on this topic.
IAgStkObject Interface