mi32/dbschema.h

Go to the documentation of this file.

/*****************************************************************************
 * \file mi32/dbschema.h
 *
 * \if NODOC
 * Support for the International Hydrographic Organization (IHO) S-57
 * schema for database tables.
 * 
 * This is in response to Bugzilla ID 13849
 *  $Log: dbschema.h_v $
 *  Revision 1.7  2011/12/08 15:29:26  mju
 *  Fwd declare filepath.
 *
 *  Revision 1.6  2011/10/24 20:36:09  mju
 *  Remove redundant hdr.
 *
 *  Revision 1.5  2007/07/05 21:23:08  dwilliss
 *  keep track of unitid on enums
 *
 *  Revision 1.4  2007/07/02 17:41:36  dwilliss
 *  added attribute type for ListUnique
 *
 *  Revision 1.3  2007/06/22 19:25:55  dwilliss
 *  changed how we deal with object classes
 *
 *  Revision 1.2  2007/06/15 22:41:15  dwilliss
 *  *** empty log message ***
 *
 *  Revision 1.1  2007/06/15 21:48:14  dwilliss
 *  Initial revision
 *
 * \endif
 *
 ****************************************************************************/

#ifndef INC_MI32_DBSCHEMA_H
#define INC_MI32_DBSCHEMA_H

#ifndef INC_MI32_ELEMTYPE_H
#include <mi32/elemtype.h>
#endif

#ifndef INC_MI32_MILIST_H
#include <mi32/milist.h>
#endif

#ifndef INC_MI32_ENUMSET_H
#include <mi32/enumset.h>
#endif

#ifndef INC_MI32_SIMPLEAR_H
#include <mi32/simplear.h>
#endif

#ifndef INC_RVC_DESCRIPTOR_H
#include <rvc/descriptor.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
class FILEPATH;
class XMLDOC;
#endif


namespace DBSCHEMA {
   class CATALOG;
   class OBJECT;

   // Will be read from the s57expectedinput.csv reference file
   struct ATTRIBUTE_ENUMVAL {
      int m_num;
      int m_unitid;  // used for the 3 field types that are actually units
      bool m_bObsolete;
      MISTRING m_text;
      MISTRING m_desc;
      };

   // Will mostly be read from the s57attributes.csv reference file
   // There is also a BaseTypes.xsd file which contains long descriptions
   // and ranges for numeric types that have them
   class ATTRIBUTE {
      public:
         enum TYPE {
            TYPE_Enum = 'E',
            TYPE_Float = 'F',
            TYPE_List = 'L',           
            TYPE_ListUnique = 'U',
            TYPE_Int = 'I',
            TYPE_CodedString = 'A', // Text of a specific format (documented but not specified by any reference file -- bastards!)
            TYPE_FreeText = 'S',
            };

         // XXX Look up what these mean
         enum CLASS {
            CLASS_F = 'F', 
            CLASS_N = 'N', 
            CLASS_S = 'S', 
            CLASS_Dollar = '$',     // for whole chart?
            };

         ATTRIBUTE (
            const MISTRINGLIST& parts  // line from the csv file
            );

         ATTRIBUTE (
            );

         ~ATTRIBUTE (
            );

         CLASS GetClass (
            ) const { return m_Class; }

         const RVC::DESCRIPTOR& GetDescriptor (
            ) const { return m_Descriptor; }

         const MILIST<ATTRIBUTE_ENUMVAL>& GetEnumValues (
            ) const { return m_EnumValues; }

         int GetIDNum (
            ) const { return m_num; }

         double GetMaxVal (
            ) const { return m_MaxVal; }

         double GetMinVal (
            ) const { return m_MinVal; }

         TYPE GetType (
            ) const { return m_Type; }

         const MISTRING& GetFormat (
            ) const { return m_format; }

         int GetMeasureID (
            ) const { return m_MeasureNum; }

         int GetUnitID (
            ) const { return m_UnitNum; }

         const MISTRING& GetUnitName (
            ) const { return m_UnitName; }

