src/object.h

   1 /*
   2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 /** @file  src/object.h
  21  *  @brief Object class.
  22  */
  23
  24 #ifndef LIBDCP_OBJECT_H
  25 #define LIBDCP_OBJECT_H
  26
  27 #include <boost/noncopyable.hpp>
  28 #include <string>
  29
  30 class write_interop_subtitle_test;
  31 class write_smpte_subtitle_test;
  32
  33 namespace dcp {
  34
  35 /** @class Object
  36  *  @brief Some part of a DCP that has a UUID.
  37  */
  38 class Object : public boost::noncopyable
  39 {
  40 public:
  41         Object ();
  42         explicit Object (std::string id);
  43         virtual ~Object () {}
  44
  45         /** @return ID */
  46         std::string id () const {
  47                 return _id;
  48         }
  49
  50 protected:
  51         friend class ::write_interop_subtitle_test;
  52         friend class ::write_smpte_subtitle_test;
  53
  54         /** ID */
  55         std::string _id;
  56 };
  57
  58 }
  59
  60 #endif