Floorplan class. More...
#include <floorplan.h>
Public Member Functions | |
point | chip_origin () const |
void | chip_origin (point chip_origin) |
point | chip_boundaries () const |
Chip boundaries getter. More... | |
void | chip_boundaries (point chip_boundaries) |
entity_system::entity | site_insert (std::string name, point dimensions) |
Inserts a new site. More... | |
void | site_destroy (entity_system::entity site) |
Destroys a site. More... | |
std::size_t | site_count () const |
Returns the number of sites. More... | |
std::string | site_name (entity_system::entity site) const |
Site name getter. More... | |
point | site_dimensions (entity_system::entity site) const |
Site dimensions getter. More... | |
const sites & | sites_properties () const |
Sites properties getter. More... | |
entity_system::entity | row_insert (entity_system::entity site, unsigned number_of_sites, point origin) |
Inserts a new row. More... | |
entity_system::entity | row_insert (std::string site, unsigned number_of_sites, point origin) |
void | row_destroy (entity_system::entity row) |
Destroys a row. More... | |
entity_system::entity | find_row (point point) |
Finds a row. More... | |
entity_system::entity | find_closest_row (point point) |
Finds closest row to a point. More... | |
std::size_t | row_count () const |
Returns the number of rows. More... | |
entity_system::entity | row_site (entity_system::entity row) const |
Row site getter. More... | |
unsigned | row_number_of_sites (entity_system::entity row) const |
Row number of sites getter. More... | |
point | row_origin (entity_system::entity row) const |
Row origin getter. More... | |
point | row_dimensions (entity_system::entity row) const |
Row dimensions getter. More... | |
const rows & | rows_properties () const |
Rows properties getter. More... | |
const entity_system::entity_system & | rows_system () const |
This class provides the basic floorplan interface, such as site and rows insertion, site and rows properties and circuit dimensions.
|
inline |
Returns the boundaries of the chip.
entity_system::entity ophidian::floorplan::floorplan::find_closest_row | ( | floorplan::point | point | ) |
Finds the row that is the closest to a given point.
point | Point to query for the row. |
entity_system::entity ophidian::floorplan::floorplan::find_row | ( | floorplan::point | point | ) |
Finds the row that contains a given point.
point | Point to query for the row. |
|
inline |
Returns the number of rows created in the rows system.
void ophidian::floorplan::floorplan::row_destroy | ( | entity_system::entity | row | ) |
Destroys an existing row.
row | Row to be destroyed. |
floorplan::point ophidian::floorplan::floorplan::row_dimensions | ( | entity_system::entity | row | ) | const |
Returns the dimensions of a row, calculated using the number of sites and site dimensions in that row.
row | Row entity to gets the dimensions. |
entity_system::entity ophidian::floorplan::floorplan::row_insert | ( | entity_system::entity | site, |
unsigned | number_of_sites, | ||
floorplan::point | origin | ||
) |
Inserts a new row in the floorplan. A row has a site, number of sites and origin.
site | Entity of the site of this row. |
number_of_sites | Number of sites which the row consists of. |
origin | Point describing the row origin. |
|
inline |
Returns the number of sites of a row.
row | Row entity to get the number of sites. |
|
inline |
Returns the origin of a row.
row | Row entity to get the origin. |
|
inline |
Returns the site of a row.
row | Row entity to get the site. |
|
inline |
Returns the object describing rows properties.
|
inline |
Returns the number of sites created in the sites system.
void ophidian::floorplan::floorplan::site_destroy | ( | entity_system::entity | site | ) |
Destroys an existing site.
site | Site to be destroyed. |
|
inline |
Returns the dimensions of a site.
site | Site entity to get the dimensions. |
entity_system::entity ophidian::floorplan::floorplan::site_insert | ( | std::string | name, |
floorplan::point | dimensions | ||
) |
Inserts a new site in the floorplan. A site has a name and dimensions associated to it.
name | Name of the site, used to identify it. |
dimensions | Point describing the site dimensions. |
|
inline |
Returns the name of a site.
site | Site entity to get the name. |
|
inline |
Returns the object describing sites properties.