torc::PhysicalDiff Class Reference

Diff utility class for comparing physical netlists. More...

#include <PhysicalDiff.hpp>

List of all members.

Public Member Functions
	PhysicalDiff (std::ostream &inOutStream)
bool	diff (const DesignSharedPtr &left, const DesignSharedPtr &right)
	Top level call to diff two designs.
Protected Types
typedef std::string	string
	Imported type name.
typedef torc::physical::DesignSharedPtr	DesignSharedPtr
	Imported type name.
typedef torc::physical::ModuleSharedPtr	ModuleSharedPtr
	Imported type name.
typedef std::vector < ModuleSharedPtr >	ModuleSharedPtrVector
	Imported type name.
typedef torc::physical::CircuitSharedPtr	CircuitSharedPtr
	Imported type name.
typedef torc::physical::InstanceSharedPtr	InstanceSharedPtr
	Imported type name.
typedef std::vector < InstanceSharedPtr >	InstanceSharedPtrVector
	Imported type name.
typedef torc::physical::NetSharedPtr	NetSharedPtr
	Imported type name.
typedef std::vector< NetSharedPtr >	NetSharedPtrVector
	Imported type name.
typedef torc::physical::Circuit::InstanceSharedPtrConstIterator	InstanceSharedPtrConstIterator
	Imported type name.
typedef torc::physical::Circuit::InstanceSharedPtrIterator	InstanceSharedPtrIterator
	Imported type name.
typedef torc::physical::Circuit::NetSharedPtrConstIterator	NetSharedPtrConstIterator
	Imported type name.
typedef torc::physical::Circuit::NetSharedPtrIterator	NetSharedPtrIterator
	Imported type name.
typedef torc::physical::InstanceWeakPtr	InstanceWeakPtr
	Imported type name.
typedef torc::physical::Design::ModuleSharedPtrConstIterator	ModuleSharedPtrConstIterator
	Imported type name.
typedef torc::physical::Design::ModuleSharedPtrIterator	ModuleSharedPtrIterator
	Imported type name.
typedef torc::physical::ConfigMap::const_iterator	ConfigMapConstIterator
	Imported type name.
typedef torc::physical::Net::InstancePinSharedPtrConstIterator	InstancePinSharedPtrConstIterator
	Imported type name.
typedef torc::physical::Net::PipConstIterator	PipConstIterator
	Imported type name.
typedef boost::shared_ptr < torc::physical::Named >	NamedSharedPtr
	Imported type name.
typedef boost::shared_ptr < torc::physical::ConfigMap >	ConfigMapSharedPtr
	Imported type name.
typedef torc::physical::Module::PortSharedPtrConstIterator	PortSharedPtrConstIterator
	Imported type name.
Protected Member Functions
bool	diffDesign (const DesignSharedPtr &left, const DesignSharedPtr &right)
	Diff design pointers and then recursively compare modules and inherited members.
bool	diffModule (const ModuleSharedPtr &left, const ModuleSharedPtr &right)
	Diff module pointers and then recursively compare inherited members from circuit.
bool	diffCircuit (const CircuitSharedPtr &left, const CircuitSharedPtr &right)
	Diff circuit pointers, recursively compare nets, instances and config map.
bool	diffConfigMap (const ConfigMapSharedPtr &left, const ConfigMapSharedPtr &right, const string &parentStr)
	Diff configuration information, this is called from circuits, instances and nets.
bool	diffInstance (const InstanceSharedPtr &left, const InstanceSharedPtr &right)
	Diff instance pointers and then the underlying config map.
bool	diffNet (const NetSharedPtr &left, const NetSharedPtr &right)
	Diff net pointers and then the underlying config map.
Protected Attributes
std::ostream &	mStream
	Output stream to use for comparison results.
Friends
class	utils::PhysicalDiffDesignUnitTest
	Unit test access to internal functions.
class	utils::PhysicalDiffModuleUnitTest
	Unit test access to internal functions.
class	utils::PhysicalDiffCircuitUnitTest
	Unit test access to internal functions.
class	utils::PhysicalDiffConfigMapUnitTest
	Unit test access to internal functions.
class	utils::PhysicalDiffInstanceUnitTest
	Unit test access to internal functions.
