torc::generic Namespace Reference

Namespace for the Torc generic netlist, including EDIF and BLIF importers and exporters. More...

Namespaces
	_impl
	generic

Data Structures
class	Apply
	This class is used within simulate to describe input stimuli and expected responces over a certain time interval. More...
class	Bundle
	Represents a "bundle" in the EDIF sense. More...
class	BundleFlattener
	Flatten a bundle to bits. More...
class	Cell
	Represents an EDIF cell. More...
class	Cloneable
	Represents all EOM classes that can be cloned(copied). More...
class	Commentable
	Represents all classes that can hold user comments. More...
class	Composite
	Interface for objects that can be composed within each other. More...
class	Connectable
	An object that is connectable to a Net. More...
class	ConnectionHandler
class	Design
class	Decompiler
class	Driver
class	EdifContext
class	EdifParser
	The Top level parser for parsing EDIF files. More...
class	Linker
	Represents a repository of unresolved usage references. More...
class	location
	Abstract a location. More...
class	ObjectVisitor
class	Parser
	A Bison parser. More...
struct	NameData
struct	ArrayData
struct	ViewRefData
struct	CellRefData
struct	LogicRefData
struct	InstanceRefData
struct	PortRefData
struct	NetRefData
struct	PortInstData
struct	PortListData
struct	VersionData
struct	ValueData
struct	PairData
struct	PairStrData
struct	ParamAssignInfo
struct	InstanceInfo
struct	LogicListData
class	ParserOptions
class	position
	Abstract a position. More...
class	Scanner
class	stack
class	slice
	Present a slice of the top of a stack. More...
struct	EdifVersion
class	Error
	The Error object thrown by different methods of EdifOM. More...
class	Event
	Event is used to describe an event on a port or a net using logic state transitions. Events can also be described for unordered groups of ports or nets using portGroup or netGroup. An ordered list of ports may also be used using a portList. More...
class	Extern
	Used to implement external object referencing. More...
class	FactoryType
	A placeholder for a factory method. More...
class	ForbiddenEvent
	ForbiddenEvent class lists events which are forbidden during a period of times which is specified by time interval. Time interval is used to describe an interval between two times. Times can be described by events or offset events. More...
class	Instance
	Represents an instantiation of a cell view in the view of another cell. More...
class	InstanceArray
	Represents an array of instances. More...
class	InstanceArrayMember
	Represents a member of an instance array. More...
class	InterfaceAttributes
	Represents attributes of a view interface. More...
class	InterfaceJoinedInfo
	Represents the Interface joining information. More...
struct	IndexFinder
class	Library
	An EDIF cell library. More...
class	LogicalResponse
	This class is used to model logicInput/logicOutput construct. This class holds information of logical response to be expected from a ports during simulation. More...
class	LogicElement
	Represents different logic elements which holds array of logic values. More...
class	LogicValue
	This class is used within simulationInfo construct to define a logic value to use for modeling in the logicModel view. More...
class	LogicValueAttributes
	This class is used within simulationInfo construct to define a logic value to use for modeling. More...
class	Message
class	MessageTable
class	Nameable
	An object that has a name. More...
class	Net
	Represents an EDIF Net. More...
class	NetAttributes
	Represents attributes of a Net object. More...
class	NetBundle
	Represents a bundle of nets. More...
class	NetDelay
	Represents the netDelay attribute of Net. More...
class	ObjectFactory
class	VisitNet
class	Parameter
	Represents a parameter object in EDIF. More...
class	ParameterArray
	Represents a parameter array. More...
class	ParameterArrayElement
class	ParameterMap
class	ParentedObject
	An object that has a parent. More...
class	PathDelay
	This class associates a delay with a specified chain of events. Delay contains the time from first event to final event. More...
class	Permutable
	Permutable is used to describe a relationship in which ports are interchangeable. More...
class	Port
	Interface for an EDIF port object. More...
class	PortAttributes
	Represents attributes of a Port or PortReference object. More...
class	PortBundle
	Represents a bundle of ports. More...
class	PortBundleReference
	Represents a reference to a bundle of ports. More...
class	PortDelay
	Represents the portDelay attribute on Port or PortReference. More...
class	PortElement
	Represents port element like port or port reference. More...
class	PortList
	Represents an ordered list of port references. More...
class	PortListAlias
	Represents an ordered list of port references with a name aliased. More...
class	PortRefCreator
	Create port reference. More...
class	PortReference
	Represents the usable instance of a port of a cell in another cell. More...
class	Property
class	PropertyContainer
	Represents objects that have properties. More...
class	Renamable
	Represents objects that can be renamed. More...
class	Root
	Root of the EDIF Object Model. More...
class	Scalar
	A single object with no child objects. More...
class	ScalarNet
	Represents a standalone net. More...
class	ScalarPort
	Represents a standalone port. More...
class	ScalarPortReference
	Represents areference to a standalone port. More...
class	ScaleFactor
class	SelfReferencing
class	Simulate
	This class is to model simulate construct which is a named collection of simulation stimulus and responses statements and is used in the interface and contents of views. More...
class	SimulationInfo
	This class is used to hold all information about the logic values used within a library. More...
class	SingleInstance
	Represents a single instance of the view of a cell. More...
class	SingleParameter
class	Status
	Represents EDIF status construct. More...
class	StatusContainer
	Represents objects that have status. More...
class	SymTab
	A symbol table. More...
class	TimeStamp
	Represents the time in Universal Time Coordinate (year, month, day, hour, minute, second) More...
class	Timing
	This class is used to provide a set of path delays or timing constrains (forbidden events) More...
class	UserDataContainer
	Represents class that can hold userData. More...
class	Value
class	Vector
	An array of objects. More...
class	VectorBit
	Represents a single element of a vector composition. More...
class	VectorNet
	Represents a net array. More...
class	VectorNetBit
	Represents a bit of a net array. More...
class	VectorPort
	Represents a port array. More...
class	VectorPortBit
	Represents a bit of a port. More...
class	VectorPortBitReference
	Represents a reference to a bit of a port. More...
class	VectorPortReference
	Represents a reference to a port array. More...
class	TemporaryAssignment
	Template class that stores the current value of a variable and restores that value when this object goes out of scope. More...
class	VerilogExporter
	Exporter from a generic netlist into structural verilog. More...
class	VerilogExporterVisitor
	Generic netlist object visitor for output as structural Verilog. More...
class	VerilogImporter
	Importer from structural verilog format into a generic design. More...
class	VerilogImporterVisitor
	AST visitor to convert structural Verilog into a generic design. More...
class	VerilogNames
	Encapsulation of library names used for Verilog importing and exporting. More...
class	View
	Represents and EDIF View. More...
class	Visitable
	An object that receives an inoutVisitor. More...
class	VisitorApplier
class	BaseVisitor
	A base class for Visitor. More...
class	VisitorType
	An acyclic inoutVisitor implementation. More...
class	WaveValue
	This class is used within simulate to describe input stimuli and expected responces over a certain time interval. More...
class	Written
	Represents an information container relating to the writer of the EDIF file. More...
class	EdifImporter
class	EdifExporter

Typedefs
typedef boost::shared_ptr < EdifContext >	EdifContextSharedPtr
typedef boost::weak_ptr < EdifContext >	EdifContextWeakPtr
typedef boost::shared_ptr< Linker >	LinkerSharedPtr
typedef boost::weak_ptr< Linker >	LinkerWeakPtr
typedef boost::function < std::string(const std::string &inParentInstanceName, const NetSharedPtr &inNet, const std::vector< size_t > &inIndicesVector)>	NetNamingFunction
	Function to create net names during flattening. More...
typedef boost::function < std::string(const std::string &inParentInstanceName, const InstanceSharedPtr &inInstance, const std::vector< size_t > &inIndicesVector)>	InstanceNamingFunction
	Function to create instance names during flattening. More...
typedef boost::function < std::string(const InstanceSharedPtr &inParentInstance, const NetSharedPtr &inNet, const std::vector< size_t > &inIndicesVector)>	NetRenamingFunction
	Function to create names of nets that are set in rename constructs. More...
typedef boost::function < std::string(const InstanceSharedPtr &inParentInstance, const InstanceSharedPtr &inInstance, const std::vector< size_t > &inIndicesVector)>	InstanceRenamingFunction
	Function to create names of nets that are set in rename constructs. More...
