objitem.h

Go to the documentation of this file.

/**
 * \file rvc/objitem.h
 * \brief RVC::OBJITEM class definitions
 *
 * $Id: objitem.h_v 1.1 2004/07/22 14:31:00 mju Exp $
 *
 * $Log: objitem.h_v $
 * Revision 1.1  2004/07/22 14:31:00  mju
 * Initial revision
 *
**/

#ifndef  INC_RVC_OBJITEM_H
#define  INC_RVC_OBJITEM_H

#ifndef  INC_MI32_RVCDEFNS_H
#include <mi32/rvcdefns.h>
#endif

namespace RVC {

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

//! OBJITEM class for specifying a particular file and object.
class OBJITEM {
   public:

      //! Setup output object item list corresponding to specified input object item list.
      static void SetupOutputList (
         MILIST<OBJITEM>& oobjlist,          //!< Output list
         const MILIST<OBJITEM>& iobjlist,    //!< Input list
         const char *source = 0              //!< Value to use for "source" in object header, will use application name if null.
         );

      //! Default constructor.
      OBJITEM (
         ) {
         m_ginfo.objectinode = -1;        // Set to nothing
         }

      //! Copy constructor.
      OBJITEM (
         const OBJITEM& rhs               //!< Object to copy from
         ) : m_filename(rhs.m_filename), m_ginfo(rhs.m_ginfo), m_ObjectPath(rhs.m_ObjectPath) {}

      //! Construct from FILEPATH and RVCGENINFO.
      OBJITEM (
         const FILEPATH& filename,        //!< Filename
         const RVCGENINFO& ginfo          //!< General info
         ) : m_filename(filename), m_ginfo(ginfo) {}

      //! Construct from FILEPATH and object path string.
      OBJITEM (
         const FILEPATH& filename,        //!< Filename
         const MISTRING& ObjectPath       //!< Object path
         ) : 
         m_filename(filename), 
         m_ObjectPath(ObjectPath)
         {
         m_ginfo.objectinode = -1;        // Set to nothing
         }

      //! Construct from FILEPATH and object inode.
      OBJITEM (
         const FILEPATH& filename,        //!< Filename
         RVCINODENUM inode                //!< Object inode
         ) { SetItem(filename,inode); }

      //! Construct having specified name, description, optional source.
      //! This useful when setting up an "output" OBJITEMLIST.
      OBJITEM (
         const MISTRING& name,
         const MISTRING& desc,
         const char *source = 0
         );

      //! Assignment.
      OBJITEM operator= (
         const OBJITEM& rhs               //!< Object to copy from
         ) {
         if (this != &rhs) {
            m_filename = rhs.m_filename;
            m_ginfo = rhs.m_ginfo;
            m_ObjectPath = rhs.m_ObjectPath;
            }
         return (*this);
         }
         
      //! Clear the OBJITEM, refers to nothing
      void Clear (
         ) {
         m_ginfo.Clear();
         m_ginfo.objectinode = -1;        // Set to nothing
         m_filename.Clear();
         m_ObjectPath.Clear();
         }

      //! Get string suitable for display.
      //! String will consist of file name, separator and object name.
      //! @seealso GetToolTipString
      void GetDisplayString (
         MISTRING& string                    //!< String returned
         ) const;

      //! Get the filepath.
      const FILEPATH& GetFilePath (
         ) const {
         return (m_filename);
         }

      //! Get the inode.
      RVCINODENUM GetInode (
         ) const {
         if (m_ginfo.objectinode == -1) ResolveObjectPath();
         return (m_ginfo.objectinode);
         }

      //! Get info.
      const RVCGENINFO& GetInfo (
         ) const {
         if (m_ginfo.objectinode == -1) ResolveObjectPath();
         return (m_ginfo);
         }

      //! Get object description.
      const RVC::OBJECTDESC& GetObjectDescription (
         ) const {
         if (m_ginfo.objectinode == -1) ResolveObjectPath();
         return (m_ginfo.desc);
         }

      //! Get object name.
      const RVC::OBJECTNAME& GetObjectName (
         ) const {
         if (m_ginfo.objectinode == -1) ResolveObjectPath();
         return (m_ginfo.name);
         }

      //! Get the Object Path
      ERRVALUE GetObjectPath (
         MISTRING& ObjectPath
         ) const {
         if (m_ginfo.objectinode == -1) {
            ObjectPath = m_ObjectPath;
            return (0);
            }
         return (DetermineObjectPath(ObjectPath));
         }

      //! Get the object type.
      RVC::OBJTYPE GetObjectType (
         ) const {
         return (static_cast<RVC::OBJTYPE>((m_ginfo.objectinode == -1) ? QuickObjectType() : m_ginfo.objtype));
         }

      //! Get standard "ToolTip" string for this item.
      //! @seealso GetDisplayString.
      void GetToolTipString (
         MISTRING& string                 //!< Tooltip string returned
         ) const;

      //! Determine if have both filepath and "object" assigned.
      //! Does not determine if actually resolved to existing object.
      bool IsAssigned (
         ) const {
         return (!m_filename.IsEmpty() && (IsResolved() || !m_ObjectPath.IsEmpty()));
         }

      //! Is it the same?
      bool IsEqual (
         const OBJITEM& rhs            //!< Object to compare
         ) const {
         if (m_ginfo.objectinode == -1) ResolveObjectPath();
         return (m_filename == rhs.m_filename && m_ginfo.objectinode == rhs.m_ginfo.objectinode);
         }

