com.agi.moxie.stk.utilities

Class StkApplication

java.lang.Object

com.agi.moxie.stk.utilities.StkApplication

All Implemented Interfaces:

AutoCloseable

public class StkApplication
extends Object
implements AutoCloseable

A class representing a running instance of the AgUiApplication and associated operations.

Method Summary

Modifier and Type	Method and Description
static StkApplication	attachToExisting(SimulationLogger simulationLogger) Attach to an already running instance of STK.
void	close() This will close the STK application.
void	closeScenario() Closes the current STK scenario.
static StkApplication	createFromScenario(String scenarioFilePath, boolean isVisible, SimulationLogger simulationLogger) Start and attach to a new instance of the STK application and load the input scenario.
static StkApplication	createFromVdf(String vdfFilePath, boolean isVisible, SimulationLogger simulationLogger) Start and attach to a new instance of the STK application and load the input VDF.
static StkApplication	createNewInstance(String scenarioName, boolean isVisible, SimulationLogger simulationLogger) Start and attach to a new instance of the STK application and load a blank scenario.
static void	deinitializeJni() Statically de-initialize the STK JNI after all operations are complete.
static void	execute(Action action, SimulationLogger simulationLogger) Executes the specified action in STK using the STK Java Native Interface (JNI).
void	forceQuit() This will close and exit the STK application regardless of whether this instance was created as new or attached to an existing instance.
StkScenario	getCurrentScenario()
int	getProcessId()
static String	getStkBinDirectory() Retrieves the STK 12 bin directory from the registry
static void	initializeJni(SimulationLogger simulationLogger) Statically initialize the STK JNI prior to interacting with STK.
void	loadScenario(String scenarioFilePath)
void	newScenario(String name) Creates a new scenario in the STK instance.
static void	setJniLoadDirectory(String stkBinDirectory) Initializes the STK JNI libraries with the path to look for their native components.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initializeJni

public static void initializeJni(SimulationLogger simulationLogger)

Statically initialize the STK JNI prior to interacting with STK. This is something that calling code should execute once and only once in the surrounding context before calling any other methods.

Parameters:

simulationLogger - Used for logging messages to the simulation log and simulation console.

deinitializeJni

public static void deinitializeJni()

Statically de-initialize the STK JNI after all operations are complete. This is recommended as part of the shut-down process of the surrounding application context.

Before calling this method, any AgStkUi instances should be released. StkApplication holds onto an AgStkUi instance, so you should close() all such instances before calling this method.

getStkBinDirectory

public static String getStkBinDirectory()

Retrieves the STK 12 bin directory from the registry

Returns:

The path to the STK 12 Bin directory

setJniLoadDirectory

public static void setJniLoadDirectory(String stkBinDirectory)

Initializes the STK JNI libraries with the path to look for their native components.

This method must be called before you initialize JNI (before calling initializeJni(SimulationLogger)()}). This method should only be called once.

Parameters:

stkBinDirectory - The path to the STK bin directory containing the STK jar files.

createNewInstance

@NotNull
public static StkApplication createNewInstance(String scenarioName,
                                                         boolean isVisible,
                                                         SimulationLogger simulationLogger)

Start and attach to a new instance of the STK application and load a blank scenario.

Before calling this method, you must ensure that JNI has been initialized by calling initializeJni(SimulationLogger) ()}.

Parameters:

scenarioName - The name for the blank scenario.

isVisible - True if the new instance should be visible to the desktop user.

simulationLogger - Used for logging messages to the simulation log and simulation console.

Returns:

The instance of the new live STK.

createFromScenario

@NotNull
public static StkApplication createFromScenario(String scenarioFilePath,
                                                          boolean isVisible,
                                                          SimulationLogger simulationLogger)

Start and attach to a new instance of the STK application and load the input scenario.

Before calling this method, you must ensure that JNI has been initialized by calling initializeJni(SimulationLogger)()}.

Parameters:

scenarioFilePath - The file path to the *.sc file to load into the STK Application on startup.

isVisible - Whether or not to display the scenario.

simulationLogger - Used for logging messages to the simulation log and simulation console.

Returns:

The instance of the new live STK with the input scenario already loaded.

createFromVdf

@NotNull
public static StkApplication createFromVdf(String vdfFilePath,
                                                     boolean isVisible,
                                                     SimulationLogger simulationLogger)

Start and attach to a new instance of the STK application and load the input VDF.

Before calling this method, you must ensure that JNI has been initialized by calling initializeJni(SimulationLogger) ()}.

Parameters:

vdfFilePath - The file path to the *.vdf file to load into the STK Application on startup.

isVisible - Whether or not to display the scenario.

simulationLogger - Used for logging messages to the simulation log and simulation console.

Returns:

The instance of the new live STK with the input VDF already loaded.

attachToExisting

@NotNull
public static StkApplication attachToExisting(SimulationLogger simulationLogger)

Attach to an already running instance of STK. Note that this will attempt to kill any 'zombie' processes of STK that have frozen from previous runs prior to attaching to the correct 'live' instance of STK.

Parameters:

simulationLogger - Used for logging messages to the simulation log and simulation console.

Returns:

The instance of the 'live' STK application.

execute

public static void execute(@NotNull
                           Action action,
                           SimulationLogger simulationLogger)
                    throws StkNotFoundException

Executes the specified action in STK using the STK Java Native Interface (JNI).

Parameters:

action - - The action to perform.

simulationLogger - Used for logging messages to the simulation log and simulation console.

Throws:

StkNotFoundException - Exception thrown when an STK instance cannot be found.

getProcessId

public int getProcessId()

Returns:

The windows process ID for this instance of STK.

getCurrentScenario

public StkScenario getCurrentScenario()

Returns:

The current scenario loaded in STK.

close

public void close()

This will close the STK application. If this instance was created as new, this will close and exit STK. If this instance attached to an existing instance, this will not perform any operations on STK and simply detach this wrapper.

Specified by:

close in interface AutoCloseable

forceQuit

public void forceQuit()

This will close and exit the STK application regardless of whether this instance was created as new or attached to an existing instance.

closeScenario

public void closeScenario()

Closes the current STK scenario.

newScenario

public void newScenario(String name)

Creates a new scenario in the STK instance.

Parameters:

name - The name of the blank scenario to create.

loadScenario

public void loadScenario(String scenarioFilePath)

Parameters:

scenarioFilePath - The path to the file of the *.sc file to load into the STK Application. This will close the current scenario if it exists.