environmentObjectTransaction.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/


#ifndef environmentObjectTransaction_H_
#define environmentObjectTransaction_H_

#if DtHLA 


#include "interactionWithEncDec.h"
#include "hostStructs.h"
#include "vlpi/syntheticEnvironmentObjectType.h"


class DT_DLL_VL DtEnvironmentObjectTransaction;
class DT_DLL_VL DtExerciseConn;

typedef void (*DtEnvironmentObjectTransactionCb)
   (DtEnvironmentObjectTransaction* inter, void* usr);


class DT_DLL_VL DtEnvironmentObjectTransaction : public DtInteractionWithEncDec
{
public:

   DtEnvironmentObjectTransaction();

   virtual ~DtEnvironmentObjectTransaction();

   DtEnvironmentObjectTransaction(const DtEnvironmentObjectTransaction& orig);

   DtEnvironmentObjectTransaction& operator=(
      const DtEnvironmentObjectTransaction& orig);

   virtual void printData() const;

   virtual void printDataToStream(std::ostream& stream) const;

   virtual void setObjectId(const DtEntityIdentifier& identifier);
   virtual const DtEntityIdentifier& objectId() const;

   virtual void setReferencedObjectId(const DtGlobalObjectDesignator& rtiObject);
   virtual const DtGlobalObjectDesignator& referencedObjectId() const;

   virtual void setForceId(const DtForceType value);
   virtual DtForceType forceId() const;
   
   virtual void setObjectType(const DtSyntheticEnvironmentObjectType& type);
   virtual const DtSyntheticEnvironmentObjectType& objectType() const;

   virtual void setRequestingId(const DtSimulationAddress& id);
   virtual const DtSimulationAddress& requestingId() const;

   virtual void setReceivingId(const DtSimulationAddress& id);
   virtual const DtSimulationAddress& receivingId() const;

   virtual const char* name() const;

public:

   static DtInteraction* create();

   static void addCallback(DtExerciseConn* conn,
      DtEnvironmentObjectTransactionCb cb, void* usr,
      DtDDMRegionSP region = DtDDMRegionSP());
   static void removeCallback(DtExerciseConn* conn,
      DtEnvironmentObjectTransactionCb cb, void* usr,
      DtDDMRegionSP region = DtDDMRegionSP());

protected:
   DtEntityIdentifier myObjectId;
   DtGlobalObjectDesignator myReferencedObjectId;
   DtForceType myForceId;
   DtSyntheticEnvironmentObjectType myObjectType;
   DtSimulationAddress myRequestingId;
   DtSimulationAddress myReceivingId;
};

#endif
#endif