8 CDBA Placement Functions

This chapter includes the following topics:

Structs in Placement Infrastructure

This section covers the structs used in placement infrastructure.

dbBackgroundDefAttrData
Type	Name	Description
`dbLayer`	`layer`	Layer associated with backGroundDef.
`dbPurpose`	`purpose`	Purpose associated with backGroundDef.
`String`	`netName`	Name of a net.
`int`	`leftEnc`	Left enclosure of the background shape.
`int`	`rightEnc`	Right enclosure of the background shape.
`int`	`topEnc`	Top enclosure of the background shape.
`int`	`botEnc`	Bottom enclosure of the background shape.

dbCompFilterSpec
Type	Name	Description
`String`	`libPattern`	Library name pattern.
`String`	`cellPattern`	Cell name pattern.
`String`	`viewPattern`	View name pattern.

dbCompTypeSetDefAttrData
Type	Name	Description
`dbAlignmentType`	`refOnArea`	Alignment type of area reference.
`dbAlignmentType`	`refOnComp`	Alignment type of component reference.
`dbOrient`	`*orients`	Allowed orientations that placer can use for cells in the component types.
`unsigned int`	`numOrients`	Number of allowed orientations.
`String`	`*allowedTypes`	Allowed component types that share placement attributes.
`unsigned int`	`numAllowedTypes`	Number of component types.
`dbCompFilterSpec`	`*compFilters`	Allowed component filters.
`unsigned int`	`numCompFilters`	Number of allowed component filters.
`int`	`offset`	Offset from the reference points computed from row reference, specified in user units.
`int`	`grid`	Pitch or grid to use between placement locations.

dbPlaceRowAttrData
Text	Name	Description
`String`	`name`	Name of the placeArea.
`unsigned int`	`offset`	Offset from the reference points computed from row reference, specified in user units.
`dbOrient`	`orient`	Orientation of the placeArea
`dbRailDefAttrData`	`*railDefAttrs`	Pointer to array with railDef attributes.
`unsigned int`	`numRailDefAttrs`	Pointer to the memory area where the number of railDef attributes is placed.
`dbCompTypeSetDefAttrData`	`*compTypeSetDefAttrs`	Pointer to array with compTypeSetDef attributes.
`unsigned int`	`numCompTypeSetDefAttrs`	Pointer to the memory area where the number of compTypeSetDef attributes is placed.
`dbBackgroundDefAttrData`	`*backgroundDefAttrs`	Pointer to array with backgroundDef attributes.
`unsigned int`	`numBackgroundDefAttrs`	Pointer to the memory area where the number of backgroundDef attributes is placed.
`dbPlaceRowType`	`tag`	Placement type of row.
`union rowInfo`		Specify height or siteDef for the placeArea.
`unsigned int`	`height`	Height of the placeArea in user units.
`String`	`siteDef`	siteDef for placeArea.

dbRailDefAttrData
Text	Name	Description
`dbLayer`	`layer`	Layer associated with railDef.
`dbPurpose`	`purpose`	Purpose associated with railDef.
`dbAlignmentType`	`refOnArea`	Alignment type of area reference.
`dbAlignmentType`	`refOnRail`	Alignment type of rail reference.
`unsigned int`	`width`	Width of railDef.
`String`	`netName`	Name of a net.
`int`	`offset`	Places the rail at the specified distance (in user units) from the two reference points (rail and row). A negative value indicates offsetting the rail below the top/bottom edge of the row and a positive value indicates offsetting the rail above the top/bottom edge.
`int`	`beginOffset`	Offsets or extends the rail by the specified user units from the left edge of the row. A negative value indicates offsetting the rail towards the left side of the left edge of the row and a positive value indicates offsetting the rail towards the right side of the left edge of the row.
`int`	`endOffset`	Offsets or extends the rail by the specified user units from the right edge of the row. A negative value indicates offsetting the rail towards the left side of the right edge of the row and a positive value indicates offsetting the rail towards the right side of the right edge of the row.
`dbRailFigType`	`figType`	figType of the railDef.

dbPlaceCellsAttrData

Type	Name	Description
`String`	`leftBoundaryCell`	Name of the left boundary cell.
`Boolean`	`leftBoundaryCellMirrored`	Specifies whether the left boundary cell is mirrored.
`String`	`rightBoundaryCell`	Name of the right boundary cell.
`Boolean`	`rightBoundaryCellMirrored`	Specifies whether the right boundary cell is mirrored.
`String`	`topLeftBoundaryCell`	Name of the top-left boundary cell.
`String`	`bottomLeftBoundaryCell`	Name of the bottom-left boundary cell.
`Boolean`	`leftCornerCellsMirrored`	Specifies whether the left corner cell is mirrored.
`String`	`topRightBoundaryCell`	Name of the top right boundary cell.
`String`	`bottomRightBoundaryCell`	Name of the bottom right boundary cell.
`Boolean`	`rightCornerCellsMirrored`	Specifies whether the right corner cell is mirrored.
`String`	`*topBoundaryCells`	List of top boundary cells.
`unsigned int`	`numTopBoundaryCells`	Number of allowed top boundary cells.
`String`	`*bottomBoundaryCells`	List of bottom boundary cells.
`unsigned int`	`numBottomBoundaryCells`	Number of allowed bottom boundary cells.
`String`	`*tapCells`	List of tap cells.
`unsigned int`	`numTapCells`	Number of allowed tap cells.
`String`	`*fillCells`	List of fill cells.
`unsigned int`	`numFillCells`	Number of allowed fill cells.
`String`	`*libNames`	List of library cells.
`unsigned int`	`numLibs`	Number of allowed library cells.
`String`	`*viewNames`	List of view names.
`unsigned int`	`numViews`	Number of allowed view names.

Enumerated Types and Enumerated Constants used in Placement Infrastructure

This sections covers the enumerated types and enumerated constants used in placement infrastructure.

dbAlignmentType
Alignment	Enumerated constants
No alignment	dbcUnknownAlignment
Align to bottom edge	dbcBottomAlignment
Align to top edge	dbcTopAlignment
Align to center point	dbcCenterAlignment
Align to left edge	dbcLeftAlignment
Align to right edge	dbcRightAlignment
Use any alignment	dbcAnyAlignmen

dbOrient

Allowed orientations	Enumerated constants
No rotation	`dbcR0`
Rotate 90 degrees	`dbcR90`
Rotate 180 degrees	`dbcR180`
Rotate 270 degrees	`dbcR270`
Mirror about the `Y` axis	`dbcMY`
Mirror about the `Y` axis, then rotate 90 degrees	`dbcMYR90`
Mirror about the `X` axis	`dbcMX`
Mirror about the `X` axis, then rotate 90 degrees	`dbcMXR90`

dbRailFigType
Allowed railFig Types	Enumerated constants
No figType	dbcUnknownRailFigType
Rectangle figType	dbcRectRailFigType
PathSeg figType	dbcPathSegRailFigType

dbPlaceRowType
Allowed placeRow Types	Enumerated constants
No rowType specified	dbcUnknownPlaceRowType
Place area type	dbcAreaPlaceRowType
Placement row type	dbcRowPlaceRowType

Background Definition Functions

dbAllocBackgroundDefAttrArray

dbBackgroundDefAttrData*

dbAllocBackgroundDefAttrArray
unsigned int numBackgroundDefAttrDatas
);

Description

Allocates memory for the array of backgroundDef attribute data and initializes the memory with zeroes.

Arguments

numBackgroundDefAttrDatas
	Number of backgroundDef attributes to fit in the allocated memory.

Return Value

dbBackgroundDefAttrData*

Pointer to the allocated memory area.

For more information, see dbBackgroundDefAttrData.

dbCreateBackgroundDef

dbBackgroundDefId

dbCreateBackgroundDef(
dbCellViewId cellViewId,
constString  nameBackgroundDef,
dbLayer      layer,
dbPurpose    purpose,
constString  netName,
int          leftEnclosure,
int          rightEnclosure,
int          topEnclosure,
int          bottomEnclosure
);

Description

Creates a backgroundDef based on the specified attributes. The layer-purpose pair must exist to create a backgroundDef.

Arguments

cellViewId	Database ID of a cellview.
nameBackgroundDef	Name of a backgroundDef object.
layer	Layer to be associated with the backgroundDef object.
purpose	Purpose to be associated with the backgroundDef object.
netName	Name of a net.
leftEnc	Left enclosure of the background shape.
rightEnc	Right enclosure of the background shape.
topEnc	Top enclosure of the background shape.
bottomEnc	Bottom enclosure of the background shape.

Return Value

dbBackgroundDefId

Database ID of the created backgroundDef object.

dbCreateBackgroundDefByAttr

dbBackgroundDefId

dbCreateBackgroundDefByAttr(
dbCellViewId            cellViewId,
onstString             name,
dbBackgroundDefAttrData *data
);

Description

Creates a backgroundDef based on specified attributes.

Arguments

cellViewId

Database ID of a cellview.

name

Name of a backgroundDef object.

*data

