clsWire Class Reference

object of the class is utilized to store information about single wire (physical connection) between two interface components More...

#include <model.h>

Public Member Functions
	clsWire (string fm, string fp, int fb, string tm, string tp, int tb, bool orig=true)
	constructor
	~clsWire ()
bool	operator< (clsWire const &c) const
	destructor
bool	operator!= (clsWire const &c) const
	definition of the '!=' operator over class objects
bool	operator* (clsWire const &c) const
	definition of the '*' operator over class objects
void	setOrig (bool v)
	sets originality flag of the object to v value
bool	getOrig () const
	gets value of object's originality flag
Data Fields
string	from_module
	module the wire starts in (from-module)
string	from_port
	port's module the wire starts in (from-port)
int	from_bit
	port's bit the wire starts in (from-bit)
string	to_module
	module the wire ends in (to-module)
string	to_port
	port's module the wire ends in (to-port)
int	to_bit
	port's bit the wire ends in (to-bit)
string	from_composed
	composed name in the form from_module.from_port.from_bit
string	to_composed
	composed name in the form to_module.to_port.to_bit
string	composed
	composed name in the form from_composed.to_composed
bool	orig
	originality flag of the wire. Set to true for wires originally present in the design

---

Detailed Description

object of the class is utilized to store information about single wire (physical connection) between two interface components

wires are read from a file whose name must be specified by means of tool's command line parameters (see tool's help to -i command line parameter). Each circuit within the design is assigned an independent set of the class objects (stored in clsCircuit::setOfWires set). Wires are stored at bit-level, so information about interconnection is stored for each two bits which are connected.

---

Constructor & Destructor Documentation

clsWire::clsWire	(	string	fm,
		string	fp,
		int	fb,
		string	tm,
		string	tp,
		int	tb,
		bool	orig = true
	)

constructor

Parameters:

[in]	fm	from-module
[in]	fp	from-port
[in]	fb	from-bit
[in]	tm	to-module
[in]	tp	to-port
[in]	tb	to-bit
[in]	orig	originality flag (implicitly set to true)

clsWire::~clsWire

(

)

[inline]

---

Member Function Documentation

bool clsWire::operator<

(

clsWire const &

c

)

const [inline]

destructor

definition of the '<' operator over class objects

bool clsWire::operator!=

(

clsWire const &

c

)

const [inline]

definition of the '!=' operator over class objects

bool clsWire::operator*

(

clsWire const &

c

)

const [inline]

definition of the '*' operator over class objects

void clsWire::setOrig

(

bool

v

)

[inline]

sets originality flag of the object to v value

bool clsWire::getOrig

(

)

const [inline]

gets value of object's originality flag

---

Field Documentation

string clsWire::from_module

module the wire starts in (from-module)

string clsWire::from_port

port's module the wire starts in (from-port)

int clsWire::from_bit

port's bit the wire starts in (from-bit)

string clsWire::to_module

module the wire ends in (to-module)

string clsWire::to_port

port's module the wire ends in (to-port)

int clsWire::to_bit

port's bit the wire ends in (to-bit)

string clsWire::from_composed

composed name in the form from_module.from_port.from_bit

string clsWire::to_composed

composed name in the form to_module.to_port.to_bit

string clsWire::composed

composed name in the form from_composed.to_composed

bool clsWire::orig

originality flag of the wire. Set to true for wires originally present in the design

---

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

• model.h
• model.cc