examples/addAttr/addAttrGui/DtAddAttrGuiAccessory.h

Go to the documentation of this file.

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

//\file DtAddAttrGuiAccessory.h
//\brief Contains DtAddAttrGuiAccessory class.  Used to install extensions to the FOM
//for mass

//Include this header file to get all protocol dependent header files
//and #defines defined, specifically:
//DT_PROTOCOL_NAMESPACE
//VRF_PROTOCOL_NAMESPACE
#pragma once

#include <vrfVrlSharedSource/vrfProtocol.h>
#include <vrvCore/DtBaseAccessory.h>
#include <vrvCore/DtEntityState.h>
#include <vrfVrlSharedSource/DtVrfDriver.h>

namespace makVrv
{
   class DtConnection;
}

namespace makVrf
{
   namespace VRF_PROTOCOL_NAMESPACE
   {
      class DtVrfDriver;
   }
}

//\brief This class defines an accessory that will install itself
//into DtVrlinkDriver objects and print out the esr of entities
//as they are discovered.
class DtAddAttrGuiAccessory : public makVrv::DtBaseAccessory
{
public:
   //\Default constructor
   DtAddAttrGuiAccessory();

   //\Default destructor
   virtual ~DtAddAttrGuiAccessory();

   //\brief Called when this accessory is installed into a connector.
   virtual void install(makVrv::DtDriver* driver);

   //\brief Called when this accessory is uninstalled
   virtual void uninstall(makVrv::DtDriver* baseConn);

   //\brief Called to find out if this accessory is compatible with a
   //particular connector. In this case, it is compatible with any
   //DtVrlinkDriver of the correct protocol
   virtual bool isCompatible(makVrv::DtDriver* driver);

protected:

   //\brief Called when the driver creates a new connection
   virtual void slot_onSimCreated(makVrv::DtConnection* connection);

   //\brief Called when a sim connection is connected
   virtual void slot_onSimConnected(makVrv::DtConnection* connection);

   //\brief Called when a sim connection is disconnected
   virtual void slot_onSimAboutToBeDisconnected(makVrv::DtConnection* connection);

   //\brief Called when state view is updated for entity state
   virtual void slot_stateUpdated(makVrv::DtUniqueID listenerId, const makVrv::DtVrlinkSimulatedBaseState& s);

   //\brief Called when the Vrf Driver has complete its setup.  Safe to connect to data processor signals
   virtual void slot_onConnectionSetupComplete();

protected:
   makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfDriver* myDriver;
};