MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
federate.IMakShooterRTI Interface Reference

The Interface IMakShooterRTI. More...

+ Inheritance diagram for federate.IMakShooterRTI:

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.arePlayersAssembled ( )
void federate.IMakShooterRTI.connect ( ) throws Exception
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().

void federate.IMakShooterRTI.destroyFederationEx ( ) throws Exception
E_PlayerIdentity federate.IMakShooterRTI.determineMyIdentity ( ) throws Exception

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().

void federate.IMakShooterRTI.disconnect ( ) throws Exception
void federate.IMakShooterRTI.evokeCallbacks ( double  d,
double  e 
) throws Exception

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().

String federate.IMakShooterRTI.getDefaultFedFile ( )
E_PlayerIdentity federate.IMakShooterRTI.getMyIdentity ( )
void federate.IMakShooterRTI.initialize ( ) throws Exception
boolean federate.IMakShooterRTI.isConnected ( )
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().

void federate.IMakShooterRTI.publishDetonation ( ) throws Exception
void federate.IMakShooterRTI.publishShip ( ) throws Exception

Publish ship.

Exceptions
Exceptionthe exception

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

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

void federate.IMakShooterRTI.publishShot ( ) throws Exception

Publish shot.

Exceptions
Exceptionthe exception

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

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

void federate.IMakShooterRTI.registerDialogForListFederation ( StartJoinGameDialog  configureGameDialog)
void federate.IMakShooterRTI.registerShip ( ) throws Exception

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().

void federate.IMakShooterRTI.requestListFedEx ( ) throws Exception
void federate.IMakShooterRTI.resignFedEx ( ) throws Exception
void federate.IMakShooterRTI.sendDetonationInteraction ( Ship  ship,
Shot  shot 
) throws Exception
void federate.IMakShooterRTI.setBoard ( Board  board)
void federate.IMakShooterRTI.setEnemyShip ( Ship  ship)
void federate.IMakShooterRTI.setIdentityObserver ( )
void federate.IMakShooterRTI.setMyship ( Ship  ship)
void federate.IMakShooterRTI.subscribeDetonation ( ) throws Exception
void federate.IMakShooterRTI.subscribeShip ( ) throws Exception

Subscribe to ships.

Exceptions
Exceptionthe exception

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

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

void federate.IMakShooterRTI.subscribeShot ( ) throws Exception

Subscribe to shots.

Exceptions
Exceptionthe exception

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

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

void federate.IMakShooterRTI.unPublishShip ( ) throws Exception

Un publish ship.

Exceptions
Exceptionthe exception

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

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

void federate.IMakShooterRTI.unPublishShot ( ) throws Exception

Un publish shot.

Exceptions
Exceptionthe exception

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

void federate.IMakShooterRTI.unRegisterShip ( ) throws Exception

Un register ship.

Exceptions
Exceptionthe exception

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

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

void federate.IMakShooterRTI.unRegisterShots ( ) throws Exception

Un register shots.

Exceptions
Exceptionthe exception

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

void federate.IMakShooterRTI.updateShipAttributes ( Ship  ship) throws Exception

Update ship attributes.

Parameters
shipthe ship
Exceptions
Exceptionthe exception

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

Referenced by controllers.KeyboardShipController.moveShip().

void federate.IMakShooterRTI.updateShotAttributes ( Shot  shot) throws Exception

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 Wed Mar 11 20:26:49 EDT 2015 from SVN revision 150939
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)