gov.nasa.arc.brahms.vm.api
Class JAPI

java.lang.Object
  gov.nasa.arc.brahms.vm.api.JAPI

public class JAPI
extends java.lang.Object

The JAPI class is a class with static members providing access to the VM Controller, the model and the world state.

Version:

$Revision: 1.5 $ $Date: 2008/10/01 02:09:17 $ $Author: rvhoof $

Author:

Ron van Hoof

Constructor Summary

JAPI()

Method Summary

BrahmsClassDescriptor	getBrahmsClassDescriptor(java.lang.String qualifiedName) Returns the BrahmsClassDescriptor for the Brahms class with the specified qualified name.
BrahmsGroupDescriptor	getBrahmsGroupDescriptor(java.lang.String qualifiedName) Returns the BrahmsGroupDescriptor for the Brahms group with the specified qualified name.
static ConverterManager	getConverterManager() Returns the ConverterManager providing access to the helper classes for converting between Brahms and Java values.
static IModel	getModel() Returns a reference to the model loaded in the virtual machine.
static IVMController	getVMController() Returns the virtual machine's controller usable by this agent.
static IWorldState	getWorldState() Returns a reference to the world state managing the fact set.
static void	reset() Resets the JAPI.

Methods inherited from class java.lang.Object

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

Constructor Detail

JAPI

public JAPI()

Method Detail

getVMController

public static final IVMController getVMController()
                                           throws ExternalException

Returns the virtual machine's controller usable by this agent.

Returns:

IVMController the virtual machine's controller

Throws:

ExternalException - if there is a failure obtaining the controller

getModel

public static final IModel getModel()
                             throws ExternalException

Returns a reference to the model loaded in the virtual machine.

Returns:

IModel the model loaded in the virtual machine.

Throws:

ExternalException - is an internal error occurs.

getWorldState

public static final IWorldState getWorldState()
                                       throws ExternalException

Returns a reference to the world state managing the fact set.

Returns:

IWorldState the virtual machine's world state

Throws:

ExternalException - if an internal error occurs.

getConverterManager

public static final ConverterManager getConverterManager()

Returns the ConverterManager providing access to the helper classes for converting between Brahms and Java values.

Returns:

ConverterManager the ConverterManager

getBrahmsClassDescriptor

public BrahmsClassDescriptor getBrahmsClassDescriptor(java.lang.String qualifiedName)

Returns the BrahmsClassDescriptor for the Brahms class with the specified qualified name.

Parameters:

qualifiedName - the class' qualified name

Returns:

BrahmsClassDescriptor the descriptor

getBrahmsGroupDescriptor

public BrahmsGroupDescriptor getBrahmsGroupDescriptor(java.lang.String qualifiedName)

Returns the BrahmsGroupDescriptor for the Brahms group with the specified qualified name.

Parameters:

qualifiedName - the class' qualified name

Returns:

BrahmsGroupDescriptor the descriptor

reset

public static final void reset()

Resets the JAPI.