typedef size_t	ParameterContext
typedef boost::shared_ptr< Apply >	ApplySharedPtr
typedef boost::weak_ptr< Apply >	ApplyWeakPtr
typedef boost::shared_ptr< Cell >	CellSharedPtr
typedef boost::weak_ptr< Cell >	CellWeakPtr
typedef boost::shared_ptr< Design >	DesignSharedPtr
typedef boost::weak_ptr< Design >	DesignWeakPtr
typedef boost::shared_ptr< Error >	ErrorSharedPtr
typedef boost::weak_ptr< Error >	ErrorWeakPtr
typedef boost::shared_ptr< Event >	EventSharedPtr
typedef boost::weak_ptr< Event >	EventWeakPtr
typedef boost::shared_ptr < ForbiddenEvent >	ForbiddenEventSharedPtr
typedef boost::weak_ptr < ForbiddenEvent >	ForbiddenEventWeakPtr
typedef boost::shared_ptr< View >	ViewSharedPtr
typedef boost::weak_ptr< View >	ViewWeakPtr
typedef boost::shared_ptr< Root >	RootSharedPtr
typedef boost::weak_ptr< Root >	RootWeakPtr
typedef boost::shared_ptr < Library >	LibrarySharedPtr
typedef boost::weak_ptr< Library >	LibraryWeakPtr
typedef boost::shared_ptr < LogicValueAttributes >	LogicValueAttributesSharedPtr
typedef boost::weak_ptr < LogicValueAttributes >	LogicValueAttributesWeakPtr
typedef boost::shared_ptr < LogicValue >	LogicValueSharedPtr
typedef boost::weak_ptr < LogicValue >	LogicValueWeakPtr
typedef boost::shared_ptr < LogicElement >	LogicElementSharedPtr
typedef boost::weak_ptr < LogicElement >	LogicElementWeakPtr
typedef boost::shared_ptr < LogicalResponse >	LogicalResponseSharedPtr
typedef boost::weak_ptr < LogicalResponse >	LogicalResponseWeakPtr
typedef boost::shared_ptr < Instance >	InstanceSharedPtr
typedef boost::weak_ptr< Instance >	InstanceWeakPtr
typedef boost::shared_ptr < SingleInstance >	SingleInstanceSharedPtr
typedef boost::weak_ptr < SingleInstance >	SingleInstanceWeakPtr
typedef boost::shared_ptr < InstanceArray >	InstanceArraySharedPtr
typedef boost::weak_ptr < InstanceArray >	InstanceArrayWeakPtr
typedef boost::shared_ptr < InstanceArrayMember >	InstanceArrayMemberSharedPtr
typedef boost::weak_ptr < InstanceArrayMember >	InstanceArrayMemberWeakPtr
typedef boost::shared_ptr < InterfaceAttributes >	InterfaceAttributesSharedPtr
typedef boost::weak_ptr < InterfaceAttributes >	InterfaceAttributesWeakPtr
typedef boost::shared_ptr< Net >	NetSharedPtr
typedef boost::weak_ptr< Net >	NetWeakPtr
typedef boost::shared_ptr < NetAttributes >	NetAttributesSharedPtr
typedef boost::weak_ptr < NetAttributes >	NetAttributesWeakPtr
typedef boost::shared_ptr < NetReference >	NetReferenceSharedPtr
typedef boost::weak_ptr < NetReference >	NetReferenceWeakPtr
typedef boost::shared_ptr < ScalarNet >	ScalarNetSharedPtr
typedef boost::weak_ptr < ScalarNet >	ScalarNetWeakPtr
typedef boost::shared_ptr < VectorNet >	VectorNetSharedPtr
typedef boost::weak_ptr < VectorNet >	VectorNetWeakPtr
typedef boost::shared_ptr < VectorNetBit >	VectorNetBitSharedPtr
typedef boost::weak_ptr < VectorNetBit >	VectorNetBitWeakPtr
typedef boost::shared_ptr < NetBundle >	NetBundleSharedPtr
typedef boost::weak_ptr < NetBundle >	NetBundleWeakPtr
typedef boost::shared_ptr < ObjectFactory >	ObjectFactorySharedPtr
typedef boost::weak_ptr < ObjectFactory >	ObjectFactoryWeakPtr
typedef boost::shared_ptr < PathDelay >	PathDelaySharedPtr
typedef boost::weak_ptr < PathDelay >	PathDelayWeakPtr
typedef boost::shared_ptr < Permutable >	PermutableSharedPtr
typedef boost::weak_ptr < Permutable >	PermutableWeakPtr
typedef boost::shared_ptr< Port >	PortSharedPtr
typedef boost::weak_ptr< Port >	PortWeakPtr
typedef boost::shared_ptr < PortElement >	PortElementSharedPtr
typedef boost::weak_ptr < PortElement >	PortElementWeakPtr
typedef boost::shared_ptr < PortList >	PortListSharedPtr
typedef boost::weak_ptr< PortList >	PortListWeakPtr
typedef boost::shared_ptr < PortListAlias >	PortListAliasSharedPtr
typedef boost::weak_ptr < PortListAlias >	PortListAliasWeakPtr
typedef boost::shared_ptr < PortAttributes >	PortAttributesSharedPtr
typedef boost::weak_ptr < PortAttributes >	PortAttributesWeakPtr
typedef boost::shared_ptr < PortBundle >	PortBundleSharedPtr
typedef boost::weak_ptr < PortBundle >	PortBundleWeakPtr
typedef boost::shared_ptr < PortBundleReference >	PortBundleReferenceSharedPtr
typedef boost::weak_ptr < PortBundleReference >	PortBundleReferenceWeakPtr
typedef boost::shared_ptr < PortReference >	PortReferenceSharedPtr
typedef boost::weak_ptr < PortReference >	PortReferenceWeakPtr
typedef boost::shared_ptr < Parameter >	ParameterSharedPtr
typedef boost::weak_ptr < Parameter >	ParameterWeakPtr
typedef boost::shared_ptr < SingleParameter >	SingleParameterSharedPtr
typedef boost::weak_ptr < SingleParameter >	SingleParameterWeakPtr
typedef boost::shared_ptr < SimulationInfo >	SimulationInfoSharedPtr
typedef boost::weak_ptr < SimulationInfo >	SimulationInfoWeakPtr
typedef boost::shared_ptr < Simulate >	SimulateSharedPtr
typedef boost::weak_ptr< Simulate >	SimulateWeakPtr
typedef boost::shared_ptr < ParameterArray >	ParameterArraySharedPtr
typedef boost::weak_ptr < ParameterArray >	ParameterArrayWeakPtr
typedef boost::shared_ptr < ParameterArrayElement >	ParameterArrayElementSharedPtr
typedef boost::weak_ptr < ParameterArrayElement >	ParameterArrayElementWeakPtr
typedef boost::shared_ptr < ParameterMap >	ParameterMapSharedPtr
typedef boost::weak_ptr < ParameterMap >	ParameterMapWeakPtr
typedef boost::shared_ptr < Property >	PropertySharedPtr
typedef boost::weak_ptr< Property >	PropertyWeakPtr
typedef boost::shared_ptr < PropertyContainer >	PropertyContainerSharedPtr
typedef boost::weak_ptr < PropertyContainer >	PropertyContainerWeakPtr
typedef boost::shared_ptr < ScalarPort >	ScalarPortSharedPtr
typedef boost::weak_ptr < ScalarPort >	ScalarPortWeakPtr
typedef boost::shared_ptr < ScalarPortReference >	ScalarPortReferenceSharedPtr
typedef boost::weak_ptr < ScalarPortReference >	ScalarPortReferenceWeakPtr
typedef boost::shared_ptr< Timing >	TimingSharedPtr
typedef boost::weak_ptr< Timing >	TimingWeakPtr
typedef boost::shared_ptr < VectorPort >	VectorPortSharedPtr
typedef boost::weak_ptr < VectorPort >	VectorPortWeakPtr
typedef boost::shared_ptr < VectorPortReference >	VectorPortReferenceSharedPtr
typedef boost::weak_ptr < VectorPortReference >	VectorPortReferenceWeakPtr
typedef boost::shared_ptr < VectorPortBit >	VectorPortBitSharedPtr
typedef boost::shared_ptr < VectorPortBit >	VectorPortBitWeakPtr
typedef boost::shared_ptr < VectorPortBitReference >	VectorPortBitReferenceSharedPtr
typedef boost::shared_ptr < VectorPortBitReference >	VectorPortBitReferenceWeakPtr
typedef boost::shared_ptr < UserDataContainer >	UserDataContainerSharedPtr
typedef boost::weak_ptr < UserDataContainer >	UserDataContainerWeakPtr
typedef boost::shared_ptr< Status >	StatusSharedPtr
typedef boost::weak_ptr< Status >	StatusWeakPtr
typedef boost::shared_ptr < StatusContainer >	StatusContainerSharedPtr
typedef boost::weak_ptr < StatusContainer >	StatusContainerWeakPtr
typedef boost::shared_ptr < WaveValue >	WaveValueSharedPtr
typedef boost::weak_ptr < WaveValue >	WaveValueWeakPtr
typedef boost::shared_ptr < Written >	WrittenSharedPtr
typedef boost::weak_ptr< Written >	WrittenWeakPtr
typedef boost::shared_ptr < InterfaceJoinedInfo >	InterfaceJoinedInfoSharedPtr
typedef boost::weak_ptr < InterfaceJoinedInfo >	InterfaceJoinedInfoWeakPtr
typedef EPortDirection	PortDirection
typedef std::map < CellSharedPtr, int >	CellUsageMap
	A map from cell shared pointer to usage count. More...

Enumerations
enum	CompositionType { eCompositionTypeScalar, eCompositionTypeVector, eCompositionTypeVectorBit, eCompositionTypeBundle }
	Defines possible Composition types. More...
enum	Derivation { eDerivationUndefined, eDerivationCalculated, eDerivationMeasured, eDerivationRequired }
enum	EdifLevel { eEdifLevel0 = 0, eEdifLevel1, eEdifLevel2 }
enum	MessageId {   eMessageIdErrorArrayIndexSizeMismatch, eMessageIdErrorArrayIndexOutOfBounds, eMessageIdErrorEmptyArray, eMessageIdErrorNullChildfactory,   eMessageIdErrorEmptyItemName, eMessageIdErrorItemAlreadyExists, eMessageIdErrorItemNotFound, eMessageIdErrorPointerToItemDoesNotExist,   eMessageIdErrorItemSizeMismatch, eMessageIdErrorConnectionInvalid, eMessageIdErrorTypeCast, eMessageIdErrorValueNotSet,   eMessageIdErrorCompositionTypeMismatch, eMessageIdParserError, eMessageIdParserWarning, eMessageIdErrorNullPointer,   eMessageIdErrorUnsupoortedOperation }
enum	MessageSeverity { eMessageSeveritySuppressed, eMessageSeverityInfo, eMessageSeverityWarning, eMessageSeverityError }
enum	EPortDirection { ePortDirectionIn = 0, ePortDirectionOut, ePortDirectionInOut, ePortDirectionUndefined }
enum	Unit {   eUnitUndefined, eUnitAngle, eUnitCapacitance, eUnitConductance,   eUnitCharge, eUnitCurrent, eUnitDistance, eUnitEnergy,   eUnitFlux, eUnitFrequency, eUnitInductance, eUnitMass,   eUnitPower, eUnitResistance, eUnitTemperature, eUnitTime,   eUnitVoltage }

Functions
void	copyParams (const Instance &inOriginal, const InstanceSharedPtr &outCloned, const ObjectFactorySharedPtr &inFactory)
template<typename _Tp >
boost::shared_ptr< _Tp >	clone (const boost::shared_ptr< _Tp > &inPointer, const ObjectFactorySharedPtr &inFactory) throw (Error)
template<typename _Tp >
boost::shared_ptr< _Tp >	cloneJoinedInfo (const boost::shared_ptr< _Tp > &inPointer, const ObjectFactorySharedPtr &inFactory, const ViewSharedPtr &inView) throw (Error)
template<typename _Tp >
boost::shared_ptr< _Tp >	clonePermutable (const boost::shared_ptr< _Tp > &inPointer, const ObjectFactorySharedPtr &inFactory, const ViewSharedPtr &inView) throw (Error)
const location	operator+ (const location &begin, const location &end)
	Join two location objects to create a location. More...
const location	operator+ (const location &begin, unsigned int width)
	Add two location objects. More...
location &	operator+= (location &res, unsigned int width)
	Add and assign a location. More...
bool	operator== (const location &loc1, const location &loc2)
	Compare two location objects. More...
bool	operator!= (const location &loc1, const location &loc2)
	Compare two location objects. More...
std::ostream &	operator<< (std::ostream &ostr, const location &loc)
	Intercept output stream redirection. More...
const position &	operator+= (position &res, const int width)
	Add and assign a position. More...
const position	operator+ (const position &begin, const int width)
	Add two position objects. More...
const position &	operator-= (position &res, const int width)
	Add and assign a position. More...
const position	operator- (const position &begin, const int width)
	Add two position objects. More...
bool	operator== (const position &pos1, const position &pos2)
	Compare two position objects. More...
bool	operator!= (const position &pos1, const position &pos2)
	Compare two position objects. More...
