ophidian::floorplan::rows Class Reference

Rows class. More...

#include <rows.h>

Public Member Functions
	rows (entity_system::entity_system &system)
	Constructor. More...
entity_system::entity	site (entity_system::entity row) const
	Site getter. More...
unsigned	number_of_sites (entity_system::entity row) const
	Number of sites getter. More...
point	origin (entity_system::entity row) const
	Row origin getter. More...
std::pair< std::vector < entity_system::entity > ::const_iterator, std::vector < entity_system::entity > ::const_iterator >	sites () const
	Sites iterator getter. More...
std::pair< std::vector < unsigned >::const_iterator, std::vector< unsigned > ::const_iterator >	number_of_sites () const
	Number of sites iterator getter. More...
std::pair< std::vector< point > ::const_iterator, std::vector < point >::const_iterator >	origins () const
	Origins iterator getter. More...
void	site (entity_system::entity row, entity_system::entity site)
	Site setter. More...
void	number_of_sites (entity_system::entity row, unsigned number_of_sites)
	Number of sites setter. More...
void	origin (entity_system::entity row, point origin)
	Origin setter. More...

Detailed Description

This class describes the properties of rows initialized by the floorplan module.

Constructor & Destructor Documentation

ophidian::floorplan::rows::rows

(

entity_system::entity_system &

system

)

Rows object constructor. Register the rows properties to the rows system.

Parameters

system

Rows entity system.

Member Function Documentation

unsigned ophidian::floorplan::rows::number_of_sites ( entity_system::entity  row ) const

inline

Returns the number of sites in a row.

Parameters

row	Row entity to get the number of sites.

Returns

Number of sites of the row.

std::pair< std::vector<unsigned>::const_iterator, std::vector<unsigned>::const_iterator > ophidian::floorplan::rows::number_of_sites ( ) const

inline

Returns the begin and end iterator of the row number of sites property.

Returns

Pair with constant iterators pointing the the beginning and end of the number of sites property.

void ophidian::floorplan::rows::number_of_sites	(	entity_system::entity	row,
		unsigned	number_of_sites
	)

Sets the number of sites of a row.

Parameters

row	Row entity to set the number of sites.
number_of_sites	Number of sites to set.

point ophidian::floorplan::rows::origin ( entity_system::entity  row ) const

inline

Returns the origin of a row.

Parameters

row	Row entity to get the origin.

Returns

Point describing the row origin.

void ophidian::floorplan::rows::origin	(	entity_system::entity	row,
		rows::point	origin
	)

Sets the origin of a row.

Parameters

row	Row entity to set the origin.
origin	Origin to set.

std::pair< std::vector<point>::const_iterator, std::vector<point>::const_iterator > ophidian::floorplan::rows::origins ( ) const

inline

Returns the begin and end iterator of the row origins property.

Returns

Pair with constant iterators pointing the the beginning and end of the origins property.

entity_system::entity ophidian::floorplan::rows::site ( entity_system::entity  row ) const

inline

Returns the site composing a row.

Parameters

row	Row entity to get the site.

Returns

Site entity.

void ophidian::floorplan::rows::site	(	entity_system::entity	row,
		entity_system::entity	site
	)

Sets the site of a row.

Parameters

row	Row entity to set the site.
site	Site entity to set.

std::pair< std::vector<entity_system::entity>::const_iterator, std::vector<entity_system::entity>::const_iterator > ophidian::floorplan::rows::sites ( ) const

inline

Returns the begin and end iterator of the row sites property.

Returns

Pair with constant iterators pointing the the beginning and end of the sites property.

---

The documentation for this class was generated from the following files:

• /home/csguth/workspace/openeda/src/floorplan/rows.h
• /home/csguth/workspace/openeda/src/floorplan/rows.cpp