#include <PrjSubobjects.hpp>
Public Member Functions | |
Constructors and Destructors | |
Icon () | |
Create a new object with default values. More... | |
Icon (int icon, int col, int row, int nr) | |
Create a new object. More... | |
Icon (const Icon &other) | |
Create a new object from another object. More... | |
~Icon () | |
Destroy the object. More... | |
Operators | |
Icon & | operator= (const Icon &other) |
Copy operator. More... | |
bool | operator== (const Icon &other) const |
Equality operator. More... | |
bool | operator!= (const Icon &other) const |
Inequality operator. More... | |
Input and Output | |
void | read (Reader &input) |
Read an object from a Reader. More... | |
std::string | write () |
Write the object to a string. More... | |
Getters and Setters | |
int | icon () const |
Returns the icon type - see 'special symbols' in contam.h. More... | |
void | setIcon (const int icon) |
Sets the icon type - see 'special symbols' in contam.h. More... | |
int | col () const |
Returns the icon's column position on the SketchPad. More... | |
void | setCol (const int col) |
Sets the icon's column position on the SketchPad. More... | |
int | row () const |
Returns the icon's row position on the SketchPad. More... | |
void | setRow (const int row) |
Sets the icon's row position on the SketchPad. More... | |
int | nr () const |
Returns the icon's zone, path, duct, etc., number. More... | |
void | setNr (const int nr) |
Sets the icon's zone, path, duct, etc., number. More... | |
Miscellaneous Functions | |
bool | isWall () |
Returns true if the icon is a wall icon. More... | |
The Icon object contains basic information about sketchpad icons.
This object is not strictly necessary for creating CONTAM models, but is needed to read models created in ContamW.
openstudio::contam::Icon::Icon | ( | ) |
Create a new object with default values.
openstudio::contam::Icon::Icon | ( | int | icon, |
int | col, | ||
int | row, | ||
int | nr | ||
) |
Create a new object.
openstudio::contam::Icon::Icon | ( | const Icon & | other | ) |
Create a new object from another object.
openstudio::contam::Icon::~Icon | ( | ) |
Destroy the object.
int openstudio::contam::Icon::col | ( | ) | const |
Returns the icon's column position on the SketchPad.
int openstudio::contam::Icon::icon | ( | ) | const |
Returns the icon type - see 'special symbols' in contam.h.
bool openstudio::contam::Icon::isWall | ( | ) |
Returns true if the icon is a wall icon.
int openstudio::contam::Icon::nr | ( | ) | const |
Returns the icon's zone, path, duct, etc., number.
bool openstudio::contam::Icon::operator!= | ( | const Icon & | other | ) | const |
Inequality operator.
bool openstudio::contam::Icon::operator== | ( | const Icon & | other | ) | const |
Equality operator.
int openstudio::contam::Icon::row | ( | ) | const |
Returns the icon's row position on the SketchPad.
void openstudio::contam::Icon::setCol | ( | const int | col | ) |
Sets the icon's column position on the SketchPad.
void openstudio::contam::Icon::setIcon | ( | const int | icon | ) |
Sets the icon type - see 'special symbols' in contam.h.
void openstudio::contam::Icon::setNr | ( | const int | nr | ) |
Sets the icon's zone, path, duct, etc., number.
void openstudio::contam::Icon::setRow | ( | const int | row | ) |
Sets the icon's row position on the SketchPad.
std::string openstudio::contam::Icon::write | ( | ) |
Write the object to a string.