MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
simpleTime13.SimpleTime13 Class Reference
+ Inheritance diagram for simpleTime13.SimpleTime13:
+ Collaboration diagram for simpleTime13.SimpleTime13:

Public Member Functions

 SimpleTime13 ()
boolean parseCmdLine (String[] args)
 This will parse CommandLine Arguments.
void performExit ()
 This should perform actions to close the program (stop threads, disconnect, resign, exit(0), etc)
void performFire ()
void start (String[] args) throws RTIinternalError, ConcurrentAccessAttempted, IllegalTimeArithmetic, ArrayIndexOutOfBounds, ObjectNotKnown, AttributeNotDefined, AttributeNotOwned, FederateNotExecutionMember, SaveInProgress, RestoreInProgress, InteractionClassNotDefined, InteractionClassNotPublished, InteractionParameterNotDefined, TimeRegulationWasNotEnabled, FederateOwnsAttributes, InvalidResignAction, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
 This is the entry point for the main of each SimpleTime Implementation.
void usage ()
 This prints to Standard out the usage (command line arguments you pass in and what they do)
String version ()

Static Public Member Functions

static void main (String[] args) throws Exception

Private Member Functions

void becomeConstrainedAndRegulating (RTIambassador rtiAmb, LogicalTime currentTime, LogicalTimeInterval lookAhead) throws FederateOwnsAttributes, FederateNotExecutionMember, InvalidResignAction, RTIinternalError, ConcurrentAccessAttempted, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
void cleanUpProgram (RTIambassador rtiAmb) throws FederateOwnsAttributes, FederateNotExecutionMember, InvalidResignAction, RTIinternalError, ConcurrentAccessAttempted, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
void createFedEx (RTIambassador rtiAmb, String federationName, String fedFileName)
String getHostname () throws UnknownHostException
void exit ()
int getIdentifier ()
void joinFedEx (RTIambassador rtiAmb, SimpleTimeFedAmb13 fedAmb, String federateType)
void minimalSleepFunction ()
void printOutFedTime (LogicalTime time) throws NullPointerException
void printOutFedTime (LogicalTimeInterval time)
boolean publishAndSubscribeInteraction (RTIambassador rtiAmb)
boolean publishSubscribeAndRegisterObject (RTIambassador rtiAmb)
void resignAndDestroy (RTIambassador rtiAmb) throws FederateOwnsAttributes, FederateNotExecutionMember, InvalidResignAction, RTIinternalError, ConcurrentAccessAttempted, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
void sleepFunction ()
void synchronizeFederation (RTIambassador rtiAmb) throws RTIinternalError, ConcurrentAccessAttempted, FederateNotExecutionMember, SaveInProgress, RestoreInProgress, FederateOwnsAttributes, InvalidResignAction, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
void isExiting (RTIambassador rtiAmb)
void yieldFunction ()

Private Attributes

LogicalTime currentRTITime
LogicalTime currentTime
boolean dedicatedMachine = false
Integer detonateInteractionHandle
String detonateInteractionName = "MunitionDetonation"
String federationName = "MAKsimpletime"
String fedFileName = "MAKsimpletime.fed"
Integer fireInteractionHandle
String fireInteractionName = "WeaponFire"
String initSyncPointLabel = "begin"
SimpleTimeKeyboard mySimpleTimeKeyboard
Integer phaseLine
int sleepTime = 850
SimpleTimeFedAmb13Data theAmbData
Integer theClassHandle
String theClassName = "BaseEntity"
Integer theObjectHandle
boolean unManagedFederate = false
boolean exit = false
RtiFactory myFactory

Static Private Attributes

static final String VERSION = "SIMPLE_TIME_HLA13"

Constructor & Destructor Documentation

simpleTime13.SimpleTime13.SimpleTime13 ( )
inline

Member Function Documentation