Struct with the backgroundDef attributes.

For more information, see dbBackgroundDefAttrData.

Return Value

dbBackgroundDefId

Database ID of the backgroundDef object that is created.

dbDeleteBackgroundDef

Boolean

dbDeleteBackgroundDef(
dbBackgroundDefId bgDefId
);

Description

Deletes a backgroundDef object with the specified database ID.

Arguments

bgDefId

Database ID of a backgroundDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbFreeBackgroundDefAttrArray

void

dbFreeBackgroundDefAttrArray(
unsigned int            numBackgroundDefAttrDatas,
dbBackgroundDefAttrData *backgroundDefAttrData
);

Description

Deallocates the memory allocated for an array of backGroundDef objects.

Arguments

numBackgroundDefAttrDatas

Size of the deallocated memory area.

backgroundDefAttrData

Pointer to the memory area to deallocate.

For more information, see dbBackgroundDefAttrData.

Return Value

No Return Value.

dbGenBackgroundDef

Boolean

dbGenBackgroundDef(
dbGenStateId         pState,
dbBackgroundDefId    *bgDefId
);

Description

Retrieves the ID of the next backgroundDef object from the generator with the given pState. ID of the backgroundDef object is returned in bgDefId.

Arguments

pState	State ID for the generator.
bgDefId	ID of the next backgroundDef object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if the next backgroundDef ID is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGetBackgroundDefAttr

Boolean

dbGetBackgroundDefAttr(
dbBackgroundDefId bgDefId,
dbBackgroundDefAttrData  *data
);

Description

Returns the attributes of the specified backgroundDef object.

Arguments

bgDefId

Database ID of a backgroundDef object.

data

Pointer to struct in which the background def attributes will be returned.

For more information, see dbBackgroundDefAttrData.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetBackgroundDefEnclosure

Boolean

dbGetBackgroundDefEnclosures(
dbBackgroundDefId  bgDefId,
int                *pLeft,
int                *pRight,
int                *pTop,
int                *pBottom
);

Description

Returns all enclosures of the specified backgroundDef object.

Arguments

bgDefId	Database ID of a backgroundDef object.
pLeft	Pointer to left enclosure of the background shape.
pRight	Pointer to right enclosure of the background shape.
pTop	Pointer to top enclosure of the background shape.
pBottom	Pointer to bottom enclosure of the background shape.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetBackgroundDefLP

Boolean

dbGetBackgroundDefLP(
dbBackgroundDefId  bgDefId,
dbLayer            *pLayer,
dbPurpose          *pPurpose
);

Description

Returns the layer and purpose of the specified backgroundDef object.

Arguments

bgDefId	Database ID of a backgroundDef object.
pLayer	Pointer to the layer number to be associated with the backgroundDef.
pPurpose	Pointer to the purpose number to be associated with the backgroundDef.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetBackgroundDefName

String

dbGetBackgroundDefName(
dbBackgroundDefId    bgDefId
);

Description

Returns the name of the specified backgroundDef object.

Arguments

bgDefId

Database ID of a backgroundDef object.

Return Value

String

Name of the specified backgroundDef object.

dbGetBackgroundDefNetName

String

dbGetBackgroundDefNetName(
dbBackgroundDefId bgDefId
);

Description

Returns the net name of a backgroundDef with the specified database ID.

Arguments

bgDefId

Database ID of a backgroundDef object.

Return Value

String

Name of the net of the specified backgroundDef object.

dbSetBackgroundDefEnclosures

Boolean

dbSetBackgroundDefEnclosures(
dbBackgroundDefId  bgDefId,
int                left,
int                right,
int                top,
int                bottom
);

Description

Sets specified enclosures on a backgroundDef with the specified database ID.

Arguments

bgDefId	Database ID of a backgroundDef object.
pLeft	Left enclosure of the background shape.
pRight	Right enclosure of the background shape.
pTop	Top enclosure of the background shape.
pBottom	Bottom enclosure of the background shape.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetBackgroundDefLP

Boolean

dbSetBackgroundDefLP(
dbBackgroundDefId  bgDefId,
dbLayer            layer,
dbPurpose          purpose
);

Description

Sets specified layer and purpose for a backgroundDef with the specified database ID.

Arguments

bgDefId	Database ID of a backgroundDef.
pLayer	Layer number to be associated with the backgroundDef.
pPurpose	Purpose number to be associated with the backgroundDef.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetBackgroundDefNetName

Boolean

dbSetBackgroundDefNetName(
dbBackgroundDefId bgDefId,
constString       netName
);

Description

Sets the given net name for a backgroundDef with the specified database ID.

Arguments

bgDefId	Database ID of a backgroundDef.
netName	Name of the net to be set for backgroundDef.

Return Value

Boolean

TRUE if the net name is set.

FALSE if the net name is not set.

dbStartGenBackgroundDef

dbGenStateId

dbStartGenBackgroundDef(
dbCellViewId    cellViewId
);

Description

Initializes a generator for all backgroundDefs in the specified cellview. A generator state ID is returned, which is used with the dbGenBackgroundDef function.

Arguments

cellViewId

Database ID of a cellview.

Return Value

dbGenStateId

State ID for the generator.

Component Type Set Definition Functions

dbAllocCompTypeSetDefAttrArray

dbCompTypeSetDefAttrData*

dbAllocCompTypeSetDefAttrArray(
unsigned int numCompTypeSetDefAttrData
);

Description

Allocates memory for the array of compTypeSetDef attribute data and initializes the memory with zeroes.

Arguments

numCompTypeSetDefAttrData
	Number of compTypeSetDef attributes to fit in the allocated memory.

Return Value

dbCompTypeSetDefAttrData*
	Pointer to the allocated memory area.

dbCreateCompTypeSetDef

dbId

dbCreateCompTypeSetDef(
dbCellViewId cellViewId,
constString allowedCompName,
dbAlignmentType areaRef,
dbAlignmentType compRef,
dbOrient *orients,
int  numOrients,
constString *compTypes,
int numCompTypes,
dbCoord  offset,
dbCoord grid
);

Description

Creates a compTypeSetDef object in the specified cellView.

Arguments

cellViewId	Database ID of a cellview.
allowedCompName	Name of the allowed component.
areaRef	Specifies area reference. For more information, see dbAlignmentType.
compRef	Specifies component reference. For more information, see dbAlignmentType.
orients	Array of allowed orientations that placer can use for cells in the component types. For more information, see dbOrient.
numOrients	Number of entries in the array of allowed orientations.
compTypes	Array of component types names.
numCompTypes	Number of entries in the array of component type names.
offset	The offset from the reference points computed from row reference can be specified in user units.
grid	The pitch or grid to use between placement locations can be specified.

Return Value

dbCreateCompTypeSetDef
	Database ID of the created compTypeSetDef object.

dbCreateCompTypeSetDefByAttr

dbCompTypeSetDefId

dbCreateCompTypeSetDefByAttr(
dbCellViewId             cellViewId,
constString              name,
dbCompTypeSetDefAttrData *data
);

Description

Creates a compTypeSetDef based on the specified attributes.

Arguments

cellViewId

Database ID of a cellview.

name

Name of a compTypeSetDef object.

*data

Pointer to the struct of compTypeSetDef attributes.

For more information, see dbCompTypeSetDefAttrData.

Return Value

dbCompTypeSetDefId

Database ID of the created compTypeSetDef object.

dbFreeCompTypeSetDefAttrArray

void

dbFreeCompTypeSetDefAttrArray(
unsigned int             numCompTypeSetDefAttrData,
dbCompTypeSetDefAttrData *compTypeSetDefAttrDatas
);

Description

Deallocates the memory allocated for an array of compTypeSetDef objects.

Arguments

numCompTypeSetDefAttrData
	Size of the deallocated memory area.
compTypeSetDefAttrDatas	Pointer to the memory area to deallocate.

Return Value

No Return Value.

dbGenCompTypeSetDef

Boolean

dbGenCompTypeSetDef(
dbGenStateId    pState,
dbId     *pCompTypeSetDefId
);

Description

Retrieves the ID of the next compTypeSetDef object from the generator with the given pState. ID of the backgroundDef is returned in pCompTypeSetDefId.

Arguments

pState	State ID for the generator.
pCompTypeSetDefId	ID of the next compTypeSetDef object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next compTypeSetDef object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGetCompTypeSetDefAttr

Boolean

dbGetCompTypeSetDefAttr(
dbCompTypeSetDefId compTypeSetDefId,
dbCompTypeSetDefAttrData    *data
);

Description

Returns the attributes of the specified compTypeSetDef object.

Arguments

compTypeSetDefId

Database ID of a compTypeSetDef object.

data

Pointer to the struct of compTypeSetDef attributes.

For more information, see dbCompTypeSetDefAttrData.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetCompTypeSetDefCompFilters

Boolean

dbGetCompTypeSetDefCompFilters(
dbId compTypeSetDefId,
**compFilters,
int              *numCompFilters
);

Description

Returns the compFilters in the specified compTypeSetDef object.

