activeSonarStateRepository.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2013 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vl/underwaterAcousticsEmissionRepository.h>
#include <vl/activeSonarBeamRepository.h>
#include <vlutil/vlList.h>

enum DtSonarBeamRetCode
{
   DtSonarBeamSuccess,
   DtBadSonarBeamId,
   DtDuplicateSonarBeamId
};

class DT_DLL_VL DtActiveSonarStateRepository : public DtUnderwaterAcousticsEmissionRepository
{
public:

   typedef DtActiveSonarBeamRepository* (*DtBeamStateRepCreator)();

public:

   static DtActiveSonarStateRepository* create();

   DtActiveSonarStateRepository();

   virtual ~DtActiveSonarStateRepository();

   DtActiveSonarStateRepository( const DtActiveSonarStateRepository& orig );

   DtActiveSonarStateRepository& operator = (
      const DtActiveSonarStateRepository& orig );

   virtual DtStateRepository* clone( bool copy ) const;

   static DtBeamStateRepCreator setStateRepCreator( DtBeamStateRepCreator creator );

   virtual void printData() const;

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

   virtual void setAcousticName( DtUnderwaterAcousticSystemName val );

   virtual DtUnderwaterAcousticSystemName acousticName() const;

   virtual void setFunctionCode( DtUnderwaterAcousticFunction val );

   virtual DtUnderwaterAcousticFunction functionCode() const;

   virtual void setAcousticsIdentifier( DtU8 val );

   virtual DtU8 acousticsIdentifier() const;

   virtual DtActiveSonarBeamRepository* beamSRById(
      DtU8 beamId, DtSonarBeamRetCode* retcode = NULL );

   virtual DtActiveSonarBeamRepository* addBeam(
      DtU8 beamId = 0, DtSonarBeamRetCode* retcode = NULL);

   virtual DtSonarBeamRetCode removeBeam( DtU8 beamId );
#if DtHLA
   virtual DtSonarBeamRetCode removeBeam( const DtGlobalObjectDesignator& id );
#endif

   virtual int numBeams() const;

   virtual const DtList* beamList() const;
   virtual DtList* beamList();

   bool isMember(DtActiveSonarBeamRepository* bsr) const;

protected:

   virtual void purgeBeamList();

   static DtBeamStateRepCreator theBeamStateRepCreator;

protected:

   DtUnderwaterAcousticSystemName myAcousticName;
   DtUnderwaterAcousticFunction myFunctionCode;
   DtU8 myAcousticsIdentifier;

   DtList myBeamList;

};