mlPCLR2SonicWCLoaderModule.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code author="Wolf Spindler"
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLPCLR2SonicWCLoaderSystem.h"
#include "mlR2SonicWCLoader.h"
#include <mlPCLModule.h>
#if defined(MLAB_CMAKE_BUILDSYSTEM)
#include <include/mlMultiFields.h>
#else
#include <mlMultiFields.h>
#endif
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLPCLR2SonicWCLoader_EXPORT PCLR2SonicWCLoader : public PCLModule
{
public:
  PCLR2SonicWCLoader();
  
  ~PCLR2SonicWCLoader() override;

  const R2SonicWC::R2SonicWCLoader &getLoaderInstance() const;
  
protected:
  void activateAttachments() override;

  virtual void _updateAnalyzeProgressAndStatus(float percState);
  
  virtual void _updateProgressAndStatus(const std::string &statusString,
                                        float percState);
  
  void handleNotification (Field* field) override;
 
private:
  friend class R2SonicLoaderFunctionClass;
  friend class R2SonicWC::WaterColumnDataSet;
  
  void _addFileMemberFields();
  
  bool _isFileMemberField(Field * field);
  
  void _resetFileMemberFields();

  void _updateFileMemberFields();

  void _clear();
  
  void _invalidateLoader();
  
  void _load();

  void _invalidateTextDump();

  void _updateTextDump();

  void _invalidateOutputPointClouds();

  void _updateOutputPointClouds(float percentageStart, float percentageRange);
  
  // Members:
  R2SonicWC::R2SonicWCLoader _wcLoader;
 
  // Fields:
  StringField *_fullFilePathFld;
  
  BoolField   *_autoApplyFld;
  
  NotifyField *_loadFld;

  BoolField   *_fileIOHasSucceededFld;

  IntField   *_maxNumberOfPacketsToShowFld;

  BoolField   *_showFirstOfEachPacketTypeOnlyFld;
  
  IntField   *_maxNumberOfBeamsToShowFld;

  IntField   *_maxNumberOfSamplesPerBeamToShowFld;

  IntField   *_indexOfFirstPingToOutputFld;

  IntField   *_numberOfPingsToOutputFld;

  IntField   *_indexOfFirstBeamToOutputFld;

  IntField   *_numberOfBeamsToOutputFld;
  
  FloatField *_magnitudeScaleFld;

  FloatField *_magnitudeThresholdFld;
  
  FloatField *_magnitudeThresholdPercentageFld;
  
  FloatField *_actuallyUsedThresholdFld;
  
  BoolField   *_applyTVGFld;

  BoolField   *_unifyTVGResultsFld;
  
  BoolField   *_convertOrphanedBeamsAndSamplesFld;
  
  FloatField  *_angleOfFirstPingInDegreeFld;

  FloatField  *_angleOffsetPerPingInDegreeFld;

  BoolField   *_autoCalculateAngleOffsetPerPingFld;

  FloatField  *_fullRotatorRangeInDegreeFld;
  
  FloatField  *_actuallyUsedAngleOffsetPerPingInDegreeFld;
  
  FloatField  *_mountPlaneTiltOffsetInDegreeFld;

  BoolField   *_addRxMountTiltToOffsetFld;

  BoolField   *_disableNormalizationFld;

  BoolField   *_scalePhaseToMinus1To1Fld;

  BoolField   *_createIndexCloudFld;
  
  BoolField   *_normalizeTxPowerTo191dbFld;

  BoolField   *_compensateGainFld;

  BoolField   *_autoAdaptThresholdFld;
  
  StringField *_fileDumpFld;

  IntField    *_numberOfPingsInFileFld;

  IntField    *_maxAllowedFileSizeInMBytesFld;

  IntField    *_maxNumAllowedPointsFld;

  IntField    *_workingMemoryHintInMBytesFld;

  IntField    *_minValidSecondFld;

public:
  NotifyField *_stopFld;
  
private:
  ProgressField *_progressFld;

  
  StringField *_PacketNameFld;          
  IntField    *_PacketSizeFld;          
  IntField    *_DataStreamIDFld;        

  StringField *_H0_SectionNameFld;      
  IntField    *_H0_SectionSizeFld;      
  StringField *_H0_ModelNumberFld;      
  StringField *_H0_SerialNumberFld;     
  IntField    *_H0_TimeSecondsFld;      
  IntField    *_H0_TimeNanosecondsFld;  
  IntField    *_H0_PingNumberFld;       
  FloatField  *_H0_PingPeriodFld;       
  FloatField  *_H0_SoundSpeedFld;       
  FloatField  *_H0_FrequencyFld;        
  FloatField  *_H0_TxPowerFld;          
  FloatField  *_H0_TxPulseWidthFld;     
  FloatField  *_H0_TxBeamwidthVertFld;  
  FloatField  *_H0_TxBeamwidthHorizFld; 
  FloatField  *_H0_TxSteeringVertFld;   
  FloatField  *_H0_TxSteeringHorizFld;  
  IntField    *_H0_TxMiscInfoFld;       
  IntField    *_H0_VTX_Plus_OffsetFld;  
  FloatField  *_H0_RxBandwidthFld;      
  FloatField  *_H0_RxSampleRateFld;     
  FloatField  *_H0_RxRangeFld;          
  FloatField  *_H0_RxGainFld;           
  FloatField  *_H0_RxSpreadingFld;      
  FloatField  *_H0_RxAbsorptionFld;     
  FloatField  *_H0_RxMountTiltFld;      
  IntField    *_H0_RxMiscInfoFld;       
  IntField    *_H0_reservedFld;         
  IntField    *_H0_BeamsFld;            

  StringField *_A1_SectionNameFld;      
  IntField    *_A1_SectionSizeFld;      
  FloatMultiField *_A1_MoreInfoFld;     
  FloatMultiField *_A1_BeamAngleFld;    
  
  StringField *_Mx_SectionNameFld;            
  IntField    *_Mx_SectionSizeFld;            
  IntField    *_Mx_PingNumberFld;             
  FloatField  *_Mx_ScalingFactorFld;          
  IntField    *_Mx_TotalSamplesFld;           
  IntField    *_Mx_FirstSampleFld;            
  IntField    *_Mx_SamplesFld;                
  IntField    *_Mx_TotalBeamsFld;             
  IntField    *_Mx_FirstBeamFld;              
  IntField    *_Mx_BeamsFld;                  
  IntField    *_Mx_reserved0Fld;              
  IntField    *_Mx_reserved1Fld;              
  // Showing all Magnitude and/or phase data is usually a bit large. Therefore this feature is 
  // disabled by default but can be enabled when needed in future.
//#define _PCLR2SonicWCLoader_Compile_MagnitudeAndOrPhaseDataField
#if defined(_PCLR2SonicWCLoader_Compile_MagnitudeAndOrPhaseDataField)
  IntMultiField *_Mx_MagnitudeAndOrPhaseDataFld;
#endif
  
  ML_MODULE_CLASS_HEADER(PCLR2SonicWCLoader);
  
  ML_PCL_TEST_INTERFACE(PCLR2SonicWCLoader);
};
 
ML_END_NAMESPACE