Arguments

compTypeSetDefId

Database ID of a compTypeSetDef object.

compFilters

Pointer to the memory area in which the array of compFilters is placed.

For more information, see dbCompFilterSpec.

numCompFilters

Pointer to the memory area in which the number of compFilters is placed.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetCompTypeSetDefCompFilters

Boolean

dbSetCompTypeSetDefCompFilters(
dbId compTypeSetDefId,
dbCompFilterSpec *compFilters,
int              numCompFilters
);

Description

Sets the compFilters in the specified compTypeSetDef object.

Arguments

compTypeSetDefId

Database ID of a compTypeSetDef object.

compFilters

Array of compFilters to be set.

For more information, see dbCompFilterSpec.

numCompFilters

Number of elements in the array of compFilters.

Return Value

Boolean

TRUE if the compFilters are set.

FALSE if the compFilters are not set.

dbStartGenCompTypeSetDef

dbGenStateId
dbStartGenCompTypeSetDef(
dbCellViewId cellViewId
);

Description

Initializes a generator for all compTypeSetDef objects in the specified cellview. A generator state ID is returned, which is used with the dbGenCompTypeSetDef function.

Arguments

cellViewId

Database ID of a cellview.

Return Value

dbGenStateId

State ID for the generator.

dbUnsetCompTypeSetDefCompFilters

Boolean

dbUnsetCompTypeSetDefCompFilters(
dbId compTypeSetDefId
);

Description

Removes the compFilters from the specified compTypeSetDef object.

Arguments

compTypeSetDefId

Database ID of a compTypeSetDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

Rail Definition Functions

dbAllocRailDefAttrArray

dbRailDefAttrData*

dbAllocRailDefAttrArray(
unsigned int numRailDefAttrDatas
);

Description

Allocates memory for the array of railDef attribute data and initializes the memory with zeroes.

Arguments

numRailDefAttrDatas

Number of railDef attributes to fit in the allocated memory.

Return Value

dbRailDefAttrData

Pointer to the allocated memory area.

dbCreateRailDef

dbId

dbCreateRailDef(
dbCellViewId cellViewId,
String railName,
String netName,
dbAlignmentType areaRef,
dbAlignmentType railRef,
dbLayer layer, 
dbPurpose purpose,
dbDistance width,
dbCoord offset,
dbCoord beginOffset,
dbCoord endOffset
);

Description

Creates a railDef in the specified cellview.

Arguments

cellViewId	Database ID of a cellview.
railName	Name of a railDef object.
netName	Name of a net.
areaRef	Alignment type of area of the rail geometry. For more information, see dbAlignmentType.
railRef	Alignment type of reference of the rail geometry. For more information, see dbAlignmentType.
layer	Layer to be associated with the railDef object.
purpose	Purpose to be associated with the railDef object.
width	Width of rail geometry.
offset	Places the rail at the specified distance (in user units) from the two reference points (rail and row). A negative value indicates offsetting the rail below the top/bottom edge of the row and a positive value indicates offsetting the rail above the top/bottom edge.
beginOffset	Offsets or extends the rail by the specified user units from the left edge of the row. A negative value indicates offsetting the rail towards the left side of the left edge of the row and a positive value indicates offsetting the rail towards the right side of the left edge of the row.
endOffset	Offsets or extends the rail by the specified user units from the right edge of the row. A negative value indicates offsetting the rail towards the left side of the right edge of the row and a positive value indicates offsetting the rail towards the right side of the right edge of the row.

Return Value

dbId

Database ID of the created railDef object.

dbCreateRailDefByAttr

dbRailDefId

dbCreateRailDefByAttr(
dbCellViewId      cellViewId,
constString       name,
dbRailDefAttrData *data
);

Description

Creates a railDef object based on the specified attributes.

Arguments

cellViewId	Database ID of a cellview.
name	Name for the railDef object to be created.
*data	Pointer to struct with railDef attributes.

Return Value

dbRailDefId
	Database ID of the created railDef object.

dbFreeRailDefAttrArray

void

dbFreeRailDefAttrArray(
unsigned int      numRailDefAttrDatas,
dbRailDefAttrData *railDefAttrDatas
);

Description

Deallocates the memory allocated for an array of railDef objects.

Arguments

numRailDefAttrDatas	Size of the deallocated memory area.
railDefAttrDatas	Pointer to the memory area to deallocate.

Return Value

No Return Value.

dbGenRailDef

Boolean

dbGenRailDef(
dbGenStateId   pState,
dbId     *pRailDefId
);

Description

Retrieves the ID of the next railDef object from the generator with the given pState. ID of the railDef is returned in pRailDefId.

Arguments

pState	State ID for the generator.
pRailDefId	ID of the next railDef object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next railDef object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGetRailDefAttr

Boolean

dbGetRailDefAttr(
dbRailDefId        railDefId,
dbRailDefAttrData  *data
);

Description

Returns the attributes of the specified railDef object.

Arguments

RailDefId	Database ID of a railDef object.
*data	Pointer to the railDef attributes.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetRailDefFigType

dbRailFigType

dbGetRailDefFigType(
dbRailDefId railDefId
);

Description

Returns the rail figure type for the specified railDef object.

Arguments

railDefId

Database ID of a railDef object.

Return Value

dbRailFigType

Rail figure type for the specified railDefObject.

For more information, see dbRailFigType.

dbSetRailDefFigType

Boolean

dbSetRailDefFigType(
dbRailDefId      railDefId,
dbRailFigType value
);

Description

Sets the rail figure type for the specified railDef object.

Arguments

railDefId

Database ID of a railDef object.

value

Type of railFigType.

For more information, see dbRailFigType.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbStartGenRailDef

dbGenStateId

dbStartGenRailDef(
dbCellViewId cellViewId
);

Description

Initializes a generator for all railDef objects in the specified cellview. A generator state ID is returned, which is used with the dbGenRailDef function.

Arguments

cellViewId

Database ID of a cellview.

Return Value

dbGenStateId

State ID for the generator.

Placement Area Definition Functions

dbAddPlaceAreaBackgroundDef

Boolean

dbAddPlaceAreaBackgroundDef(
dbId  placeAreaId,
dbId  backgroundDef
);

Description

Adds a reference from the placeArea object to the backgroundDef object. A warning message is displayed if the objects are not of the correct type.

Arguments

placeAreaId	Database ID of a placeArea object.
backgroundDef	Database ID of a backgroundDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbAddPlaceAreaCompTypeSetDef

Boolean

dbAddPlaceAreaCompTypeSetDef(
dbId placeAreaId,
dbId compTypeSetDefId
);

Description

Adds a reference from the placeArea object to the compTypeSetDef object. A warning message is displayed if the objects are not of the correct type.

Arguments

placeAreaId	Database ID of a placeArea object.
compTypeSetDefId	Database ID of a compTypeSetDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbAddPlaceAreaRailDef

Boolean

dbAddPlaceAreaRailDef(
dbId placeAreaId,
dbId  railDef
);

Description

Adds a reference from the placeArea to the railDef. A warning message is displayed if the objects are not of the correct type.

Arguments

placeAreaId	Database ID of a placeArea object.
railDef	Database ID of a railDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbAllocPlaceRowAttrArray

dbPlaceRowAttrData*

dbAllocPlaceRowAttrArray(
unsigned int       numPlaceRowAttrs
);

Description

Allocates memory for the array of placeRow attribute data and initializes the memory with zeroes.

Arguments

numPlaceRowAttrs

Number of placeRow attributes to fit in the allocated memory.

Return Value

dbPlaceRowAttrData*

Pointer to the allocated memory area.

dbCreatePlaceArea

dbId

dbCreatePlaceArea(
dbCellViewId cellViewId,
constString   name,
dbDistance widthIn,
dbDistance heightIn,
dbPoint originIn,
dbOrient orientIn,
double utilization
);

Description

Creates a custom placeArea object in the specified cellview.

Arguments

cellViewId	Database ID of a cellview.
name	Name of the placeArea object.
widthIn	Width of the placeArea in user units.
heightIn	Height of the placeArea in user units.
originIn	Origin of the placeArea object.
orientIn	Orientation at the placeArea object. For more information, see dbOrient.
utilization	Specifies the utilization of the placeArea object. This attribute is not being used in Virtuoso.

Return Value

dbId

Database ID of the created placeArea object.

dbFreePlaceRowAttrArray

void

dbFreePlaceRowAttrArray(
unsigned int        numAttrs,
dbPlaceRowAttrData  *attrs
);

Description

Deallocates the memory allocated for an array of placeRow objects.

Arguments

numBackgroundDefAttrDatas

Size of the deallocated memory area.

backgroundDefAttrData

Pointer to the memory area to deallocate.

For more information, see dbBackgroundDefAttrData.

Return Value

No Return Value.

dbGenPlaceArea

Boolean

dbGenPlaceArea(
dbGenStateId pState,
dbId     *pPlcId
);

Description

Retrieves the ID of the next custom placeArea object from the generator with the given pState. ID of the placeArea is returned in pPlcId.

