ballController1516e.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: .h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/

#ifndef BallController1516e_H_
#define BallController1516e_H_

#include "ballData.h"
#include "ballController.h"

#include <RTI/RTI1516.h>

class HlaBounceFederateAmbassador;
class ObjectParams1516e;

// Class that updates owned balls and processes updates on
// other balls for 1516e federates
class BallController1516e : public BallController
{
public:

   BallController1516e(BallMap* data, DdmRegionMap* regionData);
   virtual ~BallController1516e();

   // Creates (if not already created) and joins the given federation.
   // Returns success indicator. federateName is not used in 1516.
   virtual bool createAndJoinFederation(const std::wstring& federation,
      const std::wstring& federateType,
      const std::wstring& federateName = std::wstring(),
      bool includeInterExt = false);

   // Resigns from and attempts to destroy the current federation.
   // Returns success indicator.
   virtual bool resignAndDestroyFederation();

   // Subscribes to the ball class and all its attributes. Must already have
   // created and joined the federation. Returns success indicator.
   virtual bool subscribe();

   // Unsubscribes to the ball class and all its attributes. Must already have
   // created and joined the federation. Returns success indicator.
   virtual bool unsubscribe();

   // Deletes the ball with the given ID
   virtual void deleteBall(const std::wstring id);

   // Attempts to acquire the ball with the given ID
   virtual void acquireBall(const std::wstring id);

   // Attempts to divest the owned ball with the given ID
   virtual void divestBall(const std::wstring id);

   // Adds a new DDM subscription region
   virtual bool subscribeWithRegion(int xLowerBound, int yLowerBound,
      int xUpperBound, int yUpperBound);

   // Unsubscribes from the current DDM regions. If resubscribeWithoutRegion is
   // set, automatically resubscribes without regions.
   virtual bool unsubscribeWithRegions(bool resubscribeWithoutRegion);

   // Process a denial for a new ball name
   void nameReservationFailed(const std::wstring& name);

   // Process an approval for a new ball name
   void nameReservationSucceeded(const std::wstring& name);

   // Process discovery of a new ball
   void ballDiscovered(ObjectParams1516e* objParams);

   // Process removal of another federate's ball
   void ballRemoved(rti1516e::ObjectInstanceHandle handle);

   // Process the movement of the ball into a visible area
   void ballVisible(rti1516e::ObjectInstanceHandle handle);

   // Process the movement of the ball out of a visible area
   void ballNotVisible(rti1516e::ObjectInstanceHandle handle);

   // Process update of an existing ball
   void ballUpdated(rti1516e::ObjectInstanceHandle handle,
      const rti1516e::AttributeHandleValueMap& attrVals);

   // Process a display text interaction
   void displayInteractionText(rti1516e::InteractionClassHandle handle,
      const rti1516e::ParameterHandleValueMap& paramVals);

   // Tries to release ownership of the requested object
   void releaseOwnership(rti1516e::ObjectInstanceHandle theObject,
      rti1516e::AttributeHandleSet const & attributes);

   // Takes control of the ball which the federate has successfully acquired
   // ownership of
   void ownershipAcquired(rti1516e::ObjectInstanceHandle theObject,
      rti1516e::AttributeHandleSet const & attributes);

   // Tries to assume ownership of the object being divested
   void assumeOwnership(rti1516e::ObjectInstanceHandle theObject,
      rti1516e::AttributeHandleSet const & attributes);

   // Confirms that the object is divested
   void confirmDivestiture(rti1516e::ObjectInstanceHandle theObject,
      rti1516e::AttributeHandleSet const & attributes);

   // Sets the field dimensions
   virtual void setDimensions(int minX, int minY, int maxX, int maxY);

   // Returns the federate ID (based on the federate handle)
   virtual const std::wstring& federateId() const;

   // Returns the federate type
   virtual const std::wstring& federateType() const;

   // Returns the federate name
   virtual const std::wstring& federateName() const;

   // Returns the federation name
   virtual const std::wstring& federationName() const;

   // Returns true. Federate name is supported in HLA Evolved.
   virtual bool isFederateNameSupported() const;

   // Returns true. The interaction FOM module extension is supported
   // in HLA Evolved.
   virtual bool isInteractionExtensionSupported() const;

protected:

   // Sends updates on all owned balls to other federates in the federation
   virtual void sendUpdates();

   // Receives updates on balls from other federates in the federation
   virtual void receiveUpdates();

   // Request the RTI to create the a new ball
   virtual void requestNewBall(Ball* ball, const std::wstring name);

   // Loads the AttributeHandleValueMap with the data from the given ball
   void setAttributesForBall(rti1516e::AttributeHandleValueMap& attrVals,
      const Ball* ball);

   // Loads the Ball with the data from the given attributes
   void setBallFromAttributes(Ball* ball,
      const rti1516e::AttributeHandleValueMap& attrVals);

   // Loads the TextEvent with the data from the given parameters
   void setTextEventFromParameters(TextEvent& textEvent,
      const rti1516e::ParameterHandleValueMap& paramVals);

   // Subscribes to the default region
   void subscribeToDefaultRegion();

   // Unsubscribes from the default region. Based on input parameter, either
   // deletes the discovered balls or marks them as out of scope.
   void unsubscribeFromDefaultRegion(bool deleteDiscoveredBalls);

   // Subscribes to the text interaction class.
   void subscribeInteractionClass();

   // Unsubscribes from the text interaction class.
   void unsubscribeInteractionClass();

   // Deletes known balls. Can delete owned, not owned, or both.
   virtual void deleteKnownBalls(bool deleteOwned, bool deleteOthers);

   // Marks all balls this federate does not own as out of scope
   void markBallsOutOfScope();

   // Creates a publication region for the given ball and sets ball's object 
   // parameters with the new region handle.
   bool createPublicationRegion(Ball* ball);

   // Constructs a user supplied tag for the given ball object parameters.
   // Not really relevant to federate operations.
   rti1516e::VariableLengthData constructTag(const Ball* ball) const;

private:

   // No default constructor
   BallController1516e();

protected:

   BallMap myUnnamedBalls;
   BallMap myPendingBalls;

   std::auto_ptr < rti1516e::RTIambassador > myRtiAmbassador;
   HlaBounceFederateAmbassador* myFederateAmbassador;

   rti1516e::FederateHandle myFederateHandle;
   std::wstring myFederateHandleString;
   std::wstring myFederateType;
   std::wstring myFederationName;

   bool myIsSubscribedToDefaultRegion;

   int myDdmXRangeConv;
   int myDdmYRangeConv;

   rti1516e::ObjectClassHandle myBallClass;
   rti1516e::AttributeHandle myColorAttr;
   rti1516e::AttributeHandle mySizeAttr;
   rti1516e::AttributeHandle myXAttr;
   rti1516e::AttributeHandle myYAttr;
   rti1516e::AttributeHandle mySpeedAttr;
   rti1516e::AttributeHandle myDirectionAttr;
   rti1516e::AttributeHandleSet myAllBallAttrs;
   rti1516e::AttributeHandle myPrivToDeleteAttr;
   rti1516e::DimensionHandle myXDim;
   rti1516e::DimensionHandle myYDim;

   bool myIsUsingInteractionModule;
   rti1516e::InteractionClassHandle myTextClass;
   rti1516e::ParameterHandle myTextParam;
   rti1516e::ParameterHandle myTextXParam;
   rti1516e::ParameterHandle myTextYParam;
   rti1516e::ParameterHandle myTextSizeParam;
   rti1516e::ParameterHandle myTextIntervalParam;
   rti1516e::ParameterHandleSet myAllTextParams;

   static const std::wstring theFddFile;
   static const std::wstring theBallClassName;
   static const std::wstring theColorAttrName;
   static const std::wstring theSizeAttrName;
   static const std::wstring theXAttrName;
   static const std::wstring theYAttrName;
   static const std::wstring theSpeedAttrName;
   static const std::wstring theDirectionAttrName;
   static const std::wstring thePrivToDeleteAttrName;
   static const std::wstring theXDimName;
   static const std::wstring theYDimName;

   static const std::wstring theInteractionFomModule;
   static const std::wstring theTextClassName;
   static const std::wstring theTextParamName;
   static const std::wstring theTextXParamName;
   static const std::wstring theTextYParamName;
   static const std::wstring theTextSizeParamName;
   static const std::wstring theTextIntervalParamName;

};

#endif