include/vrvCore/DtPagePath.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile:  $ $Revision:  $ $State:  $
******************************************************************************/


#pragma once
#include <vrvCore/vrvCore.h>
#include <makArchives/DtSerialize.h>
#include <string>

namespace makVrv
{
   class DT_DLL_VRVCORE DtPagePath
   {
   public:

      struct DT_DLL_VRVCORE PagePathBuilder
      {
      public:
         friend class DtPagePath;

         PagePathBuilder container(const std::string& name) const;

         DtPagePath page(const std::string& name) const;

      protected:

         inline const std::string& path() const { return myPath; }

         PagePathBuilder(const std::string& name);

         std::string myPath;
      };

      DtPagePath();

      DtPagePath(const PagePathBuilder& builder);

      DtPagePath(const DtPagePath& copy);

      static DtPagePath empty();

      static DtPagePath root();

      static PagePathBuilder collection(const std::string& name);

      inline const std::string& path() const { return myPath; }

      DtPagePath collectionPart() const;

      std::string name() const;

      bool isEmpty() const;

      bool isCollection() const;

      bool isPage() const;

      bool isChildOf(const DtPagePath& parent) const;

      bool isSiblingOf(const DtPagePath& sibling) const;

      bool operator ==(const DtPagePath& other) const;

      bool operator <(const DtPagePath& other) const;

      bool operator !=(const DtPagePath& other) const;

      DT_DECLARE_serialize_FUNCTIONS

   protected:

      template<class Archive>
      void _serialize(Archive & ar, const unsigned int version)
      {              
         ar & DT_SERIALIZE_MEMBER(myPath);
      }

      DtPagePath(const std::string& path);

      std::string myPath;
   };
}