Arguments

pState	State ID for the generator.
pPlcId	ID of the next placeArea object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next placeArea object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenPlaceAreaToBackgroundDef

Boolean

dbGenPlaceAreaToBackgroundDef(
bGenStateId      pState,
dbBackgroundDefId *bgDefId
);

Description

Retrieves the ID of the next backgroundDef object for the placeArea object from the generator with the given pState. ID of the backgroundDef is returned in bgDefId.

Arguments

pState	State ID for the generator.
bgDefId	ID of the next backgroundDef object for the placeArea object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next backgroundDef object for the placeArea object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenPlaceAreaToCompTypeSetDef

Boolean

dbGenPlaceAreaToCompTypeSetDef(
dbGenStateId pState,
dbId     *pCompTypeSetDefId
);

Description

Retrieves the ID of the next allowed compTypeSetDef object for the placeArea object from the generator with the given pState. ID of the placeArea is returned in pCompTypeSetDefId.

Arguments

pState	State ID for the generator.
pCompTypeSetDefId	ID of the next allowed compTypeSetDef object for the placeArea object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next compTypeSetDef object for the placeArea object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenPlaceAreaToRailDef

Boolean

dbGenPlaceAreaToRailDef(
dbGenStateId pState,
dbId *pRailDefId
);

Description

Retrieves the ID of the next railDef object for the placeArea from the generator with the given pState. ID of the placeArea is returned in pRailDefId.

Arguments

pState	State ID for the generator.
pRailDefId	ID of the next railDef object for the placeArea object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next railDef object for the placeArea object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGetPlaceAreaOrient

dbOrient

dbGetPlaceAreaOrient(
dbId placeAreaId
);

Description

Returns the orient attribute for the specified custom placeArea object.

Arguments

placeAreaId

Database ID of a placeArea object.

Return Values

dbOrient

Orientation of the specified placeArea object.

For more information, see dbOrient.

dbGetPlaceAreaUtilization

double

dbGetPlaceAreaUtilization(
dbId placeAreaId
);

Description

Returns the the placement utilization attribute for the specified custom placeArea object.

Arguments

placeAreaId

Database ID of a placeArea object.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbRemovePlaceAreaBackgroundDef

Boolean

dbRemovePlaceAreaBackgroundDef(
dbId                 placeAreaId,
dbBackgroundDefId    bgDefId
);

Description

Removes the specified backgroundDef from the specified placeArea object.

Arguments

placeAreaId	Database ID of a placeArea object.
bgDefId	Database ID of the backgroundDef object to be removed.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbRemovePlaceAreaCompTypeSetDef

Boolean

dbRemovePlaceAreaCompTypeSetDef(
dbId placeAreaId,
dbId    compTypeSetdef
);

Description

Removes the specified compTypeSetDef object from the specified placeArea object.

Arguments

placeAreaId	Database ID of a placeArea object.
compTypeSetDef	Database ID of the compTypeSetDef object to be removed.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbRemovePlaceAreaRailDef

Boolean

dbRemovePlaceAreaRailDef(
dbId placeAreaId,
dbId railDef
);

Description

Removes the specified railDef from the specified placeArea object.

Arguments

placeAreaId	Database ID of a placeArea object.
railDef	Database ID of the railDef object to be removed.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetPlaceAreaOrient

Boolean

dbSetPlaceAreaOrient(
dbId placeAreaId,
dbOrient orientIn
);

Description

Sets the given orientation for the specified placeArea object.

Arguments

placeAreaId

Database ID of a placeArea object.

orientIn

Orientation to be associated with the placeArea object.

For more information, see dbOrient.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetPlaceAreaUtilization

Boolean

dbSetPlaceAreaUtilization(
dbId   placeAreaId,
double    utilization
);

Description

Sets the specified placement utilization attribute for the specified custom placeArea object.

Arguments

placeAreaId	Database ID of a placeArea object.
utilization	Placement utilization attribute to be associated with the placeArea object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbStartGenPlaceArea

dbGenStateId

dbStartGenPlaceArea(
dbCellViewId  cellViewId
);

Description

Initializes a generator for all placeArea objects in the specified cellview. A generator state ID is returned, which is used with the dbGenPlaceArea function.

Arguments

cellViewId

Database ID of a cellview.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenPlaceAreaToBackgroundDef

dbGenStateId

dbStartGenPlaceAreaToBackgroundDef(
dbId placeAreaId
);

Description

Initializes a generator for all backgroundDef objects associated with the specified placeArea object. A generator state ID is returned, which is used with the dbGenPlaceAreaToBackgroundDef function.

Arguments

placeAreaId

Database ID of a placeArea object.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenPlaceAreaToCompTypeSetDef

dbGenStateId

dbStartGenPlaceAreaToCompTypeSetDef(
dbId placeAreaId
);

Description

Initializes a generator for all compTypeSetDef objects associated with the specified placeArea object. A generator state ID is returned, which is used with the dbGenPlaceAreaToCompTypeSetDef function.

Arguments

placeAreaId

Database ID of a placeArea object.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenPlaceAreaToRailDef

dbGenStateId

dbStartGenPlaceAreaToRailDef(
dbId placeAreaId
);

Description

Initializes a generator for all railDefs associated with the specified placeArea object. A generator state ID is returned, which is used with the dbGenPlaceAreaToRailDef function.

Arguments

placeAreaId

Database ID of a placeArea object.

Return Value

dbGenStateId

State ID for the generator.

Row-based Functions

A row object represents a row of sites where a cellview can be placed. A row represents a potential location for placement of standard cells, macros, or devices. A row is defined as an area associated with a siteDef. The siteDef has information allowing for the specification of the objects that can be placed within a row. A row is a repetition of a site element in a given direction (horizontal or vertical).

This section describes the following functions that affect row objects.

dbAddRowBackgroundDef

Boolean

dbAddRowBackgroundDef(
dbRowId rowId
dbId    backgroundDef
);

Description

Adds a reference from the row object to the backgroundDef object. A warning message is displayed if the objects are not of the correct type.

Arguments

rowId	Database ID of a row object.
backgroundDef	Database ID of a backgroundDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbAddRowCompTypeSetDef

Boolean

dbAddRowCompTypeSetDef(
dbRowId   rowId
dbId      compTypeSetDefId
);

Description

Adds the specified compTypeSetDef object to the specified row object. A warning message is displayed if the objects are not of the correct type.

Arguments

rowId	Database ID of a row object.
compTypeSetDefId	Database ID of a compTypeSetDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbAddRowRailDef

Boolean

dbAddRowRailDef(
dbRowId     rowId
dbId        railDefId
);

Description

Adds the specified placement railDef to the specified row.

Arguments

rowId	Database ID of a row object.
railDefId	Database ID of a railDef object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbCreateRow

dbRowId

dbCreateRow( 
dbCellViewId        cellViewId, 
techSiteDefId       siteDefId, 
String              name, 
dbPoint             origin, 
dbOrient            orient, 
dbOrient            siteOrient, 
uint32_t             numSites 
);

Description

Creates a row object with the given attributes in the specified cellview.

Arguments

cellViewId	Database of a cellview.
siteDefId	ID of siteDef to be associated with this row object.
name	Name of the row.
origin	Origin field at the row object.
orient	Orientation at the row object.
siteOrient	Orientation of each site in the row object.
numSites	Number of site placements in the row object.

Return Values

dbRowId

Database ID of the created row object. Otherwise, returns NULL.

dbDeleteRow

Boolean

dbDeleteRow( 
dbRowId      rowId 
);

Description

Deletes specified the row object.

Arguments

rowId

Database ID of the row object.

Return Values

Boolean

TRUE if the row object is successfully deleted.

FALSE, if operation fails.

dbFindRowByName

dbRowId

dbFindRowByName( 
dbCellViewId      cellViewId, 
String            rowName 
);

Description

Searches for the specified row object if a row with the given row name exists in the specified cellview.

Arguments

cellViewId	Database ID of a cellview.
rowName	Name of the row object to be searched.

Return Values

dbRowId

If the object is found, it returns the ID of the row. Otherwise, returns dbcNullId.

dbGenRow

Boolean

dbGenRow( 
dbGenStateId      pState, 
dbRowId           *pRowId 
);

Description

Retrieves the ID of the next row object from the generator with the given pState. ID of the row is returned in pRowId.

Arguments

pState	State ID for the generator.
*pRowId	ID of the next row object produced by the generator. This value is undefined if FALSE is returned.

Return Values

Boolean

TRUE if ID of the next row object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenRowHeaderToRow

Boolean

dbGenRowHeaderToRow( 
dbGenStateId       pState, 
dbRowId           *pRowId 
);

Description

Retrieves the ID of the next row object with the given rowHeader from the generator with the given pState. ID of the row is returned in pRowId.

Arguments

pState	State ID for the generator.
*pRowId	ID of the next row with the given rowHeader produced by the generator. This value is undefined if FALSE is returned.

Return Values

Boolean