      //! Determine if item references actual existing object.
      //! This should not be used in time-critical operations as it will actually
      //! open the file and verify that the object exists.
      bool IsExisting (
         ) const;

      //! Determine if has been resolved to specific existing object.
      bool IsResolved (
         ) const { return (m_ginfo.objectinode >= 0); }
         
      //! Set filename
      void SetFilePath (
         const FILEPATH& filepath
         ) { m_filename = filepath; }

      //! Set item from FILEPATH and RVCGENINFO.
      void SetItem (
         const FILEPATH& filename,        //!< File name
         const RVCGENINFO& ginfo          //!< General info
         ) {
         m_filename = filename;
         m_ginfo = ginfo;
         m_ObjectPath.Clear();
         }

      //! Set item from FILEPATH and object path.
      void SetItem (
         const FILEPATH& filename,        //!< File name
         const MISTRING& ObjectPath       //!< Object path
         ) {
         m_filename = filename;
         m_ginfo.Clear();
         m_ginfo.objectinode = -1;
         m_ObjectPath = ObjectPath;
         }

      //! Set item from FILEPATH and object inode.
      void SetItem (
         const FILEPATH& filename,        //!< File name
         RVCINODENUM inode                //!< Object inode
         );

      //! Setup for use in prompt for or creation of new object with RVC::OBJECT parent.
      void SetNew (
         const RVC::OBJECT& ParentObj,       //!< Parent object reference
         RVC::OBJTYPE ObjType,               //!< New object type
         const RVC::OBJECTNAME& Name,        //!< New object name
         const RVC::OBJECTDESC& Description, //!< New object description
         const char *Source = 0
         );

      //! Setup for use in prompt for or creation of new object with RVC::OBJECT parent.
      //! @deprecated, Use variant with OBJECTNAME, OBJECTDESC parameters.
      DEPRECATED void SetNew (
         const RVC::OBJECT& ParentObj,    //!< Parent object reference
         RVC::OBJTYPE ObjType,            //!< New object type
         const UNICODE *Name,             //!< New object name
         const UNICODE *Description,      //!< New object description
         const UNICODE *Source = 0
         );

      //! Setup for use in prompt for or creation of new object with RVC::OBJITEM parent.
      void SetNew (
         const RVC::OBJITEM& ParentItem,     //!< Parent object item reference
         RVC::OBJTYPE ObjType,               //!< New object type
         const RVC::OBJECTNAME& Name,        //!< New object name
         const RVC::OBJECTDESC& Description, //!< New object description
         const char *Source = 0
         );

      //! Setup for use in prompt for or creation of new object with RVC::OBJITEM parent.
      //! @deprecated, Use variant with OBJECTNAME, OBJECTDESC parameters.
      DEPRECATED void SetNew (
         const RVC::OBJITEM& ParentItem,  //!< Parent object item reference
         RVC::OBJTYPE ObjType,            //!< New object type
         const UNICODE *Name,             //!< New object name
         const UNICODE *Description,      //!< New object description
         const UNICODE *Source = 0
         );

      //! Set object description from RVC::OBJECTDESC.
      void SetObjectDescription (
         const RVC::OBJECTDESC& NewDesc
         ) { m_ginfo.desc = NewDesc; }

      //! Set object info from RVCGENINFO.
      void SetObjectInfo (
         const RVCGENINFO& ginfo          //!< General info
         ) {
         m_ginfo = ginfo;
         m_ObjectPath.Clear();
         }

      //! Set object name from RVC::OBJECTNAME.
      void SetObjectName (
         const RVC::OBJECTNAME& NewName
         ) { m_ginfo.name = NewName; }

      //! Set object path without clearing file path.
      void SetObjectPath (
         const MISTRING& ObjectPath       //!< Object path
         ) {
         m_ginfo.Clear();
         m_ginfo.objectinode = -1;
         m_ObjectPath = ObjectPath;
         }

      //! Set object type if not bound to an object.
      void SetObjectType (
         UINT32 objtype                   //!< Object type
         ) { if (m_ginfo.objectinode < 0) m_ginfo.objtype = objtype; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      FILEPATH m_filename;                //!< File name
      mutable RVCGENINFO m_ginfo;         //!< General info
      MISTRING m_ObjectPath;              //!< Object path

      //! Determine object path from m_ginfo.
      ERRVALUE DetermineObjectPath (
         MISTRING& ObjectPath             //!< Object path returned
         ) const;

      //! Determine object type.
      UINT32 QuickObjectType (
         ) const;
         
      //! Resolve object path and setup m_ginfo.
      void ResolveObjectPath (
         ) const;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

typedef MILIST<OBJITEM> OBJITEMLIST;

//! Equality operator.
inline bool operator== (
   const RVC::OBJITEM& lhs,            //!< Object to compare
   const RVC::OBJITEM& rhs             //!< Object to compare
   ) {
   return (lhs.IsEqual(rhs));
   }

//! Inequality operator.
inline bool operator!= (
   const RVC::OBJITEM& lhs,            //!< Object to compare
   const RVC::OBJITEM& rhs             //!< Object to compare
   ) {
   return (!lhs.IsEqual(rhs));
   }

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

}     //! End of RVC namespace


//! Pre-namespace typedefs.
typedef RVC::OBJITEM RVCOBJITEM;
typedef RVC::OBJITEMLIST RVCOBJITEMLIST;


#endif   // INC_RVC_OBJITEM_H

---