mi32/lidarclassdesc.h

Go to the documentation of this file.

#ifndef  INC_MI32_LIDARCLASSDESC_H
#define  INC_MI32_LIDARCLASSDESC_H

#ifndef  INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_CODESPACE_H
#include <mi32/codespace.h>
#endif

#ifndef  INC_MI32_BOOL3_H
#include <mi32/bool3.h>
#endif


#ifdef RVCSYSDLL
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
class CLASSDESCARRAY;
class FILEPATH;
class FILEPATHLIST;
class XMLNODE;
#endif

namespace LIDAR {

//=====================================================================================================================

class CLASSLIBEXPORT CLASSDESC {
   public:

      enum USAGE {
         USAGE_Unspecified =        0,    
         USAGE_NeverClassified =    1,
         USAGE_Unclassified =       2,
         USAGE_Ground =             3,
         USAGE_LowVegetation =      4,
         USAGE_MediumVegetation =   5,
         USAGE_HighVegetation =     6,
         USAGE_Building =           7,
         USAGE_Noise =              8,
         USAGE_ModelKeyPoint =      9,
         USAGE_Water =              10,
         USAGE_NonGround =          11,
         USAGE_Tower =              12,   
         USAGE_Cable =              13,   
         USAGE_Bridge =             14,
         USAGE_Roadway =            15,
         USAGE_Vehicle =            16,
         USAGE_Animal =             17,
         USAGE_Object =             18,
         USAGE_Fence =              19,

         USAGE_Predefined_Count,
         USAGE_Excluded =           254,  
         USAGE_Other =              255,
         };

      static TEXTID GetUsageTextID (
         USAGE usage
         );

      CLASSDESC ();

      ~CLASSDESC ();

      UINT32 GetColorRef () const
         { return (m_ColorRef); }

      bool GetIncludeAlways () const
         { return (m_IncludeAlways); }

      const MISTRING& GetName () const
         { return (m_Name); }

      USAGE GetUsage () const
         { return (m_Usage); }

      bool IsDefault () const
         { return (m_IsDefault); }

      BOOL3 IsUsed () const
         { return (m_IsUsed); }

      void Set (
         USAGE usage,
         const MISTRING& name,
         UINT32 ColorRef,
         bool IncludeAlways,
         bool IsDefault = false
         );

      void SetColorRef (
         UINT32 ColorRef
         ) { m_ColorRef = ColorRef; m_IsDefault = false; }

      void SetIncludeAlways (
         bool IncludeAlways
         ) { m_IncludeAlways = IncludeAlways; m_IsDefault = false; }

      void SetName (
         const MISTRING& name
         ) { m_Name = name; m_IsDefault = false; }

      void SetUsage (
         USAGE Usage
         ) { m_Usage = Usage; m_IsDefault = false; }

      void SetUsed (
         BOOL3 used
         ) { m_IsUsed = used; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      USAGE m_Usage;
      bool m_IncludeAlways;            // Always include in table
      bool m_IsDefault;
      BOOL3 m_IsUsed;
      MISTRING m_Name;
      UINT32 m_ColorRef;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//=====================================================================================================================

class CLASSLIBEXPORT CLASSDESCSET {
   public:

      static void GetSavedPathList (
         FILEPATHLIST& FilePathList       
         );

      static const CLASSDESCSET& GetShared ()
         { return (GetSharedLow()); }

      static ERRVALUE ReadShared ();

      CLASSDESCSET ();

      CLASSDESCSET (const CLASSDESCSET& rhs);

      ~CLASSDESCSET ();

      CLASSDESCSET& operator= (const CLASSDESCSET& rhs);

      void CopyToShared (
         bool UpdateIniDefault         
         ) const;

      int FindUsageClass (
         CLASSDESC::USAGE usage
         ) const;

      UINT16 GetClassCount () const;

      const FILEPATH& GetFilePath () const;

      const CLASSDESC& GetItem (
         UINT16 ClassNumber            
         ) const;

      CLASSDESC& GetItem (
         UINT16 ClassNumber            
         );

      XMLNODE* GetXML (
         XMLNODE *parentnode,
         const char *nodename = "LidarClasses",
         bool IncludeAll = false
         ) const;

      ERRVALUE Read (
         const FILEPATH& filepath
         );

      void Reset (
         CODESPACE codespace = CODESPACE_ASPRS_LAS
         );

      void SetItem (
         UINT16 ClassNumber,           
         const CLASSDESC& classdesc
         );

      ERRVALUE SetFromXML (
         const XMLNODE *xmlnode
         );

      ERRVALUE Write (
         const FILEPATH& filepath
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;
      PRIV *m_pPriv;

      static CLASSDESCSET& GetSharedLow ();

      #endif
   };

//=====================================================================================================================

}  // End namespace LIDAR

#undef CLASSLIBEXPORT

#endif   // INC_MI32_LIDARCLASSDESC_H

---