rvc/descriptor.h

Go to the documentation of this file.

#ifndef  INC_RVC_DESCRIPTOR_H
#define  INC_RVC_DESCRIPTOR_H

#ifndef INC_MI32_FIXEDSTR_H
   #include <mi32/fixedstr.h>
#endif

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

namespace RVC {

typedef FIXEDSTRING<16> OBJECTNAME;

class RVCSYSLIBCLASSEXPORT DESCRIPTOR {
   public:

      DESCRIPTOR ();

      DESCRIPTOR (
         const MISTRING& name
         );

      DESCRIPTOR (
         TEXTID TextID
         );

      DESCRIPTOR (
         const MISTRING& name,
         const MISTRING& description
         );

      DEPRECATED DESCRIPTOR (
         const RVC::OBJECTNAME& name
         );

      DESCRIPTOR (
         const DESCRIPTOR& rhs
         ) :
         m_Name(rhs.m_Name),
         m_ShortName(rhs.m_ShortName),
         m_Description(rhs.m_Description),
         m_Source(rhs.m_Source)
         {}

      ~DESCRIPTOR ();

      DESCRIPTOR& operator= (
         const DESCRIPTOR& rhs
         ) {
         if (this != &rhs) {
            m_Name = rhs.m_Name;
            m_ShortName = rhs.m_ShortName;
            m_Description = rhs.m_Description;
            m_Source = rhs.m_Source;
            }
         return (*this);
         }
         
      DESCRIPTOR& operator= (
         const MISTRING& name
         );
         
      DESCRIPTOR& operator= (
         TEXTID textid
         );
         
      void Clear (
         ) {
         m_Name.Clear();
         m_ShortName.Clear();
         m_Description.Clear();
         m_Source.Clear();
         return;
         }

      const MISTRING& GetDescription (
         ) const { return (m_Description); }
         
      const MISTRING& GetFullName (
         ) const { return (m_Name); }

      const OBJECTNAME& GetShortName (
         ) const { return (m_ShortName); }

      const OBJECTNAME& GetSource (
         ) const;

      bool IsEmpty (
         ) const { return (m_Name.IsEmpty() && m_Description.IsEmpty()); }
         
      bool IsEqual (
         const DESCRIPTOR& rhs
         ) const;

      bool IsLessThan (
         const DESCRIPTOR& rhs
         ) const { return (m_Name < rhs.m_Name || (m_Name == rhs.m_Name && m_Description < rhs.m_Description)); }

      void SetDescription (
         const MISTRING& Description         
         ) { m_Description = Description; }
         
      void SetName (
         const MISTRING& Name                
         );

      void SetName (
         const MISTRING& Name,               
         FastDelegate<int(const RVC::OBJECTNAME&)> DelegateTestUniqueShortName
         );

      void SetShortName (
         const OBJECTNAME& name
         );
         
      void SetSource (
         const OBJECTNAME& Source            
         ) { m_Source = Source; }

      void SetSource (
         const char* Source                  
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MISTRING m_Name;
      MISTRING m_Description;
      OBJECTNAME m_ShortName;
      mutable OBJECTNAME m_Source;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
}     // End of RVC namespace

#undef RVCSYSLIBCLASSEXPORT

inline bool operator== (
   const RVC::DESCRIPTOR& lhs,
   const RVC::DESCRIPTOR& rhs
   ) { return (lhs.IsEqual(rhs)); }

inline bool operator!= (
   const RVC::DESCRIPTOR& lhs,
   const RVC::DESCRIPTOR& rhs
   ) { return (!lhs.IsEqual(rhs)); }

inline bool operator< (
   const RVC::DESCRIPTOR& lhs,
   const RVC::DESCRIPTOR& rhs
   ) { return (lhs.IsLessThan(rhs)); }

#endif      // INC_RVC_DESCRIPTOR_H

---