src/lib/cinema.h

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic 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     DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/lib/cinema.h
  22  *  @brief Cinema class.
  23  */
  24
  25 #include <libcxml/cxml.h>
  26 #include <boost/enable_shared_from_this.hpp>
  27
  28 namespace xmlpp {
  29         class Element;
  30 }
  31
  32 namespace dcpomatic {
  33         class Screen;
  34 }
  35
  36 /** @class Cinema
  37  *  @brief A description of a Cinema for KDM generation.
  38  *
  39  *  This is a cinema name, some metadata and a list of
  40  *  Screen objects.
  41  */
  42 class Cinema : public boost::enable_shared_from_this<Cinema>
  43 {
  44 public:
  45         Cinema (std::string const & name_, std::list<std::string> const & e, std::string notes_, int utc_offset_hour, int utc_offset_minute)
  46                 : name (name_)
  47                 , emails (e)
  48                 , notes (notes_)
  49                 , _utc_offset_hour (utc_offset_hour)
  50                 , _utc_offset_minute (utc_offset_minute)
  51         {}
  52
  53         explicit Cinema (cxml::ConstNodePtr);
  54
  55         void read_screens (cxml::ConstNodePtr);
  56
  57         void as_xml (xmlpp::Element *) const;
  58
  59         void add_screen (boost::shared_ptr<dcpomatic::Screen>);
  60         void remove_screen (boost::shared_ptr<dcpomatic::Screen>);
  61
  62         void set_utc_offset_hour (int h);
  63         void set_utc_offset_minute (int m);
  64
  65         std::string name;
  66         std::list<std::string> emails;
  67         std::string notes;
  68
  69         int utc_offset_hour () const {
  70                 return _utc_offset_hour;
  71         }
  72
  73         int utc_offset_minute () const {
  74                 return _utc_offset_minute;
  75         }
  76
  77         std::list<boost::shared_ptr<dcpomatic::Screen> > screens () const {
  78                 return _screens;
  79         }
  80
  81 private:
  82         std::list<boost::shared_ptr<dcpomatic::Screen> > _screens;
  83         /** Offset such that the equivalent time in UTC can be determined
  84             by subtracting the offset from the local time.
  85         */
  86         int _utc_offset_hour;
  87         /** Additional minutes to add to _utc_offset_hour if _utc_offset_hour is
  88             positive, or to subtract if _utc_offset_hour is negative.
  89         */
  90         int _utc_offset_minute;
  91 };