MAK RTIspy API Documentation for HLA 1.3
Public Member Functions
federate.IMakShooterRTI Interface Reference

The Interface IMakShooterRTI. More...

+ Inheritance diagram for federate.IMakShooterRTI:

List of all members.

Public Member Functions

void connect () throws Exception
 Connect.
boolean createFedEx (String federationName, URL url) throws Exception
 Perform Create Federation Execution based on Federation Name and FDD File.
void joinFedEx (String federateName, String federationName) throws Exception
 Perform Join Federation Execution based on Federation Name and FDD File.
void publishShip () throws Exception
 Publish ship.
void publishShot () throws Exception
 Publish shot.
void registerShip () throws Exception
 Register ship.
void registerShots (Queue< Shot > shotsToRegister) throws Exception
 Register shots.
void subscribeShip () throws Exception
 Subscribe to ships.
void subscribeShot () throws Exception
 Subscribe to shots.
void unPublishShip () throws Exception
 Un publish ship.
void unPublishShot () throws Exception
 Un publish shot.
void unRegisterShip () throws Exception
 Un register ship.
void unRegisterShots () throws Exception
 Un register shots.
void evokeCallbacks (double d, double e) throws Exception
 Evoke callbacks.
void updateShipAttributes (Ship ship) throws Exception
 Update ship attributes.
void updateShotAttributes (Shot shot) throws Exception
 Update shot attributes.
E_PlayerIdentity determineMyIdentity () throws Exception
 Determine player identity.
boolean arePlayersAssembled ()
E_PlayerIdentity getMyIdentity ()
void setMyship (Ship ship)
void setEnemyShip (Ship ship)
void sendDetonationInteraction (Ship ship, Shot shot) throws Exception
void setBoard (Board board)
void subscribeDetonation () throws Exception
void publishDetonation () throws Exception
String getDefaultFedFile ()
boolean isConnected ()
void disconnect () throws Exception
void resignFedEx () throws Exception
void destroyFederationEx () throws Exception
void initialize () throws Exception
void requestListFedEx () throws Exception
void registerDialogForListFederation (StartJoinGameDialog configureGameDialog)
void setIdentityObserver ()

Detailed Description

The Interface IMakShooterRTI.


Member Function Documentation

boolean federate.IMakShooterRTI.createFedEx ( String  federationName,
URL  url 
) throws Exception

Perform Create Federation Execution based on Federation Name and FDD File.

Returns:
true, if successful
Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Determine player identity.

Returns:
the e_ player identity
Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Evoke callbacks.

Parameters:
dthe d
ethe e
Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main(), and ui.StartJoinGameDialog.StartJoinGameDialog().

void federate.IMakShooterRTI.joinFedEx ( String  federateName,
String  federationName 
) throws Exception

Perform Join Federation Execution based on Federation Name and FDD File.

Parameters:
federateNamethe federate name
Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Publish ship.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Publish shot.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Register ship.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

void federate.IMakShooterRTI.registerShots ( Queue< Shot shotsToRegister) throws Exception

Register shots.

Parameters:
shotsToRegisterthe shots to register
Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Subscribe to ships.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Subscribe to shots.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Un publish ship.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Un publish shot.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Un register ship.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by federate.RTI1516e.Test.main().

Un register shots.

Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Update ship attributes.

Parameters:
shipthe ship
Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by controllers.KeyboardShipController.moveShip().

Update shot attributes.

Parameters:
shotthe shot
Exceptions:
Exceptionthe exception

Implemented in federate.RTI1516e.MakShooterRTI1516e, and federate.NullMakShooterRTI.

Referenced by controllers.ShotManager.incrementShot(), and controllers.ShotManager.removeShotFromUI().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)