class	utils::PhysicalDiffNetUnitTest
	Unit test access to internal functions.

---

Detailed Description

Diff utility class for comparing physical netlists.

This class takes two design pointers and compares them.

Definition at line 42 of file PhysicalDiff.hpp.

---

Member Typedef Documentation

typedef std::string torc::PhysicalDiff::string [protected]

Imported type name.

Definition at line 57 of file PhysicalDiff.hpp.

typedef torc::physical::DesignSharedPtr torc::PhysicalDiff::DesignSharedPtr [protected]

Imported type name.

Definition at line 59 of file PhysicalDiff.hpp.

typedef torc::physical::ModuleSharedPtr torc::PhysicalDiff::ModuleSharedPtr [protected]

Imported type name.

Definition at line 61 of file PhysicalDiff.hpp.

typedef std::vector<ModuleSharedPtr> torc::PhysicalDiff::ModuleSharedPtrVector [protected]

Imported type name.

Definition at line 63 of file PhysicalDiff.hpp.

typedef torc::physical::CircuitSharedPtr torc::PhysicalDiff::CircuitSharedPtr [protected]

Imported type name.

Definition at line 65 of file PhysicalDiff.hpp.

typedef torc::physical::InstanceSharedPtr torc::PhysicalDiff::InstanceSharedPtr [protected]

Imported type name.

Definition at line 67 of file PhysicalDiff.hpp.

typedef std::vector<InstanceSharedPtr> torc::PhysicalDiff::InstanceSharedPtrVector [protected]

Imported type name.

Definition at line 69 of file PhysicalDiff.hpp.

typedef torc::physical::NetSharedPtr torc::PhysicalDiff::NetSharedPtr [protected]

Imported type name.

Definition at line 71 of file PhysicalDiff.hpp.

typedef std::vector<NetSharedPtr> torc::PhysicalDiff::NetSharedPtrVector [protected]

Imported type name.

Definition at line 73 of file PhysicalDiff.hpp.

typedef torc::physical::Circuit::InstanceSharedPtrConstIterator torc::PhysicalDiff::InstanceSharedPtrConstIterator [protected]

Imported type name.

Definition at line 75 of file PhysicalDiff.hpp.

typedef torc::physical::Circuit::InstanceSharedPtrIterator torc::PhysicalDiff::InstanceSharedPtrIterator [protected]

Imported type name.

Definition at line 77 of file PhysicalDiff.hpp.

typedef torc::physical::Circuit::NetSharedPtrConstIterator torc::PhysicalDiff::NetSharedPtrConstIterator [protected]

Imported type name.

Definition at line 79 of file PhysicalDiff.hpp.

typedef torc::physical::Circuit::NetSharedPtrIterator torc::PhysicalDiff::NetSharedPtrIterator [protected]

Imported type name.

Definition at line 81 of file PhysicalDiff.hpp.

typedef torc::physical::InstanceWeakPtr torc::PhysicalDiff::InstanceWeakPtr [protected]

Imported type name.

Definition at line 83 of file PhysicalDiff.hpp.

typedef torc::physical::Design::ModuleSharedPtrConstIterator torc::PhysicalDiff::ModuleSharedPtrConstIterator [protected]

Imported type name.

Definition at line 85 of file PhysicalDiff.hpp.

typedef torc::physical::Design::ModuleSharedPtrIterator torc::PhysicalDiff::ModuleSharedPtrIterator [protected]

Imported type name.

Definition at line 87 of file PhysicalDiff.hpp.

typedef torc::physical::ConfigMap::const_iterator torc::PhysicalDiff::ConfigMapConstIterator [protected]

Imported type name.

Definition at line 89 of file PhysicalDiff.hpp.

typedef torc::physical::Net::InstancePinSharedPtrConstIterator torc::PhysicalDiff::InstancePinSharedPtrConstIterator [protected]

Imported type name.

Definition at line 92 of file PhysicalDiff.hpp.

typedef torc::physical::Net::PipConstIterator torc::PhysicalDiff::PipConstIterator [protected]

Imported type name.

Definition at line 94 of file PhysicalDiff.hpp.