void simpleTime13.SimpleTime13.becomeConstrainedAndRegulating ( RTIambassador  rtiAmb,
LogicalTime  currentTime,
LogicalTimeInterval  lookAhead 
) throws FederateOwnsAttributes, FederateNotExecutionMember, InvalidResignAction, RTIinternalError, ConcurrentAccessAttempted, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
inlineprivate
void simpleTime13.SimpleTime13.cleanUpProgram ( RTIambassador  rtiAmb) throws FederateOwnsAttributes, FederateNotExecutionMember, InvalidResignAction, RTIinternalError, ConcurrentAccessAttempted, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
inlineprivate
void simpleTime13.SimpleTime13.createFedEx ( RTIambassador  rtiAmb,
String  federationName,
String  fedFileName 
)
inlineprivate
void simpleTime13.SimpleTime13.exit ( )
inlineprivate
String simpleTime13.SimpleTime13.getHostname ( ) throws UnknownHostException
inlineprivate
int simpleTime13.SimpleTime13.getIdentifier ( )
inlineprivate
void simpleTime13.SimpleTime13.isExiting ( RTIambassador  rtiAmb)
inlineprivate
void simpleTime13.SimpleTime13.joinFedEx ( RTIambassador  rtiAmb,
SimpleTimeFedAmb13  fedAmb,
String  federateType 
)
inlineprivate
static void simpleTime13.SimpleTime13.main ( String[]  args) throws Exception
inlinestatic
void simpleTime13.SimpleTime13.minimalSleepFunction ( )
inlineprivate
boolean simpleTime13.SimpleTime13.parseCmdLine ( String[]  args)
inline
void simpleTime13.SimpleTime13.performExit ( )
inlinevirtual

This should perform actions to close the program (stop threads, disconnect, resign, exit(0), etc)

Implements common.ISimpleTime.

References simpleTime13.SimpleTime13.exit().

Referenced by simpleTime13.SimpleTime13.cleanUpProgram(), simpleTime13.SimpleTime13.createFedEx(), simpleTime13.SimpleTime13.joinFedEx(), and simpleTime13.SimpleTime13.start().

void simpleTime13.SimpleTime13.performFire ( )
inline
void simpleTime13.SimpleTime13.printOutFedTime ( LogicalTime  time) throws NullPointerException
inlineprivate
void simpleTime13.SimpleTime13.printOutFedTime ( LogicalTimeInterval  time)
inlineprivate

References toString().

boolean simpleTime13.SimpleTime13.publishAndSubscribeInteraction ( RTIambassador  rtiAmb)
inlineprivate
boolean simpleTime13.SimpleTime13.publishSubscribeAndRegisterObject ( RTIambassador  rtiAmb)
inlineprivate
void simpleTime13.SimpleTime13.resignAndDestroy ( RTIambassador  rtiAmb) throws FederateOwnsAttributes, FederateNotExecutionMember, InvalidResignAction, RTIinternalError, ConcurrentAccessAttempted, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
inlineprivate
void simpleTime13.SimpleTime13.sleepFunction ( )
inlineprivate
void simpleTime13.SimpleTime13.start ( String[]  args) throws RTIinternalError, ConcurrentAccessAttempted, IllegalTimeArithmetic, ArrayIndexOutOfBounds, ObjectNotKnown, AttributeNotDefined, AttributeNotOwned, FederateNotExecutionMember, SaveInProgress, RestoreInProgress, InteractionClassNotDefined, InteractionClassNotPublished, InteractionParameterNotDefined, TimeRegulationWasNotEnabled, FederateOwnsAttributes, InvalidResignAction, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
inline

This is the entry point for the main of each SimpleTime Implementation.

Parameters
args

Implements common.ISimpleTime.

