/*
- Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
+/** @file src/lib/cinema.h
+ * @brief Screen and Cinema classes.
+ */
+
#include <boost/enable_shared_from_this.hpp>
-#include <libdcp/certificates.h>
+#include <dcp/certificates.h>
+#include <libcxml/cxml.h>
class Cinema;
-namespace cxml {
- class Node;
-}
-
+/** @class Screen
+ * @brief A representation of a Screen for KDM generation.
+ *
+ * This is the name of the screen and the certificate of its
+ * server.
+ */
class Screen
{
public:
, certificate (cert)
{}
- Screen (boost::shared_ptr<const cxml::Node>);
+ Screen (cxml::ConstNodePtr);
void as_xml (xmlpp::Element *) const;
boost::shared_ptr<dcp::Certificate> certificate;
};
+/** @class Cinema
+ * @brief A description of a Cinema for KDM generation.
+ *
+ * This is a cinema name, contact email address and a list of
+ * Screen objects.
+ */
class Cinema : public boost::enable_shared_from_this<Cinema>
{
public:
, email (e)
{}
- Cinema (boost::shared_ptr<const cxml::Node>);
+ Cinema (cxml::ConstNodePtr);
- void read_screens (boost::shared_ptr<const cxml::Node>);
+ void read_screens (cxml::ConstNodePtr);
void as_xml (xmlpp::Element *) const;