org.portico.impl.hla13
Class Impl13Helper

java.lang.Object
  org.portico.impl.hla13.Impl13Helper

All Implemented Interfaces:

ISpecHelper

public class Impl13Helper
extends Object
implements ISpecHelper

This class helps provides helper methods to the Default13RTIAmbassador class and helps bridge the gap between the Portico compatibility layer and the HLA 1.3 interface. The basic thrust of this class (like all ISpecHelper implementations) is that it provides the necessary facilities to turn HLA-interface-specific code into Portico-clean, interface independant code.

To maintain the independence of Portico from any particular HLA interface specification, this is one of the *ONLY* classes that is allowed to have classes from the hla.rti namespace in it. All other classes should use the facilities provided by the org.portico.shared.compat package

Field Summary

private hla.rti.FederateAmbassador	fedamb
private LRC	lrc
private LRCState	state

Constructor Summary

Impl13Helper()
Creates a new helper that can be used within the Default13RTIAmbassador.

Method Summary

void	checkAccess() Check to see if we are currently ticking (and thus not able to make an RTI callback).
void	checkAdvancing() Check to see if we are advancing.
void	checkJoined() This method checks to see if the federate associated with this LRC is joined to a federation.
void	checkRestore()
void	checkSave()
void	checkSyncAnnounced(String label) Checks to see if the given synchronization point label has been announced
void	checkTimeConstrained() Check to see if there is a time constrained enable pending.
void	checkTimeRegulation() Check to see if there is a time regulation enable pending.
void	checkValidTime(double time) Validate that the given time is valid for the current state (that it is equal to or greater than the current LBTS for this federate).
hla.rti.FederateAmbassador	getFederateAmbassador()
ObjectModel	getFOM()
LRC	getLRC()
org.apache.log4j.Logger	getLRCLogger()
LRCState	getState()
void	processMessage(com.lbf.commons.messaging.MessageContext context)
void	setFederateAmbassador(hla.rti.FederateAmbassador fedamb)
void	tick()
void	tick(double min, double max)

Methods inherited from class java.lang.Object

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

Field Detail

lrc

private LRC lrc

state

private LRCState state

fedamb

private hla.rti.FederateAmbassador fedamb

Constructor Detail

Impl13Helper

public Impl13Helper()
             throws hla.rti.RTIinternalError

Creates a new helper that can be used within the Default13RTIAmbassador. This constructor in turn creates an instance of the LRC so that it can pass on messages once any appropriate transformation has taken place.

Throws:

hla.rti.RTIinternalError

Method Detail

processMessage

public void processMessage(com.lbf.commons.messaging.MessageContext context)
                    throws Exception

Throws:

Exception

getState

public LRCState getState()

getFOM

public ObjectModel getFOM()

tick

public void tick()
          throws hla.rti.ConcurrentAccessAttempted,
                 hla.rti.RTIinternalError

Throws:

hla.rti.ConcurrentAccessAttempted

hla.rti.RTIinternalError

tick

public void tick(double min,
                 double max)
          throws hla.rti.ConcurrentAccessAttempted,
                 hla.rti.RTIinternalError

Throws:

hla.rti.ConcurrentAccessAttempted

hla.rti.RTIinternalError

checkAccess

public void checkAccess()
                 throws hla.rti.ConcurrentAccessAttempted

Check to see if we are currently ticking (and thus not able to make an RTI callback). If we are currently ticking, a ConcurrentAccessAttempted will be thrown.

Throws:

hla.rti.ConcurrentAccessAttempted

checkAdvancing

public void checkAdvancing()
                    throws hla.rti.TimeAdvanceAlreadyInProgress

Check to see if we are advancing. If we are, throw an exception.

Throws:

hla.rti.TimeAdvanceAlreadyInProgress

checkTimeRegulation

public void checkTimeRegulation()
                         throws hla.rti.EnableTimeRegulationPending

Check to see if there is a time regulation enable pending. If there is, throw an exception

Throws:

hla.rti.EnableTimeRegulationPending

checkTimeConstrained

public void checkTimeConstrained()
                          throws hla.rti.EnableTimeConstrainedPending

Check to see if there is a time constrained enable pending. If there is, throw an exception

Throws:

hla.rti.EnableTimeConstrainedPending

checkValidTime

public void checkValidTime(double time)
                    throws hla.rti.InvalidFederationTime

Validate that the given time is valid for the current state (that it is equal to or greater than the current LBTS for this federate).

Throws:

hla.rti.InvalidFederationTime

checkSave

public void checkSave()
               throws hla.rti.SaveInProgress

Throws:

hla.rti.SaveInProgress

checkRestore

public void checkRestore()
                  throws hla.rti.RestoreInProgress

Throws:

hla.rti.RestoreInProgress

checkJoined

public void checkJoined()
                 throws hla.rti.FederateNotExecutionMember

This method checks to see if the federate associated with this LRC is joined to a federation. If it is not, a FederateNotExecutionMember exception is thrown.

Throws:

hla.rti.FederateNotExecutionMember

checkSyncAnnounced

public void checkSyncAnnounced(String label)
                        throws hla.rti.SynchronizationLabelNotAnnounced

Checks to see if the given synchronization point label has been announced

Throws:

hla.rti.SynchronizationLabelNotAnnounced

getFederateAmbassador

public hla.rti.FederateAmbassador getFederateAmbassador()

setFederateAmbassador

public void setFederateAmbassador(hla.rti.FederateAmbassador fedamb)

getLRC

public LRC getLRC()

getLRCLogger

public org.apache.log4j.Logger getLRCLogger()