STK X Send comments on this topic.
AgSTKXApplication Object

Description

STK X Application object.

Object Model



Public Methods

Public Method ExecuteCommandSend a connect command to STK X.
Public Method ExecuteMultipleCommandsAllows the batch processing of multiple connect commands.

HRESULT ExecuteMultipleCommands(
[in] SAFEARRAY(VARIANT)* ConnectCommands,
[in] enum AgEExecMultiCmdResultAction eAction,
[out, retval] IAgExecMultiCmdResult** ppResult);

Public Method GetLicensingReportReturns a formatted string that contains the license names and their states. The string is formatted as an XML document.
Public Method GetOnlineOptionsRetrieves http proxy online options.
Public Method IsFeatureAvailableReturns true if the specified feature is available.
Public Method SetOnlineOptionsSets http proxy online options.
Public Method TerminateTerminates the use of STK Engine. This must be the last call to STK Engine.

Public Properties

Public Property ConnectMaxConnectionsSpecifies the maximum number of simultaneous Connect connections to be accepted by STK X. The maximum number of connections is constrained by the Integration Module license.
Public Property ConnectPortSpecify TCP/IP port to be used by Connect (default: 5001).
Public Property EnableConnectEnable or disable TCP/IP connect command processing (default: disabled).
Public Property HostIDReturns the Host ID.
Public Property LogFileFullNameReturns the full path and log file  name (empty if logging is not active).
Public Property LoggingModeSets or retrieves the logging mode (Active, Inactive, ActiveKeepFile).
Public Property NoGraphicsStart engine with or without graphics (default: engine starts with graphics.).
Public Property RegistrationIDReturns the Registration ID.
Public Property ShowSLAIfNotAcceptedShows the Software License Agreement dialog if not already accepted.
Public Property UseHookStart engine with or without message hook setup (default: engine starts with message hook setup.).
Public Property VendorIDThe identifier of the vendor.
Public Property VersionReturns the version number

Events

Public Event OnAnimUpdateOccurs just before an animation update.
Public Event OnBeforeLoadScenarioTriggered immediately before a new scenario is loaded.
Public Event OnBeforeNewScenarioTriggered immediately before a new scenario is created.
Public Event OnBeginScenarioCloseTriggered immediately before the current scenario is closed.
Public Event OnConControlQuitReceivedTriggered when the [ConControl / QuitStk] connect command is received.
Public Event OnLogMessageTriggered when a new message is logged.
Public Event OnNewGfxAnalysisCtrlRequestTriggered when the Gfx Analysis control window for a scene is not found.
Public Event OnNewGlobeCtrlRequestTriggered when the globe control window for a scene is not found or already created.
Public Event OnNewMapCtrlRequestTriggered when the map control window for a scene is not found or already created.
Public Event OnScenarioCloseTriggered when the current scenario is closed.
Public Event OnScenarioLoadTriggered when a scenario is loaded.
Public Event OnScenarioNewTriggered when a new scenario is created.
Public Event OnScenarioSaveTriggered when the current scenario is saved.
Public Event OnSSLCertificateServerErrorTriggered when a remote Web server, in response to an HTTPS request, sends a self-signed certificate, or if the certificate misrepresents the server identify.

Remarks

The STK X Application can be created as a regular component or accessed through the Map and Globe Application properties.

GUID{9C726629-023D-4405-A368-38556E4E2CAD}
ProgIDSTKX11.Application

 

The STK Objects library is also available with STK X. You can instantiate the root object and from it navigate and manipulate the STK scenario. Please see STK Objects for more  details.

See Also

© 2018 Analytical Graphics, Inc. All Rights Reserved.