std::ostream &	operator<< (std::ostream &ostr, const position &pos)
	Intercept output stream redirection. More...
template<typename _Pointer >
std::string	getModifiedName (const std::string &inInstName, const _Pointer &inNameable, const std::vector< size_t > &inIndicesVector=std::vector< size_t >())
template<typename _Pointer >
std::string	getRenamedName (const InstanceSharedPtr &inParentInstance, const _Pointer &inRenamable, const std::vector< size_t > &inIndicesVector=std::vector< size_t >())
void	flatten (const InstanceSharedPtr &inInstance, const ObjectFactorySharedPtr &inFactory, bool inRecursive, const std::string &inSeparator, const InstanceRenamingFunction &inInstanceRenameFunc, const NetRenamingFunction &inNetRenameFunc, const InstanceNamingFunction &inInstanceNameFunc, const NetNamingFunction &inNetNameFunc) throw (Error)
void	flatten (const ViewSharedPtr &inView, const ObjectFactorySharedPtr &inFactory, bool inRecursive, const std::string &inSeparator, const InstanceRenamingFunction &inInstanceRenameFunc, const NetRenamingFunction &inNetRenameFunc, const InstanceNamingFunction &inInstanceNameFunc, const NetNamingFunction &inNetNameFunc) throw (Error)
void	flatten (const DesignSharedPtr &inDesign, const ObjectFactorySharedPtr &inFactory, bool inRecursive, const std::string &inSeparator, const InstanceRenamingFunction &inInstanceRenameFunc, const NetRenamingFunction &inNetRenameFunc, const InstanceNamingFunction &inInstanceNameFunc, const NetNamingFunction &inNetNameFunc) throw (Error)
template std::string	getModifiedName (const std::string &inInstName, const NetSharedPtr &inNameable, const std::vector< size_t > &inIndicesVector)
template std::string	getModifiedName (const std::string &inInstName, const InstanceSharedPtr &inNameable, const std::vector< size_t > &inIndicesVector)
template std::string	getRenamedName (const InstanceSharedPtr &inParentInstance, const NetSharedPtr &inRenamable, const std::vector< size_t > &inIndicesVector)
template std::string	getRenamedName (const InstanceSharedPtr &inParentInstance, const InstanceSharedPtr &inRenamable, const std::vector< size_t > &inIndicesVector)
template<typename _Connectable >
void	findLeafConnectable (std::vector< std::string > &nestedNames, boost::shared_ptr< _Connectable > &conn) throw (Error)
template<typename _Connectable >
void	connectNetToElement (const std::vector< size_t > &inIndices, const boost::shared_ptr< _Connectable > &inConn, const NetSharedPtr &inNet) throw (Error)
void	openLogFile (const std::string &logFileName)
void	log (const char *fmt,...)
	BOOST_AUTO_TEST_CASE (Om1UnitTest)
	Unit test for the generic object model. More...
void	collectCells (ViewSharedPtr &inViewPtr, CellUsageMap &inoutCellUsageMap)
	Recursively collect and count all cells used in the given view. The CellUsageMap must already be initialized with all expected cell counts set to zero. More...
void	prune (RootSharedPtr &inRootPtr)
	Prune all unused cells and libraries from the given root. More...
	BOOST_AUTO_TEST_CASE (ValueUnitTest)
	Unit test for the Value class. More...
	BOOST_AUTO_TEST_CASE (VerilogExporterUnitTest)
	Unit test for the VerilogExporter class. More...
	BOOST_AUTO_TEST_CASE (VerilogImporterUnitTest)
	Unit test for the VerilogImporter class. More...
template<class T >
std::string	compositionTypeString (const T &inPtr)
template<typename _Tp >
void	runVisitor (_Tp &inoutVisited, BaseVisitor &inoutVisitor) throw (Error)

Detailed Description

Namespace for the Torc generic netlist, including EDIF and BLIF importers and exporters.

Typedef Documentation

typedef boost::shared_ptr<Apply> torc::generic::ApplySharedPtr

Definition at line 26 of file PointerTypes.hpp.

typedef boost::weak_ptr<Apply> torc::generic::ApplyWeakPtr

Definition at line 28 of file PointerTypes.hpp.

typedef boost::shared_ptr<Cell> torc::generic::CellSharedPtr

Definition at line 30 of file PointerTypes.hpp.

typedef std::map<CellSharedPtr, int> torc::generic::CellUsageMap

A map from cell shared pointer to usage count.

Definition at line 28 of file Pruning.hpp.

typedef boost::weak_ptr<Cell> torc::generic::CellWeakPtr

Definition at line 32 of file PointerTypes.hpp.

typedef boost::shared_ptr<Design> torc::generic::DesignSharedPtr

Definition at line 34 of file PointerTypes.hpp.

typedef boost::weak_ptr<Design> torc::generic::DesignWeakPtr

Definition at line 36 of file PointerTypes.hpp.

typedef boost::shared_ptr<EdifContext> torc::generic::EdifContextSharedPtr

Definition at line 26 of file ParserPointerTypes.hpp.

typedef boost::weak_ptr<EdifContext> torc::generic::EdifContextWeakPtr

Definition at line 28 of file ParserPointerTypes.hpp.

typedef boost::shared_ptr<Error> torc::generic::ErrorSharedPtr

Definition at line 38 of file PointerTypes.hpp.

typedef boost::weak_ptr<Error> torc::generic::ErrorWeakPtr

Definition at line 40 of file PointerTypes.hpp.

typedef boost::shared_ptr<Event> torc::generic::EventSharedPtr

Definition at line 42 of file PointerTypes.hpp.

typedef boost::weak_ptr<Event> torc::generic::EventWeakPtr

Definition at line 44 of file PointerTypes.hpp.

typedef boost::shared_ptr<ForbiddenEvent> torc::generic::ForbiddenEventSharedPtr

Definition at line 46 of file PointerTypes.hpp.

typedef boost::weak_ptr<ForbiddenEvent> torc::generic::ForbiddenEventWeakPtr

Definition at line 48 of file PointerTypes.hpp.

typedef boost::shared_ptr<InstanceArrayMember> torc::generic::InstanceArrayMemberSharedPtr

Definition at line 90 of file PointerTypes.hpp.

typedef boost::weak_ptr<InstanceArrayMember> torc::generic::InstanceArrayMemberWeakPtr

Definition at line 92 of file PointerTypes.hpp.

typedef boost::shared_ptr< InstanceArray > torc::generic::InstanceArraySharedPtr

Definition at line 86 of file PointerTypes.hpp.

typedef boost::weak_ptr< InstanceArray > torc::generic::InstanceArrayWeakPtr

Definition at line 88 of file PointerTypes.hpp.

torc::generic::InstanceNamingFunction

Function to create instance names during flattening.

Definition at line 47 of file Flattening.hpp.

torc::generic::InstanceRenamingFunction

Function to create names of nets that are set in rename constructs.

Definition at line 62 of file Flattening.hpp.

typedef boost::shared_ptr<Instance> torc::generic::InstanceSharedPtr

Definition at line 78 of file PointerTypes.hpp.

typedef boost::weak_ptr<Instance> torc::generic::InstanceWeakPtr

Definition at line 80 of file PointerTypes.hpp.

typedef boost::shared_ptr<InterfaceAttributes> torc::generic::InterfaceAttributesSharedPtr

Definition at line 94 of file PointerTypes.hpp.

typedef boost::weak_ptr<InterfaceAttributes> torc::generic::InterfaceAttributesWeakPtr

Definition at line 96 of file PointerTypes.hpp.

typedef boost::shared_ptr<InterfaceJoinedInfo> torc::generic::InterfaceJoinedInfoSharedPtr

Definition at line 278 of file PointerTypes.hpp.

typedef boost::weak_ptr<InterfaceJoinedInfo> torc::generic::InterfaceJoinedInfoWeakPtr

Definition at line 280 of file PointerTypes.hpp.

typedef boost::shared_ptr<Library> torc::generic::LibrarySharedPtr

Definition at line 58 of file PointerTypes.hpp.

typedef boost::weak_ptr<Library> torc::generic::LibraryWeakPtr

Definition at line 60 of file PointerTypes.hpp.

typedef boost::shared_ptr<Linker> torc::generic::LinkerSharedPtr

Definition at line 30 of file ParserPointerTypes.hpp.

typedef boost::weak_ptr<Linker> torc::generic::LinkerWeakPtr

Definition at line 32 of file ParserPointerTypes.hpp.

typedef boost::shared_ptr<LogicalResponse> torc::generic::LogicalResponseSharedPtr

Definition at line 74 of file PointerTypes.hpp.

typedef boost::weak_ptr<LogicalResponse> torc::generic::LogicalResponseWeakPtr

Definition at line 76 of file PointerTypes.hpp.

typedef boost::shared_ptr<LogicElement> torc::generic::LogicElementSharedPtr

Definition at line 70 of file PointerTypes.hpp.

typedef boost::weak_ptr<LogicElement> torc::generic::LogicElementWeakPtr

Definition at line 72 of file PointerTypes.hpp.

typedef boost::shared_ptr<LogicValueAttributes> torc::generic::LogicValueAttributesSharedPtr

Definition at line 62 of file PointerTypes.hpp.

typedef boost::weak_ptr<LogicValueAttributes> torc::generic::LogicValueAttributesWeakPtr

Definition at line 64 of file PointerTypes.hpp.

typedef boost::shared_ptr<LogicValue> torc::generic::LogicValueSharedPtr

Definition at line 66 of file PointerTypes.hpp.

typedef boost::weak_ptr<LogicValue> torc::generic::LogicValueWeakPtr

Definition at line 68 of file PointerTypes.hpp.

typedef boost::shared_ptr<NetAttributes> torc::generic::NetAttributesSharedPtr

Definition at line 102 of file PointerTypes.hpp.

typedef boost::weak_ptr<NetAttributes> torc::generic::NetAttributesWeakPtr

Definition at line 104 of file PointerTypes.hpp.

typedef boost::shared_ptr<NetBundle> torc::generic::NetBundleSharedPtr

Definition at line 122 of file PointerTypes.hpp.

typedef boost::weak_ptr<NetBundle> torc::generic::NetBundleWeakPtr

Definition at line 124 of file PointerTypes.hpp.

torc::generic::NetNamingFunction

Function to create net names during flattening.

Definition at line 39 of file Flattening.hpp.

typedef boost::shared_ptr<NetReference> torc::generic::NetReferenceSharedPtr

Definition at line 106 of file PointerTypes.hpp.

typedef boost::weak_ptr<NetReference> torc::generic::NetReferenceWeakPtr

Definition at line 108 of file PointerTypes.hpp.

torc::generic::NetRenamingFunction

Function to create names of nets that are set in rename constructs.

Definition at line 54 of file Flattening.hpp.

typedef boost::shared_ptr<Net> torc::generic::NetSharedPtr

