src/lib/cinema.h

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/cinema.h
  21  *  @brief Cinema class.
  22  */
  23
  24 #include <libcxml/cxml.h>
  25 #include <boost/enable_shared_from_this.hpp>
  26
  27 namespace xmlpp {
  28         class Element;
  29 }
  30
  31 class Screen;
  32
  33 /** @class Cinema
  34  *  @brief A description of a Cinema for KDM generation.
  35  *
  36  *  This is a cinema name, some metadata and a list of
  37  *  Screen objects.
  38  */
  39 class Cinema : public boost::enable_shared_from_this<Cinema>
  40 {
  41 public:
  42         Cinema (std::string const & name_, std::list<std::string> const & e, std::string notes_, int utc_offset_hour, int utc_offset_minute)
  43                 : name (name_)
  44                 , emails (e)
  45                 , notes (notes_)
  46                 , _utc_offset_hour (utc_offset_hour)
  47                 , _utc_offset_minute (utc_offset_minute)
  48         {}
  49
  50         Cinema (cxml::ConstNodePtr);
  51
  52         void read_screens (cxml::ConstNodePtr);
  53
  54         void as_xml (xmlpp::Element *) const;
  55
  56         void add_screen (boost::shared_ptr<Screen>);
  57         void remove_screen (boost::shared_ptr<Screen>);
  58
  59         void set_utc_offset_hour (int h);
  60         void set_utc_offset_minute (int m);
  61
  62         std::string name;
  63         std::list<std::string> emails;
  64         std::string notes;
  65
  66         int utc_offset_hour () const {
  67                 return _utc_offset_hour;
  68         }
  69
  70         int utc_offset_minute () const {
  71                 return _utc_offset_minute;
  72         }
  73
  74         std::list<boost::shared_ptr<Screen> > screens () const {
  75                 return _screens;
  76         }
  77
  78 private:
  79         std::list<boost::shared_ptr<Screen> > _screens;
  80         /** Offset such that the equivalent time in UTC can be determined
  81             by subtracting the offset from the local time.
  82         */
  83         int _utc_offset_hour;
  84         /** Additional minutes to add to _utc_offset_hour if _utc_offset_hour is
  85             positive, or to subtract if _utc_offset_hour is negative.
  86         */
  87         int _utc_offset_minute;
  88 };