L4B/Box.h

52 lines
1 KiB
C
Raw Normal View History

2024-11-06 16:53:50 -07:00
#ifndef BOX_H
#define BOX_H
#include <ostream>
/**
* @brief Stores the size of a Box
*
*/
class Box {
public: // we'll explain momentarily
/**
* @brief Construct a new Box object
* of unit dimensions
*
*/
Box(); // default constructor
/**
* @brief Construct a new Box object
* for given dimension. If dimension
* is not positive, defaults dimension to 1
*
* @param SIZE size of the Box
*/
Box(const double SIZE); // parameterized constructor
/**
* @brief Get the Size of the Box
*
* @return double current Box size
*/
double getBoxSize() const; // accessor - getter
/**
* @brief Set the Size only
* if positive
*
* @param SIZE size to set on Box
*/
void setBoxSize(const double SIZE);// mutator - setter
private:
/**
* @brief current Box size
*
*/
double _size;
};
std::ostream& operator<<(std::ostream&, const Box&);
#endif//BOX_H