torc::physical::Factory Class Reference

Factory class for physical netlist elements. More...

#include <Factory.hpp>

List of all members.

Static Public Member Functions
static DesignSharedPtr	newDesignPtr (const string &inName, const string &inDevice, const string &inPackage, const string &inSpeedGrade, const string &inXdlVersion)
	Create and return a new Design shared pointer.
static ModuleSharedPtr	newModulePtr (const string &inName, const string &inAnchor)
	Create and return a new Module shared pointer.
static PortSharedPtr	newPortPtr (const string &inName, InstanceSharedPtr inInstancePtr, const string &inPinName)
	Create and return a new Port shared pointer.
static InstanceSharedPtr	newInstancePtr (const string &inName, const string &inType, const string &inTile, const string &inSite, EInstanceBonding inBonding=eInstanceBondingUnknown, InstanceReferenceSharedPtr inInstanceReferencePtr=InstanceReferenceSharedPtr())
	Construct and return a new Instance shared pointer.
static NetSharedPtr	newNetPtr (const string &inName, ENetType inNetType=eNetTypeNormal)
	Create and return a new Net share pointer.
static InstanceReferenceSharedPtr	newInstanceReferencePtr (const string &inInstantiationName, ModuleSharedPtr inModulePtr, InstanceSharedPtr inInstancePtr)
	Create and return a new InstanceReference shared pointer.
static InstancePinSharedPtr	newInstancePinPtr (InstanceSharedPtr inInstancePtr, const string &inPinName)
	Construct and return a new InstancePin shared pointer.
static torc::physical::Pip	newPip (const string &inTileName, const string &inSourceWireName, const string &inSinkWireName, EPipDirection inPipDirection, RoutethroughSharedPtr inRoutethroughPtr=RoutethroughSharedPtr())
	Construct a pip and return it.
static RoutethroughSharedPtr	newRoutethroughPtr (const string &inSetting, const string &inName, const string &inValue, const InstanceWeakPtr &inInstancePtr, const string &inSourceWireName, const string &inSinkWireName)
	Construct and return a new Routethrough shared pointer.
Protected Types
typedef std::string	string
	Imported type name.

---

Detailed Description

Factory class for physical netlist elements.

Physical netlist elements must be created by this factory.

Definition at line 31 of file Factory.hpp.

---

Member Typedef Documentation

typedef std::string torc::physical::Factory::string [protected]

Imported type name.

Definition at line 35 of file Factory.hpp.

---

Member Function Documentation

static DesignSharedPtr torc::physical::Factory::newDesignPtr	(	const string &	inName,
		const string &	inDevice,
		const string &	inPackage,
		const string &	inSpeedGrade,
		const string &	inXdlVersion
	)			[inline, static]

Create and return a new Design shared pointer.

Parameters:

	inName	The design name.
	inDevice	The design device.
	inPackage	The device package.
	inSpeedGrade	The device speed grade.
	inXdlVersion	The design XDL version.

Definition at line 44 of file Factory.hpp.

static ModuleSharedPtr torc::physical::Factory::newModulePtr	(	const string &	inName,
		const string &	inAnchor
	)			[inline, static]

Create and return a new Module shared pointer.

Parameters:

	inName	The module name.
	inAnchor	The anchor instance name for the module. The anchor designates the instance in the module relative to which the module will be placed.

Definition at line 55 of file Factory.hpp.

static PortSharedPtr torc::physical::Factory::newPortPtr	(	const string &	inName,
		InstanceSharedPtr	inInstancePtr,
		const string &	inPinName
	)			[inline, static]

Create and return a new Port shared pointer.

Parameters:

	inName	The port name.
	inInstancePtr	The port instance pointer.
	inPinName	The port pin name.

Definition at line 65 of file Factory.hpp.

static InstanceSharedPtr torc::physical::Factory::newInstancePtr	(	const string &	inName,
		const string &	inType,
		const string &	inTile,
		const string &	inSite,
		EInstanceBonding	inBonding = eInstanceBondingUnknown,
		InstanceReferenceSharedPtr	inInstanceReferencePtr = InstanceReferenceSharedPtr()
	)			[inline, static]

Construct and return a new Instance shared pointer.

Parameters:

	inName	The instance name.
	inType	The instance type.
	inTile	The instance tile, or an empty string if unplaced.
	inSite	The instance site, or an empty string if unplaced.
	inBonding	The specified bonding for unplaced IO, or eInstanceBondingUnknown for placed IO instances and non-IO instances. The default value is almost always correct.
	inInstanceReferencePtr	The module instance reference, if applicable. The default value is almost always correct. Note that instance references are never required for XDL, and are only supported to faithfully replicate XDL designs.

Definition at line 81 of file Factory.hpp.

static NetSharedPtr torc::physical::Factory::newNetPtr	(	const string &	inName,
		ENetType	inNetType = eNetTypeNormal
	)			[inline, static]

Create and return a new Net share pointer.

Parameters:

	inName	The net name.
	inNetType	The net power type.

Definition at line 93 of file Factory.hpp.

static InstanceReferenceSharedPtr torc::physical::Factory::newInstanceReferencePtr	(	const string &	inInstantiationName,
		ModuleSharedPtr	inModulePtr,
		InstanceSharedPtr	inInstancePtr
	)			[inline, static]

Create and return a new InstanceReference shared pointer.

Parameters:

	inInstantiationName	The name under which the reference module was instantiated.
	inModulePtr	The module containing the referenced instance.
	inInstancePtr	The instance being referenced.

Definition at line 102 of file Factory.hpp.

static InstancePinSharedPtr torc::physical::Factory::newInstancePinPtr	(	InstanceSharedPtr	inInstancePtr,
		const string &	inPinName
	)			[inline, static]

Construct and return a new InstancePin shared pointer.

Parameters:

	inInstancePtr	The pin instance pointer.
	inPinName	The pin name.

Definition at line 111 of file Factory.hpp.

static torc::physical::Pip torc::physical::Factory::newPip	(	const string &	inTileName,
		const string &	inSourceWireName,
		const string &	inSinkWireName,
		EPipDirection	inPipDirection,
		RoutethroughSharedPtr	inRoutethroughPtr = RoutethroughSharedPtr()
	)			[inline, static]

Construct a pip and return it.

Parameters:

	inTileName	The containing tile.
	inSourceWireName	The source wire.
	inSinkWireName	The sink wire.
	inPipDirection	The pip directionality. See EPipDirection. The most common value is ePipUnidirectionalBuffered, which represents a unidirectional buffered connection from source to sink.
	inRoutethroughPtr	The routethrough shared pointer. The default value creates no routethrough.

Definition at line 126 of file Factory.hpp.

static RoutethroughSharedPtr torc::physical::Factory::newRoutethroughPtr	(	const string &	inSetting,
		const string &	inName,
		const string &	inValue,
		const InstanceWeakPtr &	inInstancePtr,
		const string &	inSourceWireName,
		const string &	inSinkWireName
	)			[inline, static]

Construct and return a new Routethrough shared pointer.

Definition at line 133 of file Factory.hpp.

---

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

• torc/physical/Factory.hpp