bil::Wire Class Reference

Describes a wire. More...

#include <xdlrc/model/Wire.hpp>

List of all members.

Public Member Functions
	Wire ()
	Constructs a new Wire instance.
std::string &	name ()
	Gets wire name.
const std::string &	name () const
	Gets wire name read only.
WireConnections &	connections ()
	Gets connections to other wires.
const WireConnections &	connections () const
	Gets connections to other wires read only.
void	clear ()
	Resets all properties to default values.

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

---

Detailed Description

Describes a wire.

A wire is located on a tile. It has got a name, and a list of connections (to other wires on the same or on other tiles).

Definition at line 23 of file Wire.hpp.

---

Constructor & Destructor Documentation

Wire::Wire

(

)

Constructs a new Wire instance.

Definition at line 11 of file Wire.cpp.

---

Member Function Documentation

std::string & Wire::name

(

)

Gets wire name.

Returns:

The name.

Definition at line 19 of file Wire.cpp.

const std::string & Wire::name

(

)

const

Gets wire name read only.

Returns:

The name.

Definition at line 25 of file Wire.cpp.

WireConnections & Wire::connections

(

)

Gets connections to other wires.

Returns:

The connections.

Definition at line 31 of file Wire.cpp.

const WireConnections & Wire::connections

(

)

const

Gets connections to other wires read only.

Returns:

The connections.

Definition at line 37 of file Wire.cpp.

void Wire::clear

(

)

Resets all properties to default values.

Definition at line 43 of file Wire.cpp.

---

Friends And Related Function Documentation

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

friend

Writes data from a Wire into a binary stream.

Parameters:

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

Exceptions:

.

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

friend

Reads data into a Wire from a binary stream.

Parameters:

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

Exceptions:

.

---

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

• xdlrc/model/Wire.hpp
• xdlrc/model/Wire.cpp