Merge remote-tracking branch 'origin/main' into v2.17.x
[dcpomatic.git] / 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
26 #include <libcxml/cxml.h>
27 #include <memory>
28
29
30 namespace xmlpp {
31         class Element;
32 }
33
34 namespace dcpomatic {
35         class Screen;
36 }
37
38 /** @class Cinema
39  *  @brief A description of a Cinema for KDM generation.
40  *
41  *  This is a cinema name, some metadata and a list of
42  *  Screen objects.
43  */
44 class Cinema : public std::enable_shared_from_this<Cinema>
45 {
46 public:
47         Cinema(std::string const & name_, std::vector<std::string> const & e, std::string notes_)
48                 : name (name_)
49                 , emails (e)
50                 , notes (notes_)
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 (std::shared_ptr<dcpomatic::Screen>);
60         void remove_screen (std::shared_ptr<dcpomatic::Screen>);
61
62         std::string name;
63         std::vector<std::string> emails;
64         std::string notes;
65
66         std::vector<std::shared_ptr<dcpomatic::Screen>> screens() const {
67                 return _screens;
68         }
69
70 private:
71         std::vector<std::shared_ptr<dcpomatic::Screen>> _screens;
72 };