TRUE if ID of the next row object with the given rowHeader is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenRowToBackgroundDef

Boolean

dbGenRowToBackgroundDef(
dbGenStateId        pState,
dbBackgroundDefId   *bgDefId
);

Description

Retrieves the ID of the next backgroundDef object for the specified row object from the generator with the given pState. ID of the backgroundDef is returned in bgDefId.

Arguments

pState	State ID for the generator.
bgDefId	ID of the next backgroundDef object for the specified row object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next backgroundDef for the specified row object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenRowToCompTypeSetDef

Boolean

dbGenRowToCompTypeSetDef(
dbGenStateId pState,
dbId *pCompTypeSetDefId
);

Description

Retrieves the ID of the next the allowed compTypeSetDef object associated with the specified row object from the generator with the given pState. ID of the backgroundDef object is returned in pCompTypeSetDefId.

Arguments

pState	State ID for the generator.
bgDefId	ID of the next allowed compTypeSetDef object associated with the specified row object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next allowed compTypeSetDef object associated with the specified row object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenRowToRailDef

Boolean

dbGenRowToRailDef(
dbGenStateId    pState
dbId            *pRailDefId
);

Description

Retrieves the ID of the next railDef object associated with the specified row object from the generator with the given pState. ID of the backgroundDef is returned in pRailDefId.

Arguments

pState	State ID for the generator.
pRailDefId	ID of the next railDef object associated with the specified row object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if ID of the next railDef object associated with the specified row object is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGetRow

Boolean

dbGetRow( 
dbRowId           rowId, 
String            *rowName, 
dbPoint           *origin 
dbOrient          *orient, 
dbSiteDefId       *pSiteDefId, 
dbOrient          *siteOrient, 
uint32_t          *numSites 
);

Description

Returns the attributes for the specified row object in the output parameters rowName, origin, orient, pSiteDefId, siteOrient and numSites.

Arguments

rowId	Database ID of a row object.
*rowName	Pointer to the name of the row object.
*origin	Pointer to the origin point for the row object.
*orient	Pointer to the orientation attribute for the row object.
*pSiteDefId	Pointer to the siteDef associated with the row object.
*siteOrient	Pointer to the orientation of the site which is associated with the row object.
*numSites	Pointer to the number of sites for the row object.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbStartGenRowToCompTypeSetDef

dbGenStateId

dbStartGenRowToCompTypeSetDef(
dbRowId rowId
);

Description

Initializes a generator for all compTypeSetDef objects associated with the specified row object. A generator state ID is returned, which is used with the dbGenRowToCompTypeSetDef function.

Arguments

rowId

Database ID of a row object.

Return Value

dbGenStateId

State ID for the generator.

dbGetRowName

String

dbGetRowName( 
dbRowId      rowId 
);

Description

Returns the name for the specified row object.

Arguments

rowId

Database ID of a row object.

Return Values

String

Name for the row object.

dbGetRowNumSites

Boolean

dbGetRowNumSites( 
dbRowId        rowId,
uint32_t*      numSites
);

Description

Returns the number of sites for the row object specified by rowId via the output parameter numSites.

Arguments

rowId	Database ID of a row object.
numSites	Pointer to the number of sites for the row object.

Return Values

Boolean

TRUE if the number of sites for the row object specified is successfully returned.

FALSE if the operation fails.

dbGetRowSiteOrient

Boolean

dbGetRowSiteOrient( 
dbRowId        rowId, 
dbOrient*      rowSiteOrient 
);

Description

Returns the site orientation of the specified row.

Arguments

rowId	Database ID for the row object.
rowSiteOrient	Pointer to the site orientation for the row object.

Return Values

Boolean

TRUE if the site orientation for the specified row is successfully returned.

FALSE if the operation fails.

dbGetRowOrient

Boolean

dbGetRowOrient( 
dbRowId       rowId, 
dbOrient*     orient 
);

Description

Returns the orient attribute for the row specified in rowId.

Arguments

rowId	Database ID of a row object`.`
orient	Pointer to the orientation attribute for the row.

Return Values

Boolean

TRUE if the orient for the row specified in rowId was successfully returned.

FALSE if the operation fails.

dbGetRowOrigin

Boolean

dbGetRowOrigin( 
dbRowId       rowId, 
dbPoint*      rowOrigin 
);

Description

Returns the origin for the specified row.

Arguments

rowId	Database of a row object.
rowOrigin	Pointer to the origin for the row object.

Return Values

Boolean

TRUE if the origin for the specified row is successfully returned.

FALSE if the operation fails.

dbGetRowRowHeader

dbRowHeaderId

dbGetRowRowHeader( 
dbRowId      rowId 
);

Description

Returns the rowHeader associated with the specified row.

Arguments

rowId

Database of a row object.

Return Values

dbRowHeaderId

Returns the rowHeader associated for the specified row.

dbGetRowSiteDef

techSiteDefId

dbGetRowSiteDef( 
dbRowId      rowId 
);

Description

Returns the siteDef associated with the specified row.

Arguments

rowId

Database ID for a row object.

Return Values

techSiteDefId

Returns the siteDef for the specified row.

dbGetRowSiteDefName

String

dbGetRowSiteDefName( 
dbRowId      rowId 
);

Description

Returns the name of the siteDef associated with the specified row object.

Arguments

rowId

Database ID of a row object.

Return Values

String

Returns the name of the siteDef for the specified row object.

dbGetRowSiteOrient

Boolean

dbGetRowSiteOrient( 
dbRowId        rowId, 
dbOrient*      rowSiteOrient 
);

Description

Returns the site orientation of the specified row.

Arguments

rowId	Database ID of a row object.
rowSiteOrigin	Pointer to the site orientation for the row object.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetRowUtilization

double

dbGetRowUtilization(
dbRowId     rowId
);

Description

Returns the placement utilization attribute for the specified row.

Arguments

rowId

Database ID of a row object.

Return Values

double

Placement utilization attribute for the specified row.

dbIsRowBound

Boolean

dbIsRowBound( 
dbRowId      rowId 
);

Description

Checks if the siteDef associated with the row is currently bound to the master.

Arguments

rowId

Database ID of a row object.

Return Values

Boolean

TRUE if the siteDef associated with the row is bound to the master.

FALSE if the siteDef associated with the row is not bound to the master.

dbIsRowId

Boolean

dbIsRowId( 
dbRowId      rowId 
);

Description

Verifies that the specified rowId refers to a valid row object.

Arguments

rowId

Database ID of a row object.

Return Values

Boolean

TRUE if the specified rowId refers to a valid row object.

FALSE if the specified rowId does not refers to a valid row object.

dbRemoveRowBackgroundDef

Boolean

dbRemoveRowBackgroundDef(
dbRowId rowId,
dbId    backgroundDef
);

Description

Removes the specified placement backgroundDef from the specified row.

Arguments

rowId	Database ID of a row object.
attribute	Database ID of the backgroundDej to be removed.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbRemoveRowCompTypeSetDef

Boolean

dbRemoveRowCompTypeSetDef(
dbRowId     rowId,
dbId        dbCompTypeSetDefId
);

Description

Removes the specified placement compTypeSetDef from the specified row.

Arguments

rowId	Database ID of a row object.
dbCompTypeSetDefId	Database ID of the compTypeSetDef to be removed.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbRemoveRowRailDef

Boolean

dbRemoveRowRailDef(
dbRowId    rowId,
dbId    railDefId
);

Description

Removes the specified placement railDef from the specified row.

Arguments

rowId	Database ID of a row object.
railDefId	Database ID of the railDef to be removed.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetRowName

Boolean

dbSetRowName( 
dbRowId      rowId, 
String       rowName 
);

Description

Sets given name for the specified row object.

Arguments

rowId	Database ID of a row object.
rowName	Name to be given to the specified row.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetRowNumSites

Boolean

dbSetRowNumSites( 
dbRowId       rowId,
uint32_t      numSites 
);

Description

Sets the number of sites for the specified row object.

Arguments

rowId	Database ID of a row object.
numSites	Number of sites associated with the row to be set for the row object.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetRowOrient

Boolean

dbSetRowOrient( 
dbRowId       rowId, 
dbOrient      orient 
);

Description

Sets the orient attribute for the specified row object.

Arguments

rowId

Database ID of a row object.

orient

Orientation of the row.

For more information, see dbOrient.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetRowOrigin

Boolean

dbSetRowOrigin( 
dbRowId      rowId,
dbPoint      origin 
);

Description

Sets the origin attribute for the specified row object.

Arguments

rowId	Database ID of a row object.
origin	Origin point of the row object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetRowSiteDef

Boolean

dbSetRowSiteDef( 
dbRowId            rowId, 
techSiteDefId      siteDefId 
);

Description

Sets the siteDef for the specified row object.

Arguments

rowId	Database ID of a row object.
siteDefId	Database ID for the siteDef to be set.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetRowSiteOrient

Boolean

dbSetRowOrient( 
dbRowId       rowId, 
dbOrient      siteOrient 
);

Description

Sets the orientation of the site associated with the specified row object.

