From bf7689ba06764b72a6212549a5c8a39e294cceee Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sun, 8 May 2022 20:40:30 +0300 Subject: Fully documented all Models --- src/Models/Hall.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'src/Models/Hall.h') diff --git a/src/Models/Hall.h b/src/Models/Hall.h index d493573..c567c75 100644 --- a/src/Models/Hall.h +++ b/src/Models/Hall.h @@ -1,30 +1,47 @@ #ifndef HEADER_MODEL_HALL #define HEADER_MODEL_HALL +/*! \file Hall.h + * \brief Stores the declaration of class Hall + */ + #include #include +/*! \brief Each hall contains a number, rows and seats per row + */ class Hall { int number; unsigned rows; unsigned seatsPerRow; public: + //! Sets values to 0 Hall(); + //! Sets values, except number, to 0 Hall(int number); + //! Sets values Hall(int number, unsigned rows, unsigned seatsPerRow); + //! Returns a Hall's number int get_number() const; + //! Returns a Hall's row count unsigned get_rows() const; + //! Return a Hall's seats per row count unsigned get_seatsPerRow() const; + //! Reads Hall from stream void read(std::istream& istr); + //! Writes Hall to steam void write(std::ostream& ostr) const; + //! Compare two Halls int compare(const Hall& other) const; }; +//! Reads Hall from stream with >> operator std::istream& operator>>(std::istream& istr, Hall& hall); +//! Writes Hall to stream with << operator std::ostream& operator<<(std::ostream& ostr, const Hall& hall); #endif -- cgit v1.3.1-26-gb76a