      private:
         int m_num;
         RVC::DESCRIPTOR m_Descriptor;
         char m_acronym[8];
         MISTRING m_format;
         int m_MeasureNum;
         int m_UnitNum;
         CLASS m_Class;
         TYPE m_Type;   
         double m_MinVal;
         double m_MaxVal;
         MILIST<ATTRIBUTE_ENUMVAL> m_EnumValues;
         MISTRING m_UnitName;
         friend class CATALOG;
      };


   // information about a class of objects.  Currently only a place to hold
   // the descriptor, but here for future expansion
   class OBJECT_CLASS {
      public:
         OBJECT_CLASS();
         ~OBJECT_CLASS();

         bool IsRestrictedByElemType (
            ) const { return m_bIsRestrictedByElemType; }

         const RVC::DESCRIPTOR& GetDescriptor (
            ) const { return m_Descriptor; }

      private:
         RVC::DESCRIPTOR m_Descriptor;
         bool m_bIsRestrictedByElemType;

         friend class CATALOG;
      };


   class OBJECT {
      public:

      OBJECT (
         const CATALOG*
         );

      ~OBJECT (
         );

      const SIMPLE_ARRAY<const ATTRIBUTE*>& GetAttributeGroup (
         int num
         ) const { return m_AttributeGroup[num]; }

      const CATALOG* GetCatalog (
         ) const { return m_Catalog; }

      const OBJECT_CLASS& GetClass (
         ) const { return *m_Class; }

      const RVC::DESCRIPTOR& GetDescriptor (
         ) const { return m_Descriptor; }

      int GetIDNum (
         ) const { return m_num; }

      bool IsForElementType (
         ELEMTYPE ElemType
         ) const { return m_ElemTypes.Contains(ElemType); }

      private:
         char m_acronym[8];
         int m_num;
         const OBJECT_CLASS* m_Class;
         RVC::DESCRIPTOR m_Descriptor;
         ENUMSET<ELEMTYPE, ELEMTYPE_NumTypes> m_ElemTypes;
         SIMPLE_ARRAY<const ATTRIBUTE*> m_AttributeGroup[3];
         const CATALOG* m_Catalog;

         friend class CATALOG;
      };

   // Container for S57 stuff
   class CATALOG {
      public:
         CATALOG();
         ~CATALOG();

         const ATTRIBUTE* FindAttribute (
            const char* acronym
            ) const;

         const ATTRIBUTE* FindAttribute (
            int num
            ) const;

         const OBJECT* FindObject (
            const char* acronym
            ) const;

         const OBJECT* FindObject (
            int num
            ) const;

         const RVC::DESCRIPTOR& GetDescriptor (
            ) const { return m_Descriptor; }

         const SIMPLE_ARRAY<OBJECT_CLASS*>& GetObjectClasses (
            ) const { return m_ObjectClasses; }

         const SIMPLE_ARRAY<OBJECT*>& GetObjects (
            ) const { return m_ObjectTypes; }

         ERRVALUE GetXML (
            XMLDOC& doc
            );

         ERRVALUE ReadFromReferenceFiles();

         ERRVALUE Read (
            const XMLDOC& doc
            );

         ERRVALUE Read (
            const FILEPATH& filepath
            );

      private:
         SIMPLE_ARRAY<OBJECT_CLASS*> m_ObjectClasses;
         SIMPLE_ARRAY<ATTRIBUTE*> m_AttributeTypes;
         SIMPLE_ARRAY<OBJECT*> m_ObjectTypes;
         RVC::DESCRIPTOR m_Descriptor;

         ATTRIBUTE* FindAttribute (
            const MISTRING& code             // This is a string with the acronym and code combined
            );

         OBJECT* FindObject (
            const MISTRING& code
            );


         void SetAttributes (
            SIMPLE_ARRAY<const ATTRIBUTE*>& AttributeGroup,
            const MISTRING&mistr
            );

      };


} // end DBSCHEMA namespace

#endif  // INC_MI32_DBSCHEMA_H

---