bil::Tile Class Reference

Per instance data of tiles. More...

#include <xdlrc/model/Tile.hpp>

List of all members.

Public Member Functions
	Tile ()
	Constructs a new Tile instance.
std::string &	name ()
	Gets tile name.
const std::string &	name () const
	Gets tile name read only.
PrimitiveSites &	primitiveSites ()
	Gets primitive sites.
const PrimitiveSites &	primitiveSites () const
	Gets primitive sites read only.
void	row (unsigned short row)
	Sets tile row.
unsigned short	row () const
	Gets tile row.
void	column (unsigned short column)
	Sets tile column.
unsigned short	column () const
	Gets tile column.
void	siteX (unsigned short x)
	Sets site x-position.
unsigned short	siteX () const
	Gets site x-position.
void	siteY (unsigned short y)
	Sets site y-position.
unsigned short	siteY () const
	Gets site y-position.
void	typeIndex (unsigned short index)
	Sets index of TileType.
unsigned short	typeIndex () const
	Gets index of TileType.
void	clear ()
	Resets all properties to default values.

Friends
void	writeBinary (const Tile &data, std::ostream &outputStream)
	Writes data from a Tile into a binary stream.
void	readBinary (Tile &data, std::istream &inputStream)
	Reads data into a Tile from a binary stream.

---

Detailed Description

Per instance data of tiles.

The tile entity in XDLRC is broken up into two classes: Tile and TileType. The Tile class stores data belonging to a distinct tile. It contains its name, its primitive sites, its tile position, its site position, and its type index. The tile position determines a place on the regular 2D-grid of tiles the device is made of. Besides this there is another spatial ordering scheme called sites. Site are the rectangular areas on the FPGA, which are bounded by surrounding wire channels. They are not directly mentioned in XDLRC, but tile names carry the coordinates of their containing site. Every site includes a number of tiles of different types.

Definition at line 29 of file Tile.hpp.

---

Constructor & Destructor Documentation

Tile::Tile

(

)

Constructs a new Tile instance.

Definition at line 11 of file Tile.cpp.

---

Member Function Documentation

std::string & Tile::name

(

)

Gets tile name.

Returns:

The name.

Definition at line 24 of file Tile.cpp.

const std::string & Tile::name

(

)

const

Gets tile name read only.

Returns:

The name.

Definition at line 30 of file Tile.cpp.

PrimitiveSites & Tile::primitiveSites

(

)

Gets primitive sites.

Returns:

The sites.

Definition at line 36 of file Tile.cpp.

const PrimitiveSites & Tile::primitiveSites

(

)

const

Gets primitive sites read only.

Returns:

The sites.

Definition at line 42 of file Tile.cpp.

void Tile::row

(

unsigned short

row

)

Sets tile row.

Parameters:

row	The new row.

Definition at line 48 of file Tile.cpp.

unsigned short Tile::row

(

)

const

Gets tile row.

Returns:

The row.

Definition at line 54 of file Tile.cpp.

void Tile::column

(

unsigned short

column

)

Sets tile column.

Parameters:

column

The new column.

Definition at line 60 of file Tile.cpp.

unsigned short Tile::column

(

)

const

Gets tile column.

Returns:

The column.

Definition at line 66 of file Tile.cpp.

void Tile::siteX

(

unsigned short

x

)

Sets site x-position.

Parameters:

x	The new x-position.

Definition at line 72 of file Tile.cpp.

unsigned short Tile::siteX

(

)

const

Gets site x-position.

Returns:

The x-position.

Definition at line 78 of file Tile.cpp.

void Tile::siteY

(

unsigned short

y

)

Sets site y-position.

Parameters:

y	The new y-position.

Definition at line 84 of file Tile.cpp.

unsigned short Tile::siteY

(

)

const

Gets site y-position.

Returns:

The y-position.

Definition at line 90 of file Tile.cpp.

void Tile::typeIndex

(

unsigned short

index

)

Sets index of TileType.

Parameters:

index

Index of TileType in corresponding Device.

Definition at line 96 of file Tile.cpp.

unsigned short Tile::typeIndex

(

)

const

Gets index of TileType.

Returns:

Index of TileType in corresponding Device.

Definition at line 102 of file Tile.cpp.

void Tile::clear

(

)

Resets all properties to default values.

Definition at line 108 of file Tile.cpp.

---

Friends And Related Function Documentation

void writeBinary ( const Tile &  data, std::ostream &  outputStream  )

friend

Writes data from a Tile into a binary stream.

Parameters:

data	The Tile to write.
outputStream	The stream to write into.

Exceptions:

.

void readBinary ( Tile &  data, std::istream &  inputStream  )

friend

Reads data into a Tile from a binary stream.

Parameters:

data	The Tile to read into.
inputStream	The stream to read from.

Exceptions:

.

---

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

• xdlrc/model/Tile.hpp
• xdlrc/model/Tile.cpp