typedef boost::shared_ptr<torc::physical::Named> torc::PhysicalDiff::NamedSharedPtr [protected]

Imported type name.

Definition at line 96 of file PhysicalDiff.hpp.

typedef boost::shared_ptr<torc::physical::ConfigMap> torc::PhysicalDiff::ConfigMapSharedPtr [protected]

Imported type name.

Definition at line 98 of file PhysicalDiff.hpp.

typedef torc::physical::Module::PortSharedPtrConstIterator torc::PhysicalDiff::PortSharedPtrConstIterator [protected]

Imported type name.

Definition at line 100 of file PhysicalDiff.hpp.

---

Constructor & Destructor Documentation

torc::PhysicalDiff::PhysicalDiff

(

std::ostream &

inOutStream

)

[inline]

Todo:

Improve Pip comparison.

Todo:

Port comparison should use port name.

Todo:

Config sequence index is not used.

Todo:

Instance does not check the reference pointer.

Definition at line 110 of file PhysicalDiff.hpp.

---

Member Function Documentation

bool torc::PhysicalDiff::diff	(	const DesignSharedPtr &	left,
		const DesignSharedPtr &	right
	)			[inline]

Top level call to diff two designs.

Definition at line 120 of file PhysicalDiff.hpp.

bool torc::PhysicalDiff::diffDesign	(	const DesignSharedPtr &	left,
		const DesignSharedPtr &	right
	)			[inline, protected]

Diff design pointers and then recursively compare modules and inherited members.

Definition at line 125 of file PhysicalDiff.hpp.

bool torc::PhysicalDiff::diffModule	(	const ModuleSharedPtr &	left,
		const ModuleSharedPtr &	right
	)			[inline, protected]

Diff module pointers and then recursively compare inherited members from circuit.

Definition at line 195 of file PhysicalDiff.hpp.

bool torc::PhysicalDiff::diffCircuit	(	const CircuitSharedPtr &	left,
		const CircuitSharedPtr &	right
	)			[inline, protected]

Diff circuit pointers, recursively compare nets, instances and config map.

Definition at line 251 of file PhysicalDiff.hpp.

bool torc::PhysicalDiff::diffConfigMap	(	const ConfigMapSharedPtr &	left,
		const ConfigMapSharedPtr &	right,
		const string &	parentStr
	)			[inline, protected]

Diff configuration information, this is called from circuits, instances and nets.

Definition at line 330 of file PhysicalDiff.hpp.

bool torc::PhysicalDiff::diffInstance	(	const InstanceSharedPtr &	left,
		const InstanceSharedPtr &	right
	)			[inline, protected]

Diff instance pointers and then the underlying config map.

Definition at line 388 of file PhysicalDiff.hpp.

bool torc::PhysicalDiff::diffNet	(	const NetSharedPtr &	left,
		const NetSharedPtr &	right
	)			[inline, protected]

Diff net pointers and then the underlying config map.

Definition at line 418 of file PhysicalDiff.hpp.

---

Friends And Related Function Documentation

friend class utils::PhysicalDiffDesignUnitTest [friend]

Unit test access to internal functions.

Definition at line 44 of file PhysicalDiff.hpp.

friend class utils::PhysicalDiffModuleUnitTest [friend]

Unit test access to internal functions.

Definition at line 46 of file PhysicalDiff.hpp.

friend class utils::PhysicalDiffCircuitUnitTest [friend]

Unit test access to internal functions.

Definition at line 48 of file PhysicalDiff.hpp.

friend class utils::PhysicalDiffConfigMapUnitTest [friend]

Unit test access to internal functions.

Definition at line 50 of file PhysicalDiff.hpp.

friend class utils::PhysicalDiffInstanceUnitTest [friend]

Unit test access to internal functions.

Definition at line 52 of file PhysicalDiff.hpp.

friend class utils::PhysicalDiffNetUnitTest [friend]

Unit test access to internal functions.

Definition at line 54 of file PhysicalDiff.hpp.

---

Member Data Documentation

std::ostream& torc::PhysicalDiff::mStream [protected]

Output stream to use for comparison results.

Definition at line 103 of file PhysicalDiff.hpp.

---

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

• torc/utils/PhysicalDiff.hpp