Arguments

rowId	The database `dbRowId` for the row object.
siteOrient	The orientation of the site associated with the row.

Return Values

Boolean

TRUE if the site orientation for rowId is successfully set.

FALSE if the operation fails.

dbSetRowUtilization

Boolean

dbSetRowUtilization(
dbRowId    rowId
double     utilization
);

Description

Sets the placement utilization attribute for the specified row.

Arguments

rowId

Database ID of a row object.

utilization

Placement utilization attribute to be associated with the row object.

Valid values: Number between 0 and 1. Not used by Virtuoso.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbStartGenRow

dbGenStateId

dbStartGenRow( 
dbCellViewId      cellViewId 
);

Description

Initializes a generator for all rows in the specified cellview. A generator state ID is returned, which is used with the dbGenRow function.

Arguments

cellViewId

Database ID of a cellview.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenRowHeaderToRow

dbGenStateId

dbStartGenRowHeaderToRow( 
dbRowHeaderId      rowHeaderId 
);

Description

Initializes a generator for all rows associated with the specified rowHeader. A generator state ID is returned, which is used with the dbGenRowToBackgroundDef function.

Arguments

rowHeaderId

Database ID of a rowHeader.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenRowToBackgroundDef

dbGenStateId

dbStartGenRowToBackgroundDef(
dbRowId    rowId
);

Description

Initializes a generator for all backgroundDefs associated with the specified row. A generator state ID is returned, which is used with the dbGenRowToBackgroundDef function.

Arguments

placeAreaId

Database ID of a row.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenRowToRailDef

dbGenStateId

dbStartGenRowToRailDef(
dbRowId    rowId
);

Description

Initializes a generator for all railDefs associated with the specified row object. A generator state ID is returned, which is used with the dbGenRowToRailDef function.

Arguments

rowId

Database ID of a row object.

Return Value

dbGenStateId

State ID for the generator.

Row Region Specification Functions

dbCreateRowRegionSpec

dbRowRegionSpecId

dbCreateRowRegionSpec(
dbCellViewId          cellViewId,
constString           name,
unsigned int          height,
dbPlaceRowAttrData    *placeRowAttrs,
unsigned int          numPlaceRowAttrs,
constString           xRefName,
constString           yRefName,
int                   xOffset,
int                   yOffset,
constString           relSPName
);

Description

Creates a rowRegionSpec in the specified cellview.

A rowRegionSpec describes a list of rows, where each row can be either a dbRow or a dbPlaceArea:

dbRow - Needs siteDef from techDB
dbPlaceArea - Does not need a siteDef from the techDB

Arguments

cellViewId	Database ID of a cellview.
name	Name of the rowRegionSpec.
height	Height of one complete instance of the rowRegionSpec used to create one row.
placeRowAttrs	Array of structs with the placement row attributes. Each array entry describes one row. For more information, see dbPlaceRowAttrData .
numPlaceRowAttrs	PlaceRowAttrData array.
xRefName	Name of reference grid in the X direction
yRefName	Name of reference grid in the Y direction
xOffset	List of the offsets from the reference grids in X direction.
yOffset	List of the offsets from the reference grids in Y direction.
relSPName	Name of relatedSnapPattern.

Return Value

dbRowRegionSpecId

Database ID of the rowRegionSpec that is created.

dbDeleteRowRegionSpec

Boolean

dbDeleteRowRegionSpec(
dbRowRegionSpecId rowRegionSpec
);

Description

Deletes a rowRegionSpec object with the specified database ID.

Arguments

rowRegionSpec

Database ID of a rowRegionSpec object.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbFindRowRegionSpec

dbRowRegionSpecId

dbFindRowRegionSpec(
dbCellViewId cellViewId,
constString  name
);

Description

Searches for a rowRegionSpec with the specified name in the given cellview.

Arguments

cellViewId	Database ID of a cellview.
name	Name of a rowRegionSpec.

Return Value

dbRowRegionSpecId

Database ID of the searched rowRegionSpec, if found. Otherwise, returns dbcNullId.

dbGenRowRegionSpecs

Boolean

dbGenRowRegionSpecs(
dbGenStateId stateId,
dbRowRegionSpecId *objId
);

Description

Retrieves the ID of the next rowRegionSpec object from the generator with the given stateId. ID of the rowRegionSpec object is returned in objId.

Arguments

pState	State ID for the generator.
objId	ID of the next rowRegionSpec object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if the next rowRegionSpec ID is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenRowRegionSpecToRowRegion

Boolean

dbGenRowRegionSpecToRowRegion(
dbGenStateId  stateId,
dbRowRegionId *objId
);

Description

Retrieves the ID of the next rowRegion object associated with a given rowRegionSpec from the generator with the given stateId. ID of the rowRegion object is returned in objId.

Arguments

pState	State ID for the generator.
objId	ID of the next rowRegion object associated with a given rowRegionSpec produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if the next rowRegion ID is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGetRowRegionSpecGrids

Boolean

dbGetRowRegionSpecGrids(
dbRowRegionSpecId objId,
String            *refGridX,
String            *refGridY
);

Description

Returns the reference grid of the specified rowRegionSpec in the X and Y direction.

Arguments

objId	Database ID of a rowRegionSpec object.
*refGridX	Pointer to the reference grid of the rowRegionSpec in X direction.
*refGridY	Pointer to the reference grid of the rowRegionSpec in Y direction

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetRowRegionSpecHeight

unsigned int

dbGetRowRegionSpecHeight(
dbRowRegionSpecId objId
);

Description

Returns the height of the specified rowRegionSpec.

Arguments

objId

Database ID of a rowRegionSpec object.

Return Values

unsigned int

Height of the rowRegionSpec object.

dbGetRowRegionSpecName

String

dbGetRowRegionSpecName(
dbRowRegionSpecId objId
);

Description

Returns the name of the specified rowRegionSpec.

Arguments

objId

Database ID of a rowRegionSpec object.

Return Values

String

Name of the rowRegionSpec object.

dbGetRowRegionSpecOffsets

Boolean

dbGetRowRegionSpecOffsets(
dbRowRegionSpecId objId,
int               *offsetX,
int               *offsetY
);

Description

Returns the reference grid offset of the specified rowRegionSpec in the X and Y direction.

Arguments

objId	Database ID of a rowRegionSpec object.
*offsetX	Pointer to the reference grid offset of the rowRegionSpec in X direction.
*offsetY	Pointer to the reference grid offset of the rowRegionSpec in Y direction

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetRowRegionSpecRelSnapPattern

Boolean

dbGetRowRegionSpecRelSnapPattern(
dbRowRegionSpecId objId,
String            *relSnapPattern
);

Description

Returns the relatedSnapPattern name of the specified rowRegionSpec.

Arguments

objId	Database ID of a rowRegionSpec object.
*relSnapPattern	Pointer to the relatedSnapPattern name of the rowRegionSpec.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetRowRegionSpecRowAttrs

Boolean

dbGetRowRegionSpecRowAttrs(
dbRowRegionSpecId  objId,
dbPlaceRowAttrData **attrArray,
unsigned int       *numAttrs
);

Description

Returns the placement row attributes of the specified rowRegionSpec.

Use the dbFreePlaceRowAttrArray function to free the memory the CDB allocates for the attrArray.

Arguments

objId	Database ID of a rowRegionSpec object.
attrArray	Pointer to the memory area where the array of placement row attributes is placed.
*numAttrs	Number of entries in the array of placement row attributes.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbSetRowRegionSpecGrids

Boolean

dbSetRowRegionSpecGrids(
dbRowRegionSpecId objId,
constString       refGridX,
constString       refGridY
);

Description

Sets the reference grid for the specified rowRegionSpec in the X and Y direction.

Arguments

objId	Database ID of a rowRegionSpec object.
refGridX	Pointer to the reference grid of the rowRegionSpec in X direction.
refGridY	Pointer to the reference grid of the rowRegionSpec in Y direction

Return Values

Boolean

TRUE if the reference grid is set for the specified rowRegionSpec in the X and Y direction.

FALSE if the operation fails.

dbSetRowRegionSpecHeight

Boolean

dbSetRowRegionSpecHeight(
dbRowRegionSpecId objId,
unsigned int      height
);

Description

Sets the height for the specified rowRegionSpec.

Arguments

objId	Database ID of a rowRegionSpec object.
unsigned int	Height that needs to be set for the rowRegionSpec object.

Return Values

Boolean

TRUE if the height is set for the specified rowRegionSpec in the X and Y direction.

FALSE if the operation fails.

dbSetRowRegionSpecOffset

Boolean

dbSetRowRegionSpecOffset(
dbRowRegionSpecId objId,
int               offsetX,
int               offsetY
);

Description

Sets the reference grid offset for the specified rowRegionSpec in the X and Y direction.

Arguments

objId	Database ID of a rowRegionSpec object.
offsetX	Reference grid offset of the rowRegionSpec in X direction.
offsetY	Reference grid offset of the rowRegionSpec in Y direction

