underwaterAcousticsStateRepository.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 1992-2025 MAK Technologies, Inc
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vl/underwaterAcousticsEmissionRepository.h>
#include <vl/additionalPassiveActivitiesRepository.h>
#include <vl/propulsionNoiseStateRepository.h>
#include <vl/activeSonarStateRepository.h>
#include <vlutil/vlList.h>

enum DtSonarSysRetCode
{
   DtSonarSuccess,
   DtBadSonarId,
   DtDuplicateSonarId
};

enum DtApaRetCode
{
   DtApaSuccess,
   DtBadApaId,
   DtDuplicateApaId
};

class DT_DLL_VL DtUnderwaterAcousticsStateRepository
   : public DtUnderwaterAcousticsEmissionRepository
{
public:

   typedef DtAdditionalPassiveActivitiesRepository* (*DtApaStateRepCreator)();

   typedef DtActiveSonarStateRepository* (*DtActiveSonarStateRepCreator)();

public:

   static DtUnderwaterAcousticsStateRepository* create();

   DtUnderwaterAcousticsStateRepository();

   DtUnderwaterAcousticsStateRepository( const DtUnderwaterAcousticsStateRepository& orig );

   virtual ~DtUnderwaterAcousticsStateRepository();

   DtUnderwaterAcousticsStateRepository& operator = (
      const DtUnderwaterAcousticsStateRepository& orig );

   virtual DtStateRepository* clone( bool copy ) const;

   static DtActiveSonarStateRepCreator setActiveSonarStateRepCreator(
      DtActiveSonarStateRepCreator creator );

   virtual void printData() const;

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


   virtual void setEntityId( const DtEntityIdentifier& id );

   virtual void setHostId( const DtGlobalObjectDesignator& id );

   virtual void setEventIdentifier( const DtEventId& id );



   virtual void setHullMaskerOn( bool val );

   virtual bool hullMaskerOn() const;

   virtual void setPassiveParameterIndex( DtU16 val );

   virtual DtU16 passiveParameterIndex() const;

   virtual void setPropulsionPlantConfiguration(
      DtUnderwaterAcousticPropulsionPlantConfig val );

   virtual DtUnderwaterAcousticPropulsionPlantConfig
      propulsionPlantConfiguration() const;

   virtual void setShaftRateData(
      const std::vector<DtUnderwaterAcousticShaftSpeed>& val );

   virtual const std::vector<DtUnderwaterAcousticShaftSpeed>&
      shaftRateData() const;

   virtual const DtPropulsionNoiseStateRepository& propNoiseStateRep() const;
   virtual DtPropulsionNoiseStateRepository& propNoiseStateRep();



   virtual DtAdditionalPassiveActivitiesRepository* apaSRById(
      DtU16 activityCode, DtApaRetCode* retcode = NULL );

   virtual DtAdditionalPassiveActivitiesRepository* addApa(
      DtU16 activityCode = 0, DtApaRetCode* retcode = NULL );

   virtual DtApaRetCode removeApa( DtU16 activityCode );
#if DtHLA
   virtual DtApaRetCode removeApa( const DtGlobalObjectDesignator& id );
#endif

   virtual int numAPAs() const;

   virtual const DtList* apaList() const;
   virtual DtList* apaList();

   bool isMember( DtAdditionalPassiveActivitiesRepository* ssr ) const;



   virtual DtActiveSonarStateRepository* activeSonarSRById(
      DtU8 acousticId, DtSonarSysRetCode* retcode = NULL );

   virtual DtActiveSonarStateRepository* addActiveSonar(
      DtU8 acousticId = 0, DtSonarSysRetCode* retcode = NULL );

   virtual DtSonarSysRetCode removeActiveSonar( DtU8 acousticId );
#if DtHLA
   virtual DtSonarSysRetCode removeActiveSonar( const DtGlobalObjectDesignator& id );
#endif

   virtual int numActiveSonars() const;

   virtual const DtList* activeSonarList() const;
   virtual DtList* activeSonarList();

   bool isMember( DtActiveSonarStateRepository* ssr ) const;


protected:

   virtual void purgeApaList();

   virtual void purgeActiveSonarList();

protected:

   static DtApaStateRepCreator theApaStateRepCreator;
   static DtActiveSonarStateRepCreator theActiveSonarStateRepCreator;

   DtPropulsionNoiseStateRepository myPropulsionNoiseState;

   DtList myAdditionalPassiveActivitiesList;

   DtList myActiveSonarList;

};