Definition at line 98 of file PointerTypes.hpp.

typedef boost::weak_ptr<Net> torc::generic::NetWeakPtr

Definition at line 100 of file PointerTypes.hpp.

typedef boost::shared_ptr<ObjectFactory> torc::generic::ObjectFactorySharedPtr

Definition at line 126 of file PointerTypes.hpp.

typedef boost::weak_ptr<ObjectFactory> torc::generic::ObjectFactoryWeakPtr

Definition at line 128 of file PointerTypes.hpp.

typedef boost::shared_ptr<ParameterArrayElement> torc::generic::ParameterArrayElementSharedPtr

Definition at line 190 of file PointerTypes.hpp.

typedef boost::weak_ptr<ParameterArrayElement> torc::generic::ParameterArrayElementWeakPtr

Definition at line 192 of file PointerTypes.hpp.

typedef boost::shared_ptr< ParameterArray > torc::generic::ParameterArraySharedPtr

Definition at line 186 of file PointerTypes.hpp.

typedef boost::weak_ptr< ParameterArray > torc::generic::ParameterArrayWeakPtr

Definition at line 188 of file PointerTypes.hpp.

typedef size_t torc::generic::ParameterContext

Definition at line 24 of file ParameterContext.hpp.

typedef boost::shared_ptr<ParameterMap> torc::generic::ParameterMapSharedPtr

Definition at line 194 of file PointerTypes.hpp.

typedef boost::weak_ptr<ParameterMap> torc::generic::ParameterMapWeakPtr

Definition at line 196 of file PointerTypes.hpp.

typedef boost::shared_ptr<Parameter> torc::generic::ParameterSharedPtr

Definition at line 170 of file PointerTypes.hpp.

typedef boost::weak_ptr<Parameter> torc::generic::ParameterWeakPtr

Definition at line 172 of file PointerTypes.hpp.

typedef boost::shared_ptr<PathDelay> torc::generic::PathDelaySharedPtr

Definition at line 130 of file PointerTypes.hpp.

typedef boost::weak_ptr<PathDelay> torc::generic::PathDelayWeakPtr

Definition at line 132 of file PointerTypes.hpp.

typedef boost::shared_ptr<Permutable> torc::generic::PermutableSharedPtr

Definition at line 134 of file PointerTypes.hpp.

typedef boost::weak_ptr<Permutable> torc::generic::PermutableWeakPtr

Definition at line 136 of file PointerTypes.hpp.

typedef boost::shared_ptr<PortAttributes> torc::generic::PortAttributesSharedPtr

Definition at line 154 of file PointerTypes.hpp.

typedef boost::weak_ptr<PortAttributes> torc::generic::PortAttributesWeakPtr

Definition at line 156 of file PointerTypes.hpp.

typedef boost::shared_ptr<PortBundleReference> torc::generic::PortBundleReferenceSharedPtr

Definition at line 162 of file PointerTypes.hpp.

typedef boost::weak_ptr<PortBundleReference> torc::generic::PortBundleReferenceWeakPtr

Definition at line 164 of file PointerTypes.hpp.

typedef boost::shared_ptr<PortBundle> torc::generic::PortBundleSharedPtr

Definition at line 158 of file PointerTypes.hpp.

typedef boost::weak_ptr<PortBundle> torc::generic::PortBundleWeakPtr

Definition at line 160 of file PointerTypes.hpp.

typedef EPortDirection torc::generic::PortDirection

Deprecated:

Definition at line 32 of file PortDirection.hpp.

typedef boost::shared_ptr<PortElement> torc::generic::PortElementSharedPtr

Definition at line 142 of file PointerTypes.hpp.

typedef boost::weak_ptr<PortElement> torc::generic::PortElementWeakPtr

Definition at line 144 of file PointerTypes.hpp.

typedef boost::shared_ptr<PortListAlias> torc::generic::PortListAliasSharedPtr

Definition at line 150 of file PointerTypes.hpp.

typedef boost::weak_ptr<PortListAlias> torc::generic::PortListAliasWeakPtr

Definition at line 152 of file PointerTypes.hpp.

typedef boost::shared_ptr<PortList> torc::generic::PortListSharedPtr

Definition at line 146 of file PointerTypes.hpp.

typedef boost::weak_ptr<PortList> torc::generic::PortListWeakPtr

Definition at line 148 of file PointerTypes.hpp.

typedef boost::shared_ptr<PortReference> torc::generic::PortReferenceSharedPtr

Definition at line 166 of file PointerTypes.hpp.

typedef boost::weak_ptr<PortReference> torc::generic::PortReferenceWeakPtr

Definition at line 168 of file PointerTypes.hpp.

typedef boost::shared_ptr<Port> torc::generic::PortSharedPtr

Definition at line 138 of file PointerTypes.hpp.

typedef boost::weak_ptr<Port> torc::generic::PortWeakPtr

Definition at line 140 of file PointerTypes.hpp.

typedef boost::shared_ptr<PropertyContainer> torc::generic::PropertyContainerSharedPtr

Definition at line 202 of file PointerTypes.hpp.

typedef boost::weak_ptr<PropertyContainer> torc::generic::PropertyContainerWeakPtr

Definition at line 204 of file PointerTypes.hpp.

typedef boost::shared_ptr<Property> torc::generic::PropertySharedPtr

Definition at line 198 of file PointerTypes.hpp.

typedef boost::weak_ptr<Property> torc::generic::PropertyWeakPtr

Definition at line 200 of file PointerTypes.hpp.

typedef boost::shared_ptr<Root> torc::generic::RootSharedPtr

Definition at line 54 of file PointerTypes.hpp.

typedef boost::weak_ptr<Root> torc::generic::RootWeakPtr

Definition at line 56 of file PointerTypes.hpp.

typedef boost::shared_ptr< ScalarNet > torc::generic::ScalarNetSharedPtr

Definition at line 110 of file PointerTypes.hpp.

typedef boost::weak_ptr< ScalarNet > torc::generic::ScalarNetWeakPtr

Definition at line 112 of file PointerTypes.hpp.

typedef boost::shared_ptr<ScalarPortReference> torc::generic::ScalarPortReferenceSharedPtr

Definition at line 214 of file PointerTypes.hpp.

typedef boost::weak_ptr<ScalarPortReference> torc::generic::ScalarPortReferenceWeakPtr

Definition at line 216 of file PointerTypes.hpp.

typedef boost::shared_ptr<ScalarPort> torc::generic::ScalarPortSharedPtr

Definition at line 210 of file PointerTypes.hpp.

typedef boost::weak_ptr<ScalarPort> torc::generic::ScalarPortWeakPtr

Definition at line 212 of file PointerTypes.hpp.

typedef boost::shared_ptr<Simulate> torc::generic::SimulateSharedPtr

Definition at line 182 of file PointerTypes.hpp.

typedef boost::weak_ptr<Simulate> torc::generic::SimulateWeakPtr

Definition at line 184 of file PointerTypes.hpp.

typedef boost::shared_ptr<SimulationInfo> torc::generic::SimulationInfoSharedPtr

Definition at line 178 of file PointerTypes.hpp.

typedef boost::weak_ptr<SimulationInfo> torc::generic::SimulationInfoWeakPtr

Definition at line 180 of file PointerTypes.hpp.

typedef boost::shared_ptr< SingleInstance > torc::generic::SingleInstanceSharedPtr

Definition at line 82 of file PointerTypes.hpp.

typedef boost::weak_ptr< SingleInstance > torc::generic::SingleInstanceWeakPtr

Definition at line 84 of file PointerTypes.hpp.

typedef boost::shared_ptr< SingleParameter > torc::generic::SingleParameterSharedPtr

Definition at line 174 of file PointerTypes.hpp.

typedef boost::weak_ptr< SingleParameter > torc::generic::SingleParameterWeakPtr

Definition at line 176 of file PointerTypes.hpp.

typedef boost::shared_ptr<StatusContainer> torc::generic::StatusContainerSharedPtr

Definition at line 266 of file PointerTypes.hpp.

typedef boost::weak_ptr<StatusContainer> torc::generic::StatusContainerWeakPtr

Definition at line 268 of file PointerTypes.hpp.

typedef boost::shared_ptr<Status> torc::generic::StatusSharedPtr

Definition at line 262 of file PointerTypes.hpp.

typedef boost::weak_ptr<Status> torc::generic::StatusWeakPtr

Definition at line 264 of file PointerTypes.hpp.

typedef boost::shared_ptr<Timing> torc::generic::TimingSharedPtr

Definition at line 226 of file PointerTypes.hpp.

typedef boost::weak_ptr<Timing> torc::generic::TimingWeakPtr

Definition at line 228 of file PointerTypes.hpp.

typedef boost::shared_ptr<UserDataContainer> torc::generic::UserDataContainerSharedPtr

Definition at line 258 of file PointerTypes.hpp.

typedef boost::weak_ptr<UserDataContainer> torc::generic::UserDataContainerWeakPtr

Definition at line 260 of file PointerTypes.hpp.

typedef boost::shared_ptr<VectorNetBit> torc::generic::VectorNetBitSharedPtr

Definition at line 118 of file PointerTypes.hpp.

typedef boost::weak_ptr<VectorNetBit> torc::generic::VectorNetBitWeakPtr

Definition at line 120 of file PointerTypes.hpp.

typedef boost::shared_ptr< VectorNet > torc::generic::VectorNetSharedPtr

Definition at line 114 of file PointerTypes.hpp.

typedef boost::weak_ptr< VectorNet > torc::generic::VectorNetWeakPtr

Definition at line 116 of file PointerTypes.hpp.

typedef boost::shared_ptr<VectorPortBitReference> torc::generic::VectorPortBitReferenceSharedPtr

Definition at line 254 of file PointerTypes.hpp.

typedef boost::shared_ptr<VectorPortBitReference> torc::generic::VectorPortBitReferenceWeakPtr

Definition at line 256 of file PointerTypes.hpp.

typedef boost::shared_ptr<VectorPortBit> torc::generic::VectorPortBitSharedPtr

Definition at line 250 of file PointerTypes.hpp.

typedef boost::shared_ptr<VectorPortBit> torc::generic::VectorPortBitWeakPtr

Definition at line 252 of file PointerTypes.hpp.

typedef boost::shared_ptr<VectorPortReference> torc::generic::VectorPortReferenceSharedPtr

Definition at line 238 of file PointerTypes.hpp.

typedef boost::weak_ptr<VectorPortReference> torc::generic::VectorPortReferenceWeakPtr

Definition at line 240 of file PointerTypes.hpp.

typedef boost::shared_ptr<VectorPort> torc::generic::VectorPortSharedPtr

Definition at line 234 of file PointerTypes.hpp.

typedef boost::weak_ptr<VectorPort> torc::generic::VectorPortWeakPtr

Definition at line 236 of file PointerTypes.hpp.

