bil::TileType Class Reference

Tile type data. More...

#include <xdlrc/model/TileType.hpp>

List of all members.

Public Member Functions
	TileType ()
	Constructs a new TileType instance.
std::string &	name ()
	Gets type name.
const std::string &	name () const
	Gets type name read only.
PrimitiveSiteTypes &	siteTypes ()
	Gets primitive site types.
const PrimitiveSiteTypes &	siteTypes () const
	Gets primitive site types read only.
Wires &	wires ()
	Gets all tile wires.
const Wires &	wires () const
	Gets all tile wires read only.
PIPs &	pips ()
	Gets all PIPs.
const PIPs &	pips () const
	Gets all PIPs read only.
void	tag (size_t t)
	Gets tag.
size_t	tag () const
	Gets tag.
void	clear ()
	Resets all properties to default values.

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

---

Detailed Description

Tile type data.

The tile entity in XDLRC is broken up into two classes: Tile and TileType. The TileType class stores common data of tiles belonging to a distinct type. This drastically decreases memory requirements, since the common data is stored once in a TileType instance, instead storing them over and over in every Tile instance.

Definition at line 27 of file TileType.hpp.

---

Constructor & Destructor Documentation

TileType::TileType

(

)

Constructs a new TileType instance.

Definition at line 11 of file TileType.cpp.

---

Member Function Documentation

std::string & TileType::name

(

)

Gets type name.

Returns:

The type name.

Definition at line 22 of file TileType.cpp.

const std::string & TileType::name

(

)

const

Gets type name read only.

Returns:

The type name.

Definition at line 28 of file TileType.cpp.

PrimitiveSiteTypes & TileType::siteTypes

(

)

Gets primitive site types.

Returns:

The primitive site types.

Definition at line 34 of file TileType.cpp.

const PrimitiveSiteTypes & TileType::siteTypes

(

)

const

Gets primitive site types read only.

Returns:

The primitive site types.

Definition at line 40 of file TileType.cpp.

Wires & TileType::wires

(

)

Gets all tile wires.

Returns:

The wires.

Definition at line 46 of file TileType.cpp.

const Wires & TileType::wires

(

)

const

Gets all tile wires read only.

Returns:

The wires.

Definition at line 52 of file TileType.cpp.

PIPs & TileType::pips

(

)

Gets all PIPs.

Returns:

The PIPs.

Definition at line 58 of file TileType.cpp.

const PIPs & TileType::pips

(

)

const

Gets all PIPs read only.

Returns:

The PIPs.

Definition at line 64 of file TileType.cpp.

void TileType::tag

(

size_t

t

)

Gets tag.

Parameters:

t

The tag.

Definition at line 70 of file TileType.cpp.

size_t TileType::tag

(

)

const

Gets tag.

Returns:

The tag.

Definition at line 76 of file TileType.cpp.

void TileType::clear

(

)

Resets all properties to default values.

Definition at line 82 of file TileType.cpp.

---

Friends And Related Function Documentation

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

friend

Writes data from a TileType into a binary stream.

Parameters:

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

Exceptions:

.

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

friend

Reads data into a TileType from a binary stream.

Parameters:

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

Exceptions:

.

---

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

• xdlrc/model/TileType.hpp
• xdlrc/model/TileType.cpp