bil::Device Class Reference

Models the topmost XDLRC entity. More...

#include <xdlrc/model/Device.hpp>

List of all members.

Public Member Functions
	Device ()
	Constructs a new Device instance.
std::string &	name ()
	Gets device name.
const std::string &	name () const
	Gets device name read only.
Tiles &	tiles ()
	Gets tiles.
const Tiles &	tiles () const
	Gets tiles read only.
unsigned	maxRowIndex () const
	Gets maximum row index found in all tiles.
unsigned	maxColumnIndex () const
	Gets maximum column index found in all tiles.
TileTypes &	tileTypes ()
	Gets tile types.
const TileTypes &	tileTypes () const
	Gets tile types read only.
PrimitiveTypes &	primitiveTypes ()
	Gets primitive types.
const PrimitiveTypes &	primitiveTypes () const
	Gets primitive types read only.
void	clear ()
	Resets all properties to default values.

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

---

Detailed Description

Models the topmost XDLRC entity.

XDLRC data is a hierarchical tree structure of distinct entities carrying data. The Device class models the root of this tree containing the Tiles, TileTypes, and PrimitiveTypes subtrees. The structure is mostly the same as found in an XDLRC file, with some adjustments for much less memory requirements and simpler traversal.

Definition at line 27 of file Device.hpp.

---

Constructor & Destructor Documentation

Device::Device

(

)

Constructs a new Device instance.

Definition at line 11 of file Device.cpp.

---

Member Function Documentation

std::string & Device::name

(

)

Gets device name.

Returns:

The name.

Definition at line 21 of file Device.cpp.

const std::string & Device::name

(

)

const

Gets device name read only.

Returns:

The name.

Definition at line 27 of file Device.cpp.

Tiles & Device::tiles

(

)

Gets tiles.

Returns:

The tiles.

Definition at line 33 of file Device.cpp.

const Tiles & Device::tiles

(

)

const

Gets tiles read only.

Returns:

The tiles.

Definition at line 39 of file Device.cpp.

unsigned Device::maxRowIndex

(

)

const

Gets maximum row index found in all tiles.

Returns:

The maximum row index.

Definition at line 45 of file Device.cpp.

unsigned Device::maxColumnIndex

(

)

const

Gets maximum column index found in all tiles.

Returns:

The maximum column index.

Definition at line 58 of file Device.cpp.

TileTypes & Device::tileTypes

(

)

Gets tile types.

Returns:

The tile types.

Definition at line 71 of file Device.cpp.

const TileTypes & Device::tileTypes

(

)

const

Gets tile types read only.

Returns:

The tile types.

Definition at line 77 of file Device.cpp.

PrimitiveTypes & Device::primitiveTypes

(

)

Gets primitive types.

Returns:

The primitive types.

Definition at line 83 of file Device.cpp.

const PrimitiveTypes & Device::primitiveTypes

(

)

const

Gets primitive types read only.

Returns:

The primitive types.

Definition at line 89 of file Device.cpp.

void Device::clear

(

)

Resets all properties to default values.

Definition at line 95 of file Device.cpp.

---

Friends And Related Function Documentation

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

friend

Writes data from a Device into a binary stream.

Parameters:

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

Exceptions:

.

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

friend

Reads data into a Device from a binary stream.

Parameters:

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

Exceptions:

.

---

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

• xdlrc/model/Device.hpp
• xdlrc/model/Device.cpp