typedef boost::shared_ptr<View> torc::generic::ViewSharedPtr

Definition at line 50 of file PointerTypes.hpp.

typedef boost::weak_ptr<View> torc::generic::ViewWeakPtr

Definition at line 52 of file PointerTypes.hpp.

typedef boost::shared_ptr<WaveValue> torc::generic::WaveValueSharedPtr

Definition at line 270 of file PointerTypes.hpp.

typedef boost::weak_ptr<WaveValue> torc::generic::WaveValueWeakPtr

Definition at line 272 of file PointerTypes.hpp.

typedef boost::shared_ptr<Written> torc::generic::WrittenSharedPtr

Definition at line 274 of file PointerTypes.hpp.

typedef boost::weak_ptr<Written> torc::generic::WrittenWeakPtr

Definition at line 276 of file PointerTypes.hpp.

Enumeration Type Documentation

enum torc::generic::CompositionType

Defines possible Composition types.

Used in composite objects, this type indicates whether an object is a Scalar, a Vector, a bit of a vector (VectorBit) or a Bundle

Enumerator
eCompositionTypeScalar
eCompositionTypeVector
eCompositionTypeVectorBit
eCompositionTypeBundle

Definition at line 35 of file CompositionType.hpp.

                     {
    eCompositionTypeScalar, eCompositionTypeVector, eCompositionTypeVectorBit,
    eCompositionTypeBundle

};

enum torc::generic::Derivation

Type. Types of possible derivation. It identify the classification of timing information being provided.

Enumerator
eDerivationUndefined
eDerivationCalculated
eDerivationMeasured
eDerivationRequired

Definition at line 27 of file Derivation.hpp.

                {
    eDerivationUndefined, eDerivationCalculated, eDerivationMeasured, eDerivationRequired

};

enum torc::generic::EdifLevel

enums corresponding to EDIF levels 0,1 and 2.

Enumerator
eEdifLevel0
eEdifLevel1
eEdifLevel2

Definition at line 26 of file EdifLevel.hpp.

               {
    eEdifLevel0 = 0, eEdifLevel1, eEdifLevel2
};

enum torc::generic::EPortDirection

Direction of the ports

Enumerator
ePortDirectionIn
ePortDirectionOut
ePortDirectionInOut
ePortDirectionUndefined

Definition at line 26 of file PortDirection.hpp.

                    {
    ePortDirectionIn = 0, ePortDirectionOut, ePortDirectionInOut, ePortDirectionUndefined
};

enum torc::generic::MessageId

Each element of this enumeration denote a message in the system.

Enumerator
eMessageIdErrorArrayIndexSizeMismatch
eMessageIdErrorArrayIndexOutOfBounds
eMessageIdErrorEmptyArray
eMessageIdErrorNullChildfactory
eMessageIdErrorEmptyItemName
eMessageIdErrorItemAlreadyExists
eMessageIdErrorItemNotFound
eMessageIdErrorPointerToItemDoesNotExist
eMessageIdErrorItemSizeMismatch
eMessageIdErrorConnectionInvalid
eMessageIdErrorTypeCast
eMessageIdErrorValueNotSet
eMessageIdErrorCompositionTypeMismatch
eMessageIdParserError
eMessageIdParserWarning
eMessageIdErrorNullPointer
eMessageIdErrorUnsupoortedOperation

Definition at line 27 of file MessageId.hpp.

               {
    eMessageIdErrorArrayIndexSizeMismatch, eMessageIdErrorArrayIndexOutOfBounds,
    eMessageIdErrorEmptyArray, eMessageIdErrorNullChildfactory, eMessageIdErrorEmptyItemName,
    eMessageIdErrorItemAlreadyExists, eMessageIdErrorItemNotFound,
    eMessageIdErrorPointerToItemDoesNotExist, eMessageIdErrorItemSizeMismatch,
    eMessageIdErrorConnectionInvalid, eMessageIdErrorTypeCast, eMessageIdErrorValueNotSet,
    eMessageIdErrorCompositionTypeMismatch, eMessageIdParserError, eMessageIdParserWarning,
    eMessageIdErrorNullPointer, eMessageIdErrorUnsupoortedOperation
};

enum torc::generic::MessageSeverity

This type defines the severity of the message, i.e., whether it's an error, warning or an info message or it is suppressed.

Enumerator
eMessageSeveritySuppressed
eMessageSeverityInfo
eMessageSeverityWarning
eMessageSeverityError

Definition at line 27 of file MessageSeverity.hpp.

                     {
    eMessageSeveritySuppressed, eMessageSeverityInfo, eMessageSeverityWarning, eMessageSeverityError
};

enum torc::generic::Unit

Represents the different units defined in EDIF.

Enumerator
eUnitUndefined
eUnitAngle
eUnitCapacitance
eUnitConductance
eUnitCharge
eUnitCurrent
eUnitDistance
eUnitEnergy
eUnitFlux
eUnitFrequency
eUnitInductance
eUnitMass
eUnitPower
eUnitResistance
eUnitTemperature
eUnitTime
eUnitVoltage

Definition at line 27 of file Unit.hpp.

          {
    eUnitUndefined, eUnitAngle, eUnitCapacitance, eUnitConductance, eUnitCharge, eUnitCurrent,
    eUnitDistance, eUnitEnergy, eUnitFlux, eUnitFrequency, eUnitInductance, eUnitMass, eUnitPower,
    eUnitResistance, eUnitTemperature, eUnitTime, eUnitVoltage
};

Function Documentation

torc::generic::BOOST_AUTO_TEST_CASE

(

ValueUnitTest

)

Unit test for the Value class.

Definition at line 28 of file ValueUnitTest.cpp.

                                    {
    // functions not tested:
    //      Value::MiNoMax::MiNoMax();
    //      Value::MiNoMax::MiNoMax(Value::Number inMin, Value::Number inNominal, Value::Number inMax);
    //      Value::MiNoMax::~MiNoMax();
    //      Value::MiNoMax::MiNoMax(const Value::MiNoMax& inSource);
    //      Value::MiNoMax& Value::MiNoMax::operator=(const Value::MiNoMax& inSource);
    //      bool Value::MiNoMax::operator <(const Value::MiNoMax& inRhs) const;
    //      bool Value::MiNoMax::operator ==(const Value::MiNoMax& inRhs) const;
    //      bool Value::MiNoMax::operator >(const Value::MiNoMax& inRhs) const;
    //      bool Value::MiNoMax::operator >=(const Value::MiNoMax& inRhs) const;
    //      bool Value::MiNoMax::operator <=(const Value::MiNoMax& inRhs) const;
    //      bool Value::MiNoMax::operator !=(const Value::MiNoMax& inRhs) const;
    //      void Value::MiNoMax::setMax(const Value::Number& inSource);
    //      void Value::MiNoMax::setMin(const Value::Number& inSource);
    //      void Value::MiNoMax::setNominal(const Value::Number& inSource);
    //      Value::Number::Number();
    //      Value::Number::Number(int32_t inMantissa, int32_t inExponent);
    //      Value::Number::~Number();
    //      Value::Number::Number(const Value::Number& inSource);
    //      Value::Number& Value::Number::operator=(const Value::Number& inSource);
    //      bool Value::Number::operator <(const Value::Number& inRhs) const;
    //      bool Value::Number::operator ==(const Value::Number& inRhs) const;
    //      bool Value::Number::operator >(const Value::Number& inRhs) const;
    //      bool Value::Number::operator >=(const Value::Number& inRhs) const;
    //      bool Value::Number::operator <=(const Value::Number& inRhs) const;
    //      bool Value::Number::operator !=(const Value::Number& inRhs) const;
    //      void Value::Number::setMantissa(const int32_t& inSource);
    //      void Value::Number::setExponent(const int32_t& inSource);
    //      Value::Point::Point();
    //      Value::Point::Point(int32_t inX, int32_t inY);
    //      Value::Point::~Point();
    //      Value::Point::Point(const Value::Point& inSource);
    //      Value::Point& Value::Point::operator=(const Value::Point& inSource);
    //      bool Value::Point::operator <(const Value::Point& inRhs) const;
    //      bool Value::Point::operator ==(const Value::Point& inRhs) const;
    //      bool Value::Point::operator >(const Value::Point& inRhs) const;
    //      bool Value::Point::operator >=(const Value::Point& inRhs) const;
    //      bool Value::Point::operator <=(const Value::Point& inRhs) const;
    //      bool Value::Point::operator !=(const Value::Point& inRhs) const;
    //      void Value::Point::setX(const int32_t& inSource);
    //      void Value::Point::setY(const int32_t& inSource);
    //      Value::Value();
    //      Value::Value(Value::Type type);
    //      Value::~Value();
    //      Value::Value(const Value& inSource);
    //      Value& Value::operator=(const Value& inSource);
    //      void Value::setType(const Value::Type& inSource);
    //      void Value::setIsSet(const bool& inSource);
    //      template <class Archive> void Value::serialize(Archive& ar, unsigned int);
    //      template void Value::serialize<boost::archive::binary_iarchive>(
    //          boost::archive::binary_iarchive& ar, const unsigned int);
    //      template void Value::serialize<boost::archive::binary_oarchive>(
    //          boost::archive::binary_oarchive& ar, const unsigned int);

    // functions tested:
    //      Value::Number::Number(int32_t inMantissa, int32_t inExponent);
    //      double Value::Number::eval() const;
    Value::Number number(2, 2);
    BOOST_CHECK_EQUAL(number.eval(), 200); // for SourceForge bug 3587203.
}

Here is the call graph for this function:

torc::generic::BOOST_AUTO_TEST_CASE

(

VerilogExporterUnitTest

)

Unit test for the VerilogExporter class.

Definition at line 30 of file VerilogExporterUnitTest.cpp.

                                              {

}

torc::generic::BOOST_AUTO_TEST_CASE

(

VerilogImporterUnitTest

)

Unit test for the VerilogImporter class.

Definition at line 30 of file VerilogImporterUnitTest.cpp.

                                              {

}

torc::generic::BOOST_AUTO_TEST_CASE

(

Om1UnitTest

)

Unit test for the generic object model.