Return Values

Boolean

TRUE if the reference grid offset is set for the specified rowRegionSpec in the X and Y direction.

FALSE if the operation fails.

dbSetRowRegionSpecRelSnapPattern

Boolean

dbSetRowRegionSpecRelSnapPattern(
dbRowRegionSpecId objId,
constString       relSnapPattern
);

Description

Sets the relatedSnapPattern name for the specified rowRegionSpec.

Arguments

objId	Database ID of a rowRegionSpec object.
relSnapPattern	Name of relatedSnapPattern to be set for the rowRegionSpec.

Return Values

Boolean

TRUE if relatedSnapPattern is set for the specified rowRegionSpec.

FALSE if the operation fails.

dbSetRowRegionSpecRowAttrs

Boolean

dbSetRowRegionSpecRowAttrs(
dbRowRegionSpecId  objId,
dbPlaceRowAttrData *attrArray,
unsigned int       numAttrs
);

Description

Sets the placement row attributes for the specified rowRegionSpec.

Use the dbAllocPlaceRowAttrDataArray function to allocate the attribute array to fill it before calling this function. You will also need to use dbAllocRailDefAttrArray, dbAllocBackgroundDefAttrArray, and dbAllocCompTypeSetDefAttrArray to fill and allocate the respective arrays with information. The dbFreePlaceRowAttrArray function should be used to free memory allocated to the array.

Arguments

objId	Database ID of a rowRegionSpec object.
attrArray	Pointer to the memory area where the array of placement row attributes is placed.
*numAttrs	Pointer to the memory area where the number of placement row attributes is placed.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbStartGenRowRegionSpecs

dbGenStateId

dbStartGenRowRegionSpecs(
dbCellViewId cellViewId
);

Description

Initializes a generator for all rowRegionSpec objects in the specified cellview. A generator state ID is returned, which is used with the dbGenRowRegionSpecs function.

Arguments

cellViewId

Database ID of a cellview.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenRowRegionSpecToRowRegion

dbGenStateId

dbStartGenRowRegionSpecToRowRegion(
dbRowRegionSpecId specId
);

Description

Initializes a generator for all rowRegion objects associated with the specified rowRegionSpec. A generator state ID is returned, which is used with the dbGenRowRegionSpecToRowRegion function.

Arguments

rowId

Database ID of a rowRegionSpec object.

Return Value

dbGenStateId

State ID for the generator.

dbGetRowRegionSpecPlaceCells

Boolean

dbGetRowRegionSpecPlaceCells(
dbRowRegionSpecId specId,
dbPlaceCellsAttrData *attrs
);

Description

Returns the placeCells attributes of the specified rowRegionSpec.

Arguments

specId

Database ID of a rowRegionSpec object.

*attrs

Pointer to the placeCells attribute name of the rowRegionSpec.

For more information, see dbPlaceCellsAttrData.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the placeCells attribute is not set or if the operation fails.

dbSetRowRegionSpecPlaceCells

Boolean

dbSetRowRegionSpecPlaceCells(
dbRowRegionSpecId specId,
dbPlaceCellsAttrData *attrs
);

Description

Sets the placeCells attributes for the specified rowRegionSpec.

Arguments

specId	Database ID of a rowRegionSpec object.
*attrs	Pointer to the placeCells attribute name of the rowRegionSpec.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbFreePlaceCellsListAttr

void

dbFreePlaceCellsListAttr(
dbPlaceCellsAttrData *attrs
);

Description

Deallocates the memory allocated for an array of placeCells objects.

Arguments

*attrs

Pointer to the memory area to deallocate.

Return Value

None

Row Region Functions

A rowRegion is a figGroup that is created and edited on the canvas. It references a rowRegionSpec.

A rowRegion should match its corresponding rowRegionSpec. However, if the rowRegionSpec is modified, all the rowRegions that reference it will no longer match their specification. In this case, you need to use the dbRebuildRowRegion function to rebuild the rowRegion to match its specification.

dbAttachRowRegionToPRBoundary

Boolean

dbAttachRowRegionToPRBoundary(
dbRowRegionId   rowRegionId
);

Description

Attaches the PRBoundary to the specified rowRegion. Error occurs if the containing cellview does not have a PRBoundary.

The PRBoundary is first detached from any rowRegion it might be attached to before being attached to the specified rowRegion.

Arguments

rowRegionId

Database ID of a rowRegion.

Return Values

Boolean

TRUE if the PRBoundary is attached to the specified rowRegion.

FALSE if the operation fails.

dbCreateRowRegion

dbRowRegionId

dbCreateRowRegion(
dbCellViewId      cellViewId,
constString       name,
dbRowRegionSpecId rowRegionSpecId,
unsigned int      numPoints,
dbPoint           *pointArray,
Boolean           isPartialRowSpec,
dbOrient          orientation
);

Description

Creates a rowRegion object in the specified cellview.

Arguments .

cellViewId	Database ID of a cellview.
name	Name of the rowRegion object.
rowRegionSpecId	Database ID of the rowRegionSpec object to be used to create the rowRegion object.
numPoints	Number of points in pointArray that define the areaBoundary enclosing the rowRegion.
pointArray	Pointer to the point array.
isPartialRowSpec	Boolean specifying whether the fill space of rowRegion should be populated with partial specialization of rowRegionSpec.
orientation	Orientation of the rowRegion object. For more information, see dbOrient.

Return Value

dbRowRegionId

Database ID of the rowRegion that is created.

dbRowRegionPointsCutOut

Boolean

dbRowRegionPointsCutOut(
dbRowRegionId   rowRegionId,
dbBBox          *box
);

Description

Changes the rectilinear specification of the specified rowRegion by cutting out the portion of it defined by the specified box. The box cannot fully cover the current rowRegion and it cannot split it into two or more fully independent rowRegions.

Arguments

rowRegionId	Database ID of a rowRegion.
box	The box to cut out from the current rowRegion.

Value Returned

Boolean	`True` if the rowRegion points were modified successfully.
	`False` if the operation fails.

dbDetachPRBoundaryFromRowRegion

Boolean

dbDetachPRBoundaryFromRowRegion(
dbPRBoundaryId   prBoundaryId
);

Description

Removes the rowRegion attached to the specified PRBoundary. Error occurs if the no rowRegion is attached to the PRBoundary.

Arguments

prBoundaryId

Database ID of a PRBoundary.

Return Values

Boolean

TRUE if the rowRegion is removed from the specified PRBoundary.

FALSE if the operation fails.

dbFindRowRegion

dbRowRegionId

dbFindRowRegion(
dbCellViewId  cellViewId,
constString   name
);

Description

Searches for a rowRegion with the specified name in the given cellview.

Arguments

cellViewId	Database ID of a cellview.
name	Name of a rowRegionSpec.

Return Value

dbRowRegionId

Database ID of the searched rowRegion, if found. Otherwise, returns dbcNullId.

dbFlattenRowRegion

Boolean

dbFlattenRowRegion(
dbId rowRegionId
);

Description

Flattens the rowRegion by removing information related to the associated figGroup and areaBoundary, and retaining information related to rows and other shapes.

Arguments

rowRegionId

Database ID of the rowRegion to be flattened.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGenRowRegionPlaceRows

Boolean

dbGenRowRegionPlaceRows(
dbGenStateId    stateId,
dbId            *placeRowId
);

Description

Retrieves ID of the next placement row associated with the rowRegion from the generator with the given stateId. ID of the rowRegion object is returned in placeRowId.

Arguments

stateId	State ID for the generator.
placeRowId	ID of the next placeRow object associated with a given rowRegion produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if the next rowRegion ID is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGenRowRegions

Boolean

dbGenRowRegions(
dbGenStateId stateId,
dbId         *rowRegionId
);

Description

Retrieves the ID of the next rowRegion object from the generator with the given stateId. ID of the rowRegion object is returned in rowRegionId.

Arguments

stateId	State ID for the generator.
rowRegionId	ID of the next rowRegion object produced by the generator. This value is undefined if FALSE is returned.

Return Value

Boolean

TRUE if the next rowRegion ID is successfully generated.

FALSE if the list is exhausted or an error occurs.

dbGetRowRegionAttachedToPRBoundary

dbRowRegionId

dbGetRowRegionAttachedToPRBoundary(
dbPRBoundaryId prBoundaryId
);

Description

Returns the rowRegion object that is attached to the specified PRBoundary.

Arguments

prBoundaryId	Database ID of a PRBoundary.
*refGridX	Pointer to the reference grid of the rowRegionSpec in X direction.
*refGridY	Pointer to the reference grid of the rowRegionSpec in Y direction

Return Values

dbRowRegionId

Database ID of the rowRegion object that is attached to the specified PRBoundary. Otherwise, returns NULL.

dbGetRowRegionPoints

Boolean

dbGetRowRegionPoints(
dbId         rowRegionId,
unsigned int *numPoints,
dbPoint      **pointArray
);

Description

Returns the points that define the areaBoundary enclosing the rowRegion

Arguments