References simpleTime13.SimpleTime13.becomeConstrainedAndRegulating(), simpleTime13.SimpleTime13.cleanUpProgram(), simpleTime13.SimpleTime13.createFedEx(), simpleTime13.SimpleTime13.currentRTITime, simpleTime13.SimpleTime13.currentTime, simpleTime13.SimpleTime13.detonateInteractionHandle, simpleTime13.SimpleTime13.exit(), simpleTime13.SimpleTime13.federationName, simpleTime13.SimpleTime13.fedFileName, simpleTime13.SimpleTime13.fireInteractionHandle, simpleTime13.SimpleTimeFedAmb13Data.getAttrValues(), simpleTime13.SimpleTimeFedAmb13Data.getParamValues(), simpleTime13.SimpleTimeFedAmb13Data.getTheParamNameHandleMap(), simpleTime13.SimpleTimeFedAmb13Data.getTimeManagedObject(), simpleTime13.SimpleTime13.isExiting(), simpleTime13.SimpleTimeFedAmb13Data.isRegulating, simpleTime13.SimpleTimeFedAmb13Data.isTimeAdvanced(), simpleTime13.SimpleTime13.joinFedEx(), simpleTime13.SimpleTime13.myFactory, simpleTime13.SimpleTime13.mySimpleTimeKeyboard, simpleTime13.SimpleTime13.parseCmdLine(), simpleTime13.SimpleTime13.performExit(), simpleTime13.SimpleTime13.printOutFedTime(), simpleTime13.SimpleTime13.publishAndSubscribeInteraction(), simpleTime13.SimpleTime13.publishSubscribeAndRegisterObject(), simpleTime13.SimpleTime13.resignAndDestroy(), RTIambassador(), simpleTime13.SimpleTimeFedAmb13Data.setTimeAdvanced(), simpleTime13.SimpleTime13.sleepFunction(), common.SimpleTimeKeyboard.startKeyboardScanner(), common.SimpleTimeKeyboard.stopKeyboardScanner(), simpleTime13.SimpleTime13.synchronizeFederation(), simpleTime13.SimpleTime13.theAmbData, simpleTime13.SimpleTime13.theObjectHandle, simpleTime13.SimpleTime13.unManagedFederate, and simpleTime13.SimpleTime13.yieldFunction().

Referenced by simpleTime13.SimpleTime13.main().

void simpleTime13.SimpleTime13.synchronizeFederation ( RTIambassador  rtiAmb) throws RTIinternalError, ConcurrentAccessAttempted, FederateNotExecutionMember, SaveInProgress, RestoreInProgress, FederateOwnsAttributes, InvalidResignAction, FederatesCurrentlyJoined, FederationExecutionDoesNotExist
inlineprivate
void simpleTime13.SimpleTime13.usage ( )
inline

This prints to Standard out the usage (command line arguments you pass in and what they do)

Implements common.ISimpleTime.

Referenced by simpleTime13.SimpleTime13.parseCmdLine().

String simpleTime13.SimpleTime13.version ( )
inline
void simpleTime13.SimpleTime13.yieldFunction ( )
inlineprivate

Member Data Documentation

LogicalTime simpleTime13.SimpleTime13.currentRTITime
private
LogicalTime simpleTime13.SimpleTime13.currentTime
private
boolean simpleTime13.SimpleTime13.dedicatedMachine = false
private
Integer simpleTime13.SimpleTime13.detonateInteractionHandle
private
String simpleTime13.SimpleTime13.detonateInteractionName = "MunitionDetonation"
private
boolean simpleTime13.SimpleTime13.exit = false
private
String simpleTime13.SimpleTime13.federationName = "MAKsimpletime"
private
String simpleTime13.SimpleTime13.fedFileName = "MAKsimpletime.fed"
private
Integer simpleTime13.SimpleTime13.fireInteractionHandle
private
String simpleTime13.SimpleTime13.fireInteractionName = "WeaponFire"
private
String simpleTime13.SimpleTime13.initSyncPointLabel = "begin"
private
RtiFactory simpleTime13.SimpleTime13.myFactory
private
SimpleTimeKeyboard simpleTime13.SimpleTime13.mySimpleTimeKeyboard
private
Integer simpleTime13.SimpleTime13.phaseLine
private
int simpleTime13.SimpleTime13.sleepTime = 850
private
SimpleTimeFedAmb13Data simpleTime13.SimpleTime13.theAmbData
private
Integer simpleTime13.SimpleTime13.theClassHandle
private
String simpleTime13.SimpleTime13.theClassName = "BaseEntity"
private
Integer simpleTime13.SimpleTime13.theObjectHandle
private
boolean simpleTime13.SimpleTime13.unManagedFederate = false
private
final String simpleTime13.SimpleTime13.VERSION = "SIMPLE_TIME_HLA13"
staticprivate

The documentation for this class was generated from the following file:

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)