Definition at line 88 of file Om1UnitTest.cpp.

                                  {

    // create string streams for both the generated and parsed EDIF
    std::stringstream generated;
    std::stringstream parsed;

    std::cout << "Generating " << "and.edf" << " ...  ";
    try {
        // create the object factory
        boost::shared_ptr<ObjectFactory> objectFactoryPtr(new ObjectFactory());

        // create the design root
        RootSharedPtr rootPtr = objectFactoryPtr->newRootPtr("and");
        rootPtr->setOriginalName("AND");

        // create the VIRTEX and work libraries
        LibrarySharedPtr virtexLibraryPtr = objectFactoryPtr->newLibraryPtr("VIRTEX", rootPtr);
        LibrarySharedPtr workLibraryPtr = objectFactoryPtr->newLibraryPtr("work", rootPtr);

        // create the LUT2 cell and its PRIM view
        CellSharedPtr lut2CellPtr = objectFactoryPtr->newCellPtr("LUT2", virtexLibraryPtr);
        ViewSharedPtr lut2ViewPtr = objectFactoryPtr->newViewPtr("PRIM", lut2CellPtr);
        ScalarPortSharedPtr lut2I0PortPtr = objectFactoryPtr->newScalarPortPtr("I0", 
            ePortDirectionIn, lut2ViewPtr);
        ScalarPortSharedPtr lut2I1PortPtr = objectFactoryPtr->newScalarPortPtr("I1", 
            ePortDirectionIn, lut2ViewPtr);
        ScalarPortSharedPtr lut2OPortPtr = objectFactoryPtr->newScalarPortPtr("O", 
            ePortDirectionOut, lut2ViewPtr);

        // create the and cell and its PRIM view
        CellSharedPtr andCellPtr = objectFactoryPtr->newCellPtr("and", workLibraryPtr, 
            Cell::eTypeGeneric, "AND");
        ViewSharedPtr andViewPtr = objectFactoryPtr->newViewPtr("verilog", andCellPtr);
        ScalarPortSharedPtr andI0PortPtr = objectFactoryPtr->newScalarPortPtr("I0", 
            ePortDirectionIn, andViewPtr);
        ScalarPortSharedPtr andI1PortPtr = objectFactoryPtr->newScalarPortPtr("I1", 
            ePortDirectionIn, andViewPtr);
        ScalarPortSharedPtr andOPortPtr = objectFactoryPtr->newScalarPortPtr("O", 
            ePortDirectionOut, andViewPtr);

        // create the oZ0 instance of type VIRTEX:LUT2:PRIM
        SingleInstanceSharedPtr oZ0InstancePtr = objectFactoryPtr->newSingleInstancePtr("oZ0", 
            andViewPtr, lut2ViewPtr, "o");
        ScalarPortReferenceSharedPtr oZ0I0PortReferencePtr 
            = objectFactoryPtr->newScalarPortReferencePtr(oZ0InstancePtr, lut2I0PortPtr);
        ScalarPortReferenceSharedPtr oZ0I1PortReferencePtr 
            = objectFactoryPtr->newScalarPortReferencePtr(oZ0InstancePtr, lut2I1PortPtr);
        ScalarPortReferenceSharedPtr oZ0OPortReferencePtr 
            = objectFactoryPtr->newScalarPortReferencePtr(oZ0InstancePtr, lut2OPortPtr);

        // create the i0 net
        ScalarNetSharedPtr i0NetPtr = objectFactoryPtr->newScalarNetPtr("i0", andViewPtr);
        andI0PortPtr->connect(i0NetPtr);
        oZ0I0PortReferencePtr->connect(i0NetPtr);
        ScalarNetSharedPtr i1NetPtr = objectFactoryPtr->newScalarNetPtr("i1", andViewPtr);
        andI1PortPtr->connect(i1NetPtr);
        oZ0I1PortReferencePtr->connect(i1NetPtr);
        ScalarNetSharedPtr oNetPtr = objectFactoryPtr->newScalarNetPtr("o", andViewPtr);
        andOPortPtr->connect(oNetPtr);
        oZ0OPortReferencePtr->connect(oNetPtr);

        // attach the INIT 8 property to the oZ0 instance
        PropertySharedPtr initPropertyPtr = objectFactoryPtr->newPropertyPtr("INIT", oZ0InstancePtr, 
            Value(Value::eValueTypeString, std::string("8")));
(void) initPropertyPtr;

        // instantiate the design
        DesignSharedPtr designPtr = objectFactoryPtr->newDesignPtr("and", rootPtr, "and", "work", 
            "AND");

        // attach the PART xc5vlx30ff324-1 property to the and design instance
        PropertySharedPtr partPropertyPtr = objectFactoryPtr->newPropertyPtr("PART", designPtr, 
            Value(Value::eValueTypeString, std::string("xc5vlx30ff324-1")));
        partPropertyPtr->setOwner("Xilinx");

        std::cout << "done." << std::endl;
//      PrintInfo info(generated);
//      rootPtr->accept(info);

        Decompiler decompiler(rootPtr);
        decompiler();

        // now insert inverter pairs on each net
//      VisitNet visitNet;
//      andViewPtr->applyOnAllNets(visitNet);

    } catch(Error& e) {
        std::cerr << MessageTable::instance()->getMessage(e.getErrorMessageId()) << std::endl;
        const std::vector<Error::StackFrameInfo>& stack = e.getStackTrace();
        for(std::vector<Error::StackFrameInfo>::const_iterator it = stack.begin(); 
            it != stack.end(); it++) {
            std::cerr << "    " << (*it).getFunction() << "() [" << (*it).getFile() << ":" 
                << (*it).getLine() << "]" << std::endl;
        }
    }
/*
    try {
        std::cout << "Parsing " << "and.edf" << " ...  ";
        boost::shared_ptr<ObjectFactory> factoryPtr(new ObjectFactory());
        boost::shared_ptr<Root> rootPtr;
        factoryPtr->create(rootPtr);
        boost::shared_ptr<Linker> linkerPtr(new Linker(rootPtr));
        ParserOptions options;
        EdifParser parser;
        parser.parse("and.edf", rootPtr, linkerPtr, factoryPtr, options);
        std::cout << "done." << std::endl;
        //PrintInfo info(parsed);
        //rootPtr->accept(info);
//      Decompiler decompiler(rootPtr);
//      decompiler();
    } catch(Error& e) {
        std::cerr << MessageTable::instance()->getMessage(e.getErrorMessageId()) << std::endl;
        const std::vector<Error::StackFrameInfo>& stack = e.getStackTrace();
        for(std::vector<Error::StackFrameInfo>::const_iterator it = stack.begin(); 
            it != stack.end(); it++) {
            std::cerr << "    " << (*it).getFunction() << "() [" << (*it).getFile() << ":" 
                << (*it).getLine() << "]" << std::endl;
        }
    }
*/
    // verify that the generated and parsed outputs are identical
    BOOST_CHECK_EQUAL(generated.str(), parsed.str());

}

Here is the call graph for this function:

template<typename _Tp >

boost::shared_ptr<_Tp> torc::generic::clone	(	const boost::shared_ptr< _Tp > &	inPointer,
		const ObjectFactorySharedPtr &	inFactory
	)
throw	(	Error
	)