rowRegionId	Database ID of a rowRegion.
*numPoints	Number of points in pointArray.
**pointArray	Pointer to the point array.

Return Value

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbGetRowRegionRowRegionSpec

dbRowRegionSpecId

dbGetRowRegionRowRegionSpec(
dbId rowRegionId
);

Description

Returns the rowRegionSpec from which the specified rowRegion was generated.

Arguments

rowRegionId

Database ID of a rowRegion.

Return Value

dbRowRegionSpecId

Database ID of the rowRegionSpec from which the specified rowRegion was generated.

dbGetRowRegionUsesPartialRowSpec

Boolean

dbGetRowRegionUsesPartialRowSpec(
dbId rowRegionId
);

Description

Confirms whether the fill space of rowRegion should be populated with partial specialization of rowRegionSpec.

Arguments

rowRegionId

Database ID of a rowRegion.

Return Value

Boolean

TRUE if the fill space of rowRegion is populated with partial specialization of rowRegionSpec.

FALSE if the fill space of rowRegion is not populated with partial specialization of rowRegionSpec.

dbIsRowRegion

Boolean

dbIsRowRegionSpec(
dbId objId
);

Description

Checks if the specified database object is a rowRegion.

Arguments

objId

Database ID of an object.

Return Values

Boolean

TRUE if the object is a rowRegion.

FALSE if the object is not a rowRegion.

dbIsRowRegionAttachedToPRBoundary

Boolean

dbIsRowRegionAttachedToPRBoundary(
dbId rowRegionId
);

Description

Checks if the specified rowRegion is attached to PRBoundary.

Arguments

rowRegionId

Database ID of a rowRegion.

Return Values

Boolean

TRUE if the rowRegion is attached to PRBoundary.

FALSE if the rowRegion is not attached to PRBoundary.

dbRebuildRowRegion

Boolean

dbRebuildRowRegion(
dbId rowRegionId
);

Description

Removes contents of the specified rowRegion and then regenerates it based on the rowRegionSpec associated with it.

Arguments

rowRegionId

Database ID of a rowRegion.

Return Values

Boolean

TRUE if the operation is successful.

FALSE if the operation fails.

dbRowRegionMatchesSpec

Boolean

dbRowRegionMatchesSpec(
dbId rowRegionId
);

Description

Checks whether the rowRegion matches its rowRegionSpec.

A rowRegion does not matches its rowRegionSpec when one of the following is true:

The rowRegionSpec is modified after the rowRegion is created. In this case, the rowRegion should be rebuilt to match it with the new rowRegionSpec.
The row region is modified out of context. For example, one of its rows is modified in an older version of Virtuoso.

Arguments

rowRegionId

Database ID of a rowRegion.

Return Values

Boolean

TRUE if the specified rowRegion matches its rowRegionSpec.

FALSE if specified rowRegion does not match its rowRegionSpec.

dbSetRowRegionPoints

Boolean

dbSetRowRegionPoints(
dbId         rowRegionId,
unsigned int numPoints,
dbPoint      *pointArray
);

Description

Changes the rectilinear specification of the given rowRegion.

Arguments

rowRegionId	Database ID of a rowRegion.
numPoints	Number of points in pointArray.
*pointArray	Pointer to the point array.

Return Values

Boolean

TRUE if the rowRegion points are modified.

FALSE if the operation fails.

dbSetRowRegionRowRegionSpec

Boolean

dbSetRowRegionRowRegionSpec(
dbId              rowRegionId,
dbRowRegionSpecId rowRegionSpecId
);

Description

Sets the given rowRegionSpec as the template for the specified rowRegion.

Arguments

rowRegionId	Database ID of a rowRegion.
rowRegionSpecId	Database ID of a rowRegionSpec.

Return Values

Boolean

TRUE if the given rowRegionSpec is set as the row template for the specified rowRegion.

FALSE if the operation fails.

dbSetRowRegionUsesPartialRowSpec

Boolean

dbSetRowRegionUsesPartialRowSpec(
dbId    rowRegionId,
Boolean value
);

Description

A Boolean indicating whether the population of rowRegion is set to fill the space with partial specialization of rowRegionSpec.

Arguments

rowRegionId	Database ID of a rowRegion.
value	A Boolean that determines whether rowRegion should be set to use partial specialization of rowRegionSpec.

Return Values

Boolean

TRUE if the partial specialization of rowRegionSpec is set or unset.

FALSE if the operation fails.

dbStartGenRowRegionPlaceRows

dbGenStateId

dbStartGenRowRegionPlaceRows(
dbRowRegionId  rowRegionId
);

Description

Initializes a generator for all placement rows scoped to the given rowRegion object. A generator state ID is returned, which is used with the dbStartGenRowRegionPlaceRows function.

Arguments

rowRegionId

Database ID of a rowRegion.

Return Value

dbGenStateId

State ID for the generator.

dbStartGenRowRegions

dbGenStateId

dbStartGenRowRegions(
dbCellViewId cellViewId
);

Description

Initializes a generator for all rowRegion objects. A generator state ID is returned, which is used with the dbGenRowRegions function.

Arguments

cellViewId

Database ID of a cellview.

Return Value

dbGenStateId

State ID for the generator.

Miscellaneous Functions

dbGetPlaceRowSoftwareVersion

unsigned int

dbGetPlaceRowSoftwareVersion(
);

Description

Returns the software version of the placement row infrastructure in the given design.

Arguments

None

Return Value

unsigned int

Software version of the placement row infrastructure.

dbGetPlaceRowDataVersion

unsigned int

dbGetPlaceRowDataVersion(
dbCellViewId cellViewId
);

Description

Returns the data version of the placement row infrastructure in the given design in the specified cellview.

Arguments

cellViewId

Database ID of a cellview.

Return Value

unsigned int

Data version of the placement row infrastructure used in the specified cellview.

dbGetRowRegionDataVersion

unsigned int

dbGetRowRegionDataVersion(
dbCellViewId cellViewId
);

Description

Returns the data version of the row region infrastructure in the given design in the specified cellview.

Arguments

cellViewId

Database ID of a cellview.

Return Value

unsigned int

Data version of the row region infrastructure used in the specified cellview.

dbGetRowRegionSoftwareVersion

unsigned int

dbGetRowRegionSoftwareVersion(
);

Description

Returns the software version of the row region in the given design.

Arguments

None

Return Value

unsigned int

Version of the row region software.

dbIsImplicit

Boolean

dbIsImplicit(
dbId objId
);

Description

Verifies whether the object represented by the specified database ID is implicit. Supported objects: dbRailDef, dbBackgroundDef and dbCompTypeSetDef.

An implicit object is owned by a rowRegion. Implicit objects cannot be modified directly. However, they can be modified indirectly by changing their corresponding attributes in the rowRegionSpec. Otherwise, the rowRegion can be flattened and the objects owned by the rowRegion are no longer implicit.

Arguments

objId

Database ID of the object to be queried.

Return Value

Boolean

TRUE if the object is implict.

FALSE if the object is not implict.

dbIsInRowRegion

Boolean

dbIsInRowRegion(
dbFigId figId
);

Description

Checks if a figure with the given figure database ID belongs to a rowRegion.

Arguments

figId

Database ID of a figure.

Return Value

Boolean

TRUE if the figure exists in or belongs to a rowRegion.

FALSE if the figure does not belong to a rowRegion.

Return to top

Cadence Integrators Toolkit Database ReferenceProduct Version IC23.1, June 2023

8

CDBA Placement Functions

Structs in Placement Infrastructure

dbPlaceCellsAttrData

Enumerated Types and Enumerated Constants used in Placement Infrastructure

Background Definition Functions

dbAllocBackgroundDefAttrArray

Description

Arguments

Return Value

dbCreateBackgroundDef

Description

Arguments

Return Value

dbCreateBackgroundDefByAttr

Description

Arguments

Return Value

dbDeleteBackgroundDef

Description

Arguments

Return Value

dbFreeBackgroundDefAttrArray

Description

Arguments

Return Value

dbGenBackgroundDef

Description

Arguments

Return Value

dbGetBackgroundDefAttr

Description

Arguments

Return Value

dbGetBackgroundDefEnclosure

Description

Arguments

Return Value

dbGetBackgroundDefLP

Description

Arguments

Return Value

dbGetBackgroundDefName

Description

Arguments

Return Value

dbGetBackgroundDefNetName

Description

Arguments

Return Value

dbSetBackgroundDefEnclosures

Description

Arguments

Return Value

dbSetBackgroundDefLP

Description

Arguments

Return Value

dbSetBackgroundDefNetName

Description

Arguments

Return Value

dbStartGenBackgroundDef

Description

Arguments

Return Value

Component Type Set Definition Functions

dbAllocCompTypeSetDefAttrArray

Description

Arguments

Return Value

dbCreateCompTypeSetDef

Description

Arguments

Return Value

dbCreateCompTypeSetDefByAttr

Description

Arguments

Return Value

Cadence Integrators Toolkit Database Reference
Product Version IC23.1, June 2023