Definition at line 63 of file Cloning.hpp.

                                                           {
    try {
        return _impl::Copier<_Tp>()(inPointer, inFactory);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename _Tp >

boost::shared_ptr<_Tp> torc::generic::cloneJoinedInfo	(	const boost::shared_ptr< _Tp > &	inPointer,
		const ObjectFactorySharedPtr &	inFactory,
		const ViewSharedPtr &	inView
	)
throw	(	Error
	)

Definition at line 73 of file Cloning.hpp.

                                               {
    try {
        return _impl::Copier<_Tp>()(inPointer, inFactory, inView);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename _Tp >

boost::shared_ptr<_Tp> torc::generic::clonePermutable	(	const boost::shared_ptr< _Tp > &	inPointer,
		const ObjectFactorySharedPtr &	inFactory,
		const ViewSharedPtr &	inView
	)
throw	(	Error
	)

Definition at line 84 of file Cloning.hpp.

                                               {
    try {
        return _impl::Copier<_Tp>()(inPointer, inFactory, inView);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::collectCells	(	ViewSharedPtr &	inViewPtr,
		CellUsageMap &	inoutCellUsageMap
	)

Recursively collect and count all cells used in the given view. The CellUsageMap must already be initialized with all expected cell counts set to zero.

Parameters

inViewPtr	The view to begin recursing from.
inoutCellUsageMap	A map from cell to usage count.

Definition at line 36 of file Pruning.cpp.

                                                                             {

    // iterate over all of the instances
    typedef std::vector<InstanceSharedPtr> InstanceSharedPtrVector;
    InstanceSharedPtrVector instances;
    inViewPtr->getInstances(instances);
    InstanceSharedPtrVector::iterator ip = instances.begin();
    InstanceSharedPtrVector::iterator ie = instances.end();
    while(ip < ie) {
        // look up the instance
        InstanceSharedPtr instancePtr = *ip++;
        // look up the master view and its parent cell
        ViewSharedPtr masterViewPtr = instancePtr->getMaster();
        CellSharedPtr masterCellPtr = masterViewPtr->getParent();
        // look up the master cell, and increment its usage count
        inoutCellUsageMap[masterCellPtr]++;
        // recurse
        collectCells(masterViewPtr, inoutCellUsageMap);
    }

}

Here is the caller graph for this function:

template<class T >

std::string torc::generic::compositionTypeString

(

const T &

inPtr

)

Definition at line 33 of file VerilogImporterVisitor.cpp.

                                                                      {
        if(!inPtr) return "null";
        switch(inPtr->getCompositionType()) {
            case eCompositionTypeScalar: return "scalar";
            case eCompositionTypeVector: return "vector";
            case eCompositionTypeVectorBit: return "vector bit";
            case eCompositionTypeBundle: return "bundle";
            default: return "unknown";
        }
    }

template<typename _Connectable >

void torc::generic::connectNetToElement	(	const std::vector< size_t > &	inIndices,
		const boost::shared_ptr< _Connectable > &	inConn,
		const NetSharedPtr &	inNet
	)
throw	(	Error
	)

Definition at line 57 of file InternalUtilityFunctions.hpp.

                                                                                          {
    try {
        if(inIndices.empty()) {
            //TBD::CHECK WIDTH
            inConn->connect(inNet);
        } else {
            boost::shared_ptr<_Connectable> bit = inConn->get(inIndices);
            bit->connect(inNet);
        }
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::copyParams	(	const Instance &	inOriginal,
		const InstanceSharedPtr &	outCloned,
		const ObjectFactorySharedPtr &	inFactory
	)

Definition at line 21 of file Cloning.cpp.

                                             {

    ParameterMapSharedPtr params = inOriginal.getParameters();
    ParameterMapSharedPtr clonedParams = outCloned->getParameters();
    ParameterContext origContext = inOriginal.getParameterContext();
    ParameterContext clonedContext = outCloned->getParameterContext();
    std::map<std::string, ParameterSharedPtr> overriddenParams;
    params->getOverriddenParameters(origContext, overriddenParams);
    for(std::map<std::string, ParameterSharedPtr>::iterator it = overriddenParams.begin();
        it != overriddenParams.end(); ++it) {
        ParameterSharedPtr clonedParam = clone((*it).second, inFactory);
        clonedParams->set(clonedContext, (*it).first, clonedParam);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename _Connectable >

void torc::generic::findLeafConnectable	(	std::vector< std::string > &	nestedNames,
		boost::shared_ptr< _Connectable > &	conn
	)
throw	(	Error
	)

Definition at line 22 of file InternalUtilityFunctions.hpp.

                                                       {
    std::vector<std::string>::reverse_iterator name = nestedNames.rbegin();
    std::vector<std::string>::reverse_iterator end = nestedNames.rend();
    ++name;
    if(!conn) {
        Error e(eMessageIdErrorNullPointer, __FUNCTION__, __FILE__, __LINE__);
        throw e;
    }
    for(; name != end; ++name) {
        if(eCompositionTypeBundle != conn->getCompositionType()) {
            Error e(eMessageIdErrorUnsupoortedOperation, __FUNCTION__, __FILE__, __LINE__);
            e.saveContextData("Name", *name);
            e.saveContextData("Operation", std::string("Find child"));
            throw e;
        }
        std::vector < boost::shared_ptr<_Connectable> > children;
        conn->getChildren(children);
        bool found = false;
        for(typename std::vector<boost::shared_ptr<_Connectable> >::iterator it = children.begin();
            it != children.end(); ++it) {
            if((*it)->getName() == *name) {
                conn = (*it);
                found = true;
                break;
            }
        }
        if(!found) {
            Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
            e.saveContextData("Name", (*name));
            throw;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::flatten	(	const InstanceSharedPtr &	inInstance,
		const ObjectFactorySharedPtr &	inFactory,
		bool	inRecursive = false,
		const std::string &	inSeparator = "/",
		const InstanceRenamingFunction &	inInstanceRenameFunc = InstanceRenamingFunction(getRenamedName< InstanceSharedPtr >),
		const NetRenamingFunction &	inNetRenameFunc = NetRenamingFunction(getRenamedName< NetSharedPtr >),
		const InstanceNamingFunction &	inInstanceNameFunc = InstanceNamingFunction(getModifiedName< InstanceSharedPtr >),
		const NetNamingFunction &	inNetNameFunc = NetNamingFunction(getModifiedName< NetSharedPtr >)
	)
throw	(	Error
	)

Flatten a given instance. Instance flattening is an operation where a given instance is replaced the internals of it's master in a given view. Instance flattening can be achieved on Single or Array Instances. However, it is not supported on the elements of an instance array.

Parameters

[in]	inInstance	The instance that need to be flattened. This will be removed after the operation.
[in]	inFactory	The object factory used for cloning components in the instance.
[in]	inRecursive	If true, Flatten instance hierarchy.
[in]	inSeparator	Use this separator to separate hierarchy elements
[in]	inInstanceRenameFunc	Function used to generate original name of new instances
[in]	inNetRenamingFunc	Function used to generate original name of new rename
[in]	inInstanceNameFunc	Function used to generate name of new instances
[in]	inNetNamingFunc	Function used to generate name of new nets

Note

When connections are made to individual elements of a vector net using for example, say, the portList construct, the bits of the vectors are appropriately broken up into individual scalar nets, and connections removed from the vector nets.

Definition at line 739 of file Flattening.cpp.

                                                          {
    FlatteningHelpers *pHelper = FlatteningHelpers::instance();
    pHelper->setSeparator(inSeparator);
    pHelper->setInstanceRenamingFunction(inInstanceRenameFunc);
    pHelper->setNetRenamingFunction(inNetRenameFunc);
    pHelper->setInstanceNamingFunction(inInstanceNameFunc);
    pHelper->setNetNamingFunction(inNetNameFunc);
    if(inRecursive) {
        std::list<InstanceSharedPtr> newInstances;
        if(!flatten_impl(inInstance, inFactory, newInstances)) {
            return;
        }
        while(!newInstances.empty()) {
            std::list<InstanceSharedPtr>::iterator top = newInstances.begin();
            InstanceSharedPtr inst = *top;
            newInstances.erase(top);
            flatten_impl(inst, inFactory, newInstances);
        }
    } else {
        std::list < InstanceSharedPtr > dummy;
        flatten_impl(inInstance, inFactory, dummy);
    }
    pHelper->reset();
    return;
}

Here is the caller graph for this function:

void torc::generic::flatten	(	const ViewSharedPtr &	inView,
		const ObjectFactorySharedPtr &	inFactory,
		bool	inRecursive = false,
		const std::string &	inSeparator = "/",
		const InstanceRenamingFunction &	inInstanceRenameFunc = InstanceRenamingFunction(getRenamedName< InstanceSharedPtr >),
		const NetRenamingFunction &	inNetRenameFunc = NetRenamingFunction(getRenamedName< NetSharedPtr >),
		const InstanceNamingFunction &	inInstanceNameFunc = InstanceNamingFunction(getModifiedName< InstanceSharedPtr >),
		const NetNamingFunction &	inNetNameFunc = NetNamingFunction(getModifiedName< NetSharedPtr >)
	)
throw	(	Error
	)

Flatten all instances in a given view. Instance flattening is an operation where a given instance is replaced the internals of it's master in a given view. Instance flattening can be achieved on Single or Array Instances. However, it is not supported on the elements of an instance array. Difference with the normal flatten() function is that this will keep flattening all instances in the gien view until a set of leaf instances is received. A Leaf Instance is an instance where the view has only interface delcarations and no instantiations of other cells within it.

Parameters

[in]	inView	All instances in the given view will be flatten.
[in]	inFactory	The object factory used for cloning components in the instance.
[in]	inRecursive	If true, Flatten instance hierarchy.
[in]	inSeparator	Use this separator to separate hierarchy elements
[in]	inInstanceRenameFunc	Function used to generate original name of new instances
[in]	inNetRenamingFunc	Function used to generate original name of new rename
[in]	inInstanceNameFunc	Function used to generate name of new instances
[in]	inNetNamingFunc	Function used to generate name of new nets

Note

When connections are made to individual elements of a vector net using for example, say, the portList construct, the bits of the vectors are appropriately broken up into individual scalar nets, and conections removed from the vector nets.

Definition at line 769 of file Flattening.cpp.

                                                          {
    if(!inView || !inFactory) {
        return;
    }
    std::vector<InstanceSharedPtr> outInstances;
    inView->getInstances(outInstances);
    std::vector<InstanceSharedPtr>::iterator instIt = outInstances.begin();
    for(; instIt != outInstances.end(); instIt++) {
        InstanceSharedPtr inst = *instIt;
        if(inst) {
            flatten(inst, inFactory, inRecursive, inSeparator, inInstanceRenameFunc,
                inNetRenameFunc, inInstanceNameFunc, inNetNameFunc);
        }
    }
    return;
}

Here is the call graph for this function:

void torc::generic::flatten	(	const DesignSharedPtr &	inDesign,
		const ObjectFactorySharedPtr &	inFactory,
		bool	inRecursive = false,
		const std::string &	inSeparator = "/",
		const InstanceRenamingFunction &	inInstanceRenameFunc = InstanceRenamingFunction(getRenamedName< InstanceSharedPtr >),
		const NetRenamingFunction &	inNetRenameFunc = NetRenamingFunction(getRenamedName< NetSharedPtr >),
		const InstanceNamingFunction &	inInstanceNameFunc = InstanceNamingFunction(getModifiedName< InstanceSharedPtr >),
		const NetNamingFunction &	inNetNameFunc = NetNamingFunction(getModifiedName< NetSharedPtr >)
	)
throw	(	Error
	)

Flatten a given design, all NETLIST views owned by the design cell will be flattened. Instance flattening is an operation where a given instance is replaced the internals of it's master in a given view. Instance flattening can be achieved on Single or Array Instances. However, it is not supported on the elements of an instance array. Difference with the normal flatten() function is that this will keep flattening all instances in the given design until a set of leaf instances is received. A Leaf Instance is an instance where the view has only interface delcarations and no instantiations of other cells within it.

Parameters

[in]	inDesign	The design that need to be flattened.
[in]	inFactory	The object factory used for cloning components in the instance.
[in]	inRecursive	If true, Flatten instance hierarchy.
[in]	inSeparator	Use this separator to separate hierarchy elements
[in]	inInstanceRenameFunc	Function used to generate original name of new instances
[in]	inNetRenamingFunc	Function used to generate original name of new rename
[in]	inInstanceNameFunc	Function used to generate name of new instances
[in]	inNetNamingFunc	Function used to generate name of new nets

Note

When connections are made to individual elements of a vector net using for example, say, the portList construct, the bits of the vectors are appropriately broken up into individual scalar nets, and conections removed from the vector nets.

Definition at line 789 of file Flattening.cpp.

                                                          {
    if(!inDesign || !inFactory) {
        return;
    }
    std::string cellName = inDesign->getCellRefName();
    std::string libName = inDesign->getLibraryRefName();
    RootSharedPtr root = inDesign->getParent();
    if(!root) {
        Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Pointer to Root", root);
        throw e;
    }
    LibrarySharedPtr library = root->findLibrary(libName);
    if(!library) {
        Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Pointer to Library", library);
        throw e;
    }
    CellSharedPtr cell = library->findCell(cellName);
    if(!cell) {
        Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Pointer to Cell", cell);
        throw e;
    }

    std::vector<ViewSharedPtr> outViews;
    cell->getViews(outViews);
    std::vector<ViewSharedPtr>::iterator viewIt = outViews.begin();
    for(; viewIt != outViews.end(); viewIt++) {
        ViewSharedPtr view = *viewIt;
        if(View::eTypeNetlist != view->getType()) {
            continue;
        }
        flatten(view, inFactory, inRecursive, inSeparator, inInstanceRenameFunc, inNetRenameFunc,
            inInstanceNameFunc, inNetNameFunc);
    }
}

Here is the call graph for this function:

template<typename _Pointer >

std::string torc::generic::getModifiedName	(	const std::string &	inInstName,
		const _Pointer &	inNameable,
		const std::vector< size_t > &	inIndicesVector = std::vector< size_t >()
	)

Generate name for a newly generated object during flattening This function generates names for objects during flattening. The default generated name is of the form of parent_child_index. However if the name exceeds 255 characters this will be changed to N00000001, N00000002 etc. The naming N00000001 etc restart for each object type. Therefore, there may be both and instance and a net having the name N00000001. This is allowed in EDIF 2 0 0.

Definition at line 707 of file Flattening.cpp.

                             {
    return (*NameModifier<_Pointer>::instance())(inInstName, inNameable, inIndicesVector);
}

template std::string torc::generic::getModifiedName	(	const std::string &	inInstName,
		const NetSharedPtr &	inNameable,
		const std::vector< size_t > &	inIndicesVector
	)

template std::string torc::generic::getModifiedName	(	const std::string &	inInstName,
		const InstanceSharedPtr &	inNameable,
		const std::vector< size_t > &	inIndicesVector
	)

template<typename _Pointer >

std::string torc::generic::getRenamedName	(	const InstanceSharedPtr &	inParentInstance,
		const _Pointer &	inRenamable,
		const std::vector< size_t > &	inIndicesVector = std::vector< size_t >()
	)

Generate original name for a newly generated object during flattening This function generates original names for objects during flattening. Unlike names these string do not have a restriction of 255 characters and are stored in the rename construct attached to a net or instance. The generated name is of the form Parent[index]/Child However the '/' can be replaced by a custom separator that can be specified as a parameter to the flatten() function.

Definition at line 713 of file Flattening.cpp.

                             {
    std::string sep = FlatteningHelpers::instance()->getSeparator();
    Renamable::Name originalName = inRenamable->getOriginalName();
    if(originalName.empty()) {
        originalName = inRenamable->getName();
    }
    std::string parentInstanceName = inParentInstance->getOriginalName();
    if(parentInstanceName.empty()) {
        parentInstanceName = inParentInstance->getName();
    }
    if(!inIndicesVector.empty()) {
        parentInstanceName += "[ ";
        std::ostringstream sout;
        copy(inIndicesVector.begin(), inIndicesVector.end(),
            std::ostream_iterator < size_t > (sout, " "));
        parentInstanceName += sout.str();
        parentInstanceName += "]";
    }
    std::ostringstream sout;
    sout << ((parentInstanceName.find_first_of(sep)) ? sep : "") << parentInstanceName << sep
        << originalName;
    return sout.str();
}

template std::string torc::generic::getRenamedName	(	const InstanceSharedPtr &	inParentInstance,
		const NetSharedPtr &	inRenamable,
		const std::vector< size_t > &	inIndicesVector
	)

template std::string torc::generic::getRenamedName	(	const InstanceSharedPtr &	inParentInstance,
		const InstanceSharedPtr &	inRenamable,
		const std::vector< size_t > &	inIndicesVector
	)

void torc::generic::log	(	const char *	fmt,
			...
	)

Definition at line 89 of file Log.cpp.

                               {
#ifdef LOGGING
    va_list args;
    va_start(args, fmt);
    Logger::instance()->write(fmt, args);
    va_end(args);
#endif
    return;
}

Here is the caller graph for this function:

void torc::generic::openLogFile

(

const std::string &

logFileName

)

Definition at line 82 of file Log.cpp.

                                               {
#ifdef LOGGING
    Logger::instance()->openLogFile(logFileName);
#endif
    return;
}

bool torc::generic::operator!= ( const location &  loc1, const location &  loc2  )

inline

Compare two location objects.

Definition at line 135 of file generic/edif/location.hh.

  {
    return !(loc1 == loc2);
  }

bool torc::generic::operator!= ( const position &  pos1, const position &  pos2  )

inline

Compare two position objects.

Definition at line 141 of file generic/edif/position.hh.

  {
    return !(pos1 == pos2);
  }

const location torc::generic::operator+ ( const location &  begin, const location &  end  )

inline

Join two location objects to create a location.

Definition at line 104 of file generic/edif/location.hh.

  {
    location res = begin;
    res.end = end.end;
    return res;
  }

const position torc::generic::operator+ ( const position &  begin, const int  width  )

inline

Add two position objects.

Definition at line 109 of file generic/edif/position.hh.

  {
    position res = begin;
    return res += width;
  }

const location torc::generic::operator+ ( const location &  begin, unsigned int  width  )

inline

Add two location objects.

Definition at line 112 of file generic/edif/location.hh.

  {
    location res = begin;
    res.columns (width);
    return res;
  }

Here is the call graph for this function:

const position& torc::generic::operator+= ( position &  res, const int  width  )

inline

Add and assign a position.

Definition at line 101 of file generic/edif/position.hh.

  {
    res.columns (width);
    return res;
  }

Here is the call graph for this function:

location& torc::generic::operator+= ( location &  res, unsigned int  width  )

inline

Add and assign a location.

Definition at line 120 of file generic/edif/location.hh.

  {
    res.columns (width);
    return res;
  }

Here is the call graph for this function:

const position torc::generic::operator- ( const position &  begin, const int  width  )

inline

Add two position objects.

Definition at line 124 of file generic/edif/position.hh.

  {
    return begin + -width;
  }

const position& torc::generic::operator-= ( position &  res, const int  width  )

inline

Add and assign a position.

Definition at line 117 of file generic/edif/position.hh.

  {
    return res += -width;
  }

std::ostream& torc::generic::operator<< ( std::ostream &  ostr, const location &  loc  )

inline

Intercept output stream redirection.

Parameters

ostr	the destination output stream
loc	a reference to the location to redirect

Avoid duplicate information.

Definition at line 146 of file generic/edif/location.hh.

  {
    position last = loc.end - 1;
    ostr << loc.begin;
    if (last.filename
    && (!loc.begin.filename
        || *loc.begin.filename != *last.filename))
      ostr << '-' << last;
    else if (loc.begin.line != last.line)
      ostr << '-' << last.line  << '.' << last.column;
    else if (loc.begin.column != last.column)
      ostr << '-' << last.column;
    return ostr;
  }

std::ostream& torc::generic::operator<< ( std::ostream &  ostr, const position &  pos  )

inline

Intercept output stream redirection.

Parameters

ostr	the destination output stream
pos	a reference to the position to redirect

Definition at line 151 of file generic/edif/position.hh.

  {
    if (pos.filename)
      ostr << *pos.filename << ':';
    return ostr << pos.line << '.' << pos.column;
  }

bool torc::generic::operator== ( const location &  loc1, const location &  loc2  )

inline

Compare two location objects.

Definition at line 128 of file generic/edif/location.hh.

  {
    return loc1.begin == loc2.begin && loc1.end == loc2.end;
  }

Here is the caller graph for this function:

bool torc::generic::operator== ( const position &  pos1, const position &  pos2  )

inline

Compare two position objects.

Definition at line 131 of file generic/edif/position.hh.

  {
    return
      (pos1.filename == pos2.filename
       || (pos1.filename && pos2.filename && *pos1.filename == *pos2.filename))
      && pos1.line == pos2.line && pos1.column == pos2.column;
  }

void torc::generic::prune

(

RootSharedPtr &

inRootPtr

)

Prune all unused cells and libraries from the given root.

Parameters

inRootPtr

The root to prune.

Definition at line 58 of file Pruning.cpp.

                                     {

    // declare a map of all cells actually used by this root
    CellUsageMap cellUsageMap;

    // iterate over all of the libraries and collect all cells
    typedef std::vector<LibrarySharedPtr> LibrarySharedPtrVector;
    LibrarySharedPtrVector libraries;
    inRootPtr->getLibraries(libraries);
    LibrarySharedPtrVector::iterator lp = libraries.begin();
    LibrarySharedPtrVector::iterator le = libraries.end();
    while(lp < le) {
        // look up the library name and specifics
        LibrarySharedPtr libraryPtr = *lp++;
        // iterate over all library cells
        typedef std::vector<CellSharedPtr> CellSharedPtrVector;
        CellSharedPtrVector cells;
        libraryPtr->getCells(cells);
        CellSharedPtrVector::iterator cp = cells.begin();
        CellSharedPtrVector::iterator ce = cells.end();
        while(cp < ce) {
            // look up the cell
            CellSharedPtr cellPtr = *cp++;
            cellUsageMap[cellPtr] = 0;
        }
    }

    // iterate over all of the designs and collect cell usage counts
    typedef std::vector<DesignSharedPtr> DesignSharedPtrVector;
    DesignSharedPtrVector designs;
    inRootPtr->getDesigns(designs);
    DesignSharedPtrVector::iterator dp = designs.begin();
    DesignSharedPtrVector::iterator de = designs.end();
    while(dp < de) {
        // look up the design name and specifics
        DesignSharedPtr designPtr = *dp++;
        std::string designName = designPtr->getName();
        std::string cellName = designPtr->getCellRefName();
        std::string libraryName = designPtr->getLibraryRefName();
        // look up the design cell
        LibrarySharedPtr libraryPtr = inRootPtr->findLibrary(libraryName);
        CellSharedPtr cellPtr = libraryPtr->findCell(cellName);
        log("Examining library %s, cell %s, design %s.\n", libraryName.c_str(), cellName.c_str(), 
            designName.c_str());
        // ensure that this design cell is properly counted
        cellUsageMap[cellPtr]++;
        // iterate over all cell views
        typedef std::vector<ViewSharedPtr> ViewSharedPtrVector;
        ViewSharedPtrVector views;
        cellPtr->getViews(views);
        ViewSharedPtrVector::iterator vp = views.begin();
        ViewSharedPtrVector::iterator ve = views.end();
        while(vp < ve) {
            // look up the view
            ViewSharedPtr viewPtr = *vp++;
            // collect all cells
            collectCells(viewPtr, cellUsageMap);
        }
    }

    // display all cells that are in use
    CellUsageMap::iterator cp = cellUsageMap.begin();
    CellUsageMap::iterator ce = cellUsageMap.end();
    while(cp != ce) {
        // look up the cell information
        CellUsageMap::value_type cellUsage = *cp++;
        CellSharedPtr cellPtr = cellUsage.first;
        LibrarySharedPtr libraryPtr = cellUsage.first->getParent();
        std::string cellName = cellPtr->getName();
        std::string libraryName = libraryPtr->getName();
        log("    library %s, cell %s: %d\n", libraryName.c_str(), cellName.c_str(), 
            cellUsage.second);
        if(cellUsage.second == 0) {
            log("    removing unused cell %s from library %s: %s.\n", cellName.c_str(), 
                libraryName.c_str(), libraryPtr->findCell(cellName) ? "found" : "not found");
            libraryPtr->removeCell(cellName);
        }
    }

    // iterate over all of the libraries and remove empty ones
    for(LibrarySharedPtrVector::size_type i = 0; i < libraries.size(); i++) {
        // look up the library name and specifics
        LibrarySharedPtr libraryPtr = libraries[i];
        std::string libraryName = libraryPtr->getName();
        // if the library has no cells, remove it
        typedef std::vector<CellSharedPtr> CellSharedPtrVector;
        CellSharedPtrVector cells;
        libraryPtr->getCells(cells);
        if(cells.size() == 0) {
            log("    removing unused library %s.\n", libraryName.c_str());
            inRootPtr->removeLibrary(libraryName);
        }
    }

}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename _Tp >

void torc::generic::runVisitor	(	_Tp &	inoutVisited,
		BaseVisitor &	inoutVisitor
	)
throw	(	Error
	)

Definition at line 78 of file VisitorType.hpp.

                  {
    typedef VisitorType<_Tp> ConcreteVisitor;

    if(ConcreteVisitor *p = dynamic_cast<ConcreteVisitor *>(&inoutVisitor)) {
        try {
            p->visit(inoutVisited);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
        return;
    }
    //TBD::Error?Fallback?
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function: