18 InPlace Cover Obstruction Database Access Functions

The InPlaceCoverObstruction C APIs are used to create or destroy InPlaceCoverObstruction objects and to retrieve or set InPlaceCoverObstruction attributes. This chapter describes the following InPlaceCoverObstruction database C APIs:

dbCreateInPlaceCoverObstruction

Boolean

dbCreateInPlaceCoverObstruction(
dbInstHeaderId instHeaderId,
dbIntRange *maskRange
);

Description

Creates an InPlaceCoverObstruction object on the specified instance header.

Arguments

instHeaderId	ID of an instance header.
*maskRange	Integer mask range (`minMask`, `maxMask`) for the InPlaceCoverObstruction to be created on the instance header.

Return Value

Boolean

TRUE, if the InPlaceCoverObstruction object is created on the specified instance header.

False, if the InPlaceCoverObstruction object is not created on the specified instance header.

Example

dbPoint        origin =  {10, 20};

       dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
       dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
       dbIntRange     range = {dbcClosedRangeType, 1, 4};

       dbCreateInPlaceCoverObstruction(instHeaderId, &range)

The above function is passed an instance header ID along with a closed range of integers with minimum mask value of 1, and maximum mask value of 4, both values inclusive.

dbDestroyInPlaceCoverObstruction

Boolean

dbDestroyInPlaceCoverObstruction(
dbInstHeaderId instHeaderId
);

Description

Destroys an InPlaceCoverObstruction object on the given instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

Boolean	`TRUE`, if the InPlaceCoverObstruction object on the given instance header is destroyed.
	`FALSE`, if the operation fails.

Example

dbPoint        origin =  {10, 20};

       dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

       dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

       if (dbInPlaceCoverObstructionExists((instHeaderId)) {

           dbDestroyInPlaceCoverObstruction(instHeaderId)

Destroys the InPlaceCoverObstruction object on the instance header instHeaderId.

dbGetInPlaceCoverObstructionAbstractFileName

String

dbGetInPlaceCoverObstructionAbstractFileName(
dbInstHeaderId   instHeaderId
);

Description

Returns value of the InPlaceCoverObstruction AbstractFileName attribute for the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

String

Valid value of the InPlaceCoverObstruction AbstractFileName attribute.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range)

dbGetInPlaceCoverObstructionAbstractFileName(instHeaderId)

Returns the InPlaceCoverObstruction AbstractFileName attribute value for the instance header instHeaderId.

dbGetInPlaceCoverObstructionAbstractFilePath

String

dbGetInPlaceCoverObstructionAbstractFilePath(
dbInstHeaderId instHeaderId
);

Description

Returns value of the InPlaceCoverObstruction AbstractFilePath attribute for the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

String

Value of the InPlaceCoverObstruction AbstractFilePath attribute for the specified instance header.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range)

dbGetInPlaceCoverObstructionAbstractFilePath(instHeaderId)

Returns the InPlaceCoverObstruction AbstractFilePath attribute value for the instance header instHeaderId.

dbGetInPlaceCoverObstructionAbstractViewName

String

dbGetInPlaceCoverObstructionAbstractViewName(
dbInstHeaderId      instHeaderId
);

Description

Returns value of the InPlaceCoverObstruction AbstractViewName attribute for the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

String

Value of the AbstractViewName attribute.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range)

dbGetInPlaceCoverObstructionAbstractViewName(instHeaderId)

Returns the InPlaceCoverObstruction AbstractViewName attribute value for the instance header instHeaderId.

dbGetInPlaceCoverObstructionBloat

int

dbGetInPlaceCoverObstructionBloat(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum
);

Description

Returns value of the InPlaceCoverObstruction Bloat attribute from the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.

Return Value

int	Valid Bloat attribute values.
	If the operation fails, returns 0 and displays a warning message.

Example

dbPoint        origin =  {10, 20};
         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};
         
         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbLayer    *layersArray;
         int        num;

         dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

         if (num > 0) {
         dbGetInPlaceCoverObstructionBloat(instHeaderId, layersArray[0]) //
         }

Returns the InPlaceCoverObstruction Bloat attribute value for the instance header instHeaderId on the layer layerArray[0].

dbGetInPlaceCoverObstructionBlockageAttributeValue

float

dbGetInPlaceCoverObstructionBlockageAttributeValue(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum
);

Description

Returns value of the InPlaceCoverObstruction BlockageAttributeValue attribute from the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.

Return Value

float

Valid BlockageAttributeValue values.

If the operation fails, returns 0 and displays a warning message.

Example

dbPoint      origin =  {10, 20};
      dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
      dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
      dbIntRange     range = {dbcClosedRangeType, 1, 4};

      dbCreateInPlaceCoverObstruction(instHeaderId, &range)

      dbLayer    *layersArray;
      int        num;
      dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

      if (num > 0) {
      dbGetInPlaceCoverObstructionBlockageAttributeValue(instHeaderId,       layersArray[0])
      }

Returns the InPlaceCoverObstruction BlockageAttributeValue attribute for the instance header instHeaderId on the layer layerArray[0].

dbGetInPlaceCoverObstructionBlockageModel

dbBlockageModelType
dbGetInPlaceCoverObstructionBlockageModel(
dbInstHeaderId    instHeaderId,
dbLayer          layerNum
);

Description

Returns value of the InPlaceCoverObstruction BlockageModel attribute from the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.

Return Value

dbBlockageModelType
	Valid BlockageModel value.

Example

dbPoint        origin =  {10, 20};
      dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
      dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
      dbIntRange     range = {dbcClosedRangeType, 1, 4};

      dbCreateInPlaceCoverObstruction(instHeaderId, &range)
      dbLayer    *layersArray;
      int        num;

      dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

      if (num > 0) {
      dbGetInPlaceCoverObstructionBlockageModel(instHeaderId, layersArray[0])        // returns a valid value of dbcFullCoverBlockageModel.
      }

Returns the InPlaceCoverObstruction BlockageModel attribute value for the instance header instHeaderId on the layer layerArray[0].

dbGetInPlaceCoverObstructionDoughnutHalo

int

dbGetInPlaceCoverObstructionDoughnutHalo(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum
);

Description

Returns value of the InPlaceCoverObstruction DoughnutHalo attribute from the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.

Return Value

int

Valid DoughnutHalo values.

If the operation fails, returns 0 and displays a warning message.

Example

dbPoint        origin =  {10, 20};
      dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
      dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
      dbIntRange     range = {dbcClosedRangeType, 1, 4};

      dbCreateInPlaceCoverObstruction(instHeaderId, &range)

      dbLayer    *layersArray;
      int        num;

      dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

      if (num > 0) {
      dbGetInPlaceCoverObstructionDoughnutHalo(instHeaderId, layersArray[0])
      }

Returns the InPlaceCoverObstruction DoughnutHalo attribute value for the instance header instHeaderId on the layer layerArray[0].

dbGetInPlaceCoverObstructionLayers

Boolean

dbGetInPlaceCoverObstructionLayers(
dbInstHeaderId    instHeaderId,
int               *num,
dbLayer           **layerNum
);

Description

Returns an array of physical layer numbers in the technology database, with the mask value lying between the minMask and maxMask values.

Arguments

instHeaderId	ID of the instance header on which the InPlaceCoverObstruction object is present.
num	Number of layers in the output dbLayer array.
layerNum	Array of physical layers with mask value in between the `minMask` and `maxMask` value specified at the time of creating the InPlaceCoverObstruction object.

Return Value

Boolean

TRUE, if the InPlaceCoverObstruction object is present on the instance header.

FALSE, if the InPlaceCoverObstruction object is not present on the instance header.

Example

dbPoint        origin =  {10, 20};
       dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);|
       dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
       dbIntRange     range = {dbcClosedRangeType, 1, 4};

       dbCreateInPlaceCoverObstruction(instHeaderId, &range)

       dbLayer    *layersArray;
       int        num;
       dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

Returns a list of physical layer numbers in the technology database for the instance header instHeaderId, with mask value lying between the minimum mask value of 1, and maximum mask value of 4, both values inclusive.

dbGetInPlaceCoverObstructionMaxMask

int

dbGetInPlaceCoverObstructionMaxMask(
dbInstHeaderId      instHeaderId
);

Description

Returns value of the InPlaceCoverObstruction MaxMask attribute from the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

int

Valid integer MaxMask values are returned in case of success.

If the operation fails, returns 0 and displays a warning message.

Example

dbPoint        origin =  {10, 20};

         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbGetInPlaceCoverObstructionMaxMask(instHeaderId) 
         // returns a valid value of 4

dbGetInPlaceCoverObstructionMergeDistance

float

dbGetInPlaceCoverObstructionMergeDistance(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum
):

Description

Returns value of the InPlaceCoverObstruction MergeDistance attribute for the specified instance header on the given layer.

Arguments

lnstHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.

Return Value

float

Valid MergeDistance value.

If the operation fails, returns 0 and displays a warning message.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range)

dbLayer *layersArray;

int num;

dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

if (num > 0) {

    dbGetInPlaceCoverObstructionMergeDistance(instHeaderId, layersArray[0])

Returns the InPlaceCoverObstruction MergeDistance attribute value for the instance header instHeaderId on the layer layerArray[0].

dbGetInPlaceCoverObstructionMinMask

int

dbGetInPlaceCoverObstructionMinMask(
dbInstHeaderId       instHeaderId
);

Description

Returns value of the InPlaceCoverObstruction MinMask attribute from the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

int

Valid MinMask values.

If the operation fails, returns 0 and displays a warning message.

Example

dbPoint        origin =  {10, 20};
         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbGetInPlaceCoverObstructionMinMask(instHeaderId)          
         // returns a valid value of 1

dbGetInPlaceCoverObstructionNeedsRemodeling

Boolean

dbGetInPlaceCoverObstructionNeedsRemodeling(
dbInstHeaderId        instHeaderId
);

Description

Returns value of the InPlaceCoverObstruction NeedsRemodeling attribute from the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

Boolean

Returns TRUE or FALSE.

Example

dbPoint        origin =  {10, 20};

         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbGetInPlaceCoverObstructionNeedsRemodeling(instHeaderId) 
         // returns a valid value of False

dbGetInPlaceCoverObstructionPinRemodeling

dbPinRemodelingType

dbGetInPlaceCoverObstructionPinRemodeling(
dbInstHeaderId     instHeaderId
);

Description

Returns value of the InPlaceCoverObstruction PinRemodeling attribute from the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

dbPinRemodelingType
	Valid PinRemodeling attribute values.

Example

dbPoint        origin =  {10, 20};

         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbGetInPlaceCoverObstructionPinRemodeling(instHeaderId) 
         // returns a valid value of dbcNonePinRemodeling.

dbGetInPlaceCoverObstructionPinCutOut

Boolean

dbGetInPlaceCoverObstructionPinCutOut(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum
);

Description

Returns value of the InPlaceCoverObstruction PinCutOut attribute for the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.

Return Value

Boolean	`TRUE,`if the PinCutOut attribute value for the specified instance is set to `t`.
	`FALSE,`if the PinCutOut attribute value for the specified instance is not set. This is also the default value of the PinCutOut attribute when the InPlaceCoverObstruction is created.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range)

dbLayer *layersArray;

int num;

dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

if (num > 0) {

    dbGetInPlaceCoverObstructionPinCutOut(instHeaderId, layersArray[0])

Returns the InPlaceCoverObstruction PinCutOut attribute value for the instance header instHeaderId on the layer layerArray[0].

dbGetInPlaceCoverObstructionSpacingModel

dbSpacingModelType

dbGetInPlaceCoverObstructionSpacingModel(
dbInstHeaderId   instHeaderId,
dbLayer         layerNum
);

Description

Returns value of the InPlaceCoverObstruction SpacingModel attribute from the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.

Return Value

dbSpacingModelType
	Valid SpacingModel values.

Example

dbPoint        origin =  {10, 20};

         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};
         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbLayer    *layersArray;
         int        num;

         dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

         if (num > 0) {
         dbGetInPlaceCoverObstructionSpacingModel(instHeaderId, layersArray[0]) 
         // returns a valid value of dbcSpacingSpacingModel
         }

dbInPlaceCoverObstructionExists

Boolean

dbInPlaceCoverObstructionExists(
dbInstHeaderId     instHeaderId
);

Description

Checks whether an InPlaceCoverObstruction object is present on the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

Boolean	`TRUE`, if the InPlaceCoverObstruction object is present on the specified instance header.
	`FALSE`, if the InPlaceCoverObstruction object is not present on the specified instance header.

Example

dbPoint        origin =  {10, 20};
         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         if (!dbInPlaceCoverObstructionExists((instHeaderId)) {
         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         }

Checks if an InPlaceCoverObstruction object is present on the instance header instHeaderId. An InPlaceCoverObstruction object is created if it is not present.

dbResetInPlaceCoverObstruction

Boolean

dbResetInPlaceCoverObstruction(
dbInstHeaderId                        instHeaderId,
dbInPlaceCoverObstructionResetParamType resetType
);

Description

Resets the values of the layer blockage parameters.

Arguments

instHeaderId

ID of an instance header.

resetType

An enumerated constant that specifies the reset type.

typedef enum dbInPlaceCoverObstructionResetParamType {
  dbcInPlaceCoverObstructionUnknownResetParam = 0,

  dbcInPlaceCoverObstructionBlockageModelResetParam = 1,

  dbcInPlaceCoverObstructionBloatResetParam = 2,

  dbcInPlaceCoverObstructionDoughnutHaloResetParam = 3,

  dbcInPlaceCoverObstructionSpacingModelResetParam = 4,

  dbcInPlaceCoverObstructionBlockageAttributeValueResetParam = 5,

  dbcInPlaceCoverObstructionMergeDistanceResetParam = 6,

  dbcInPlaceCoverObstructionPinCutOutResetParam = 7

};

Return Value

Boolean	`TRUE`, if the layer blockage type is reset to the specified reset value.
	`FALSE`, if the values of the layer blockage parameter are not reset.

dbSetInPlaceCoverObstructionAbstractFileName

Boolean

dbSetInPlaceCoverObstructionAbstractFileName(
dbInstHeaderId    instHeaderId,
constString        fileName
)

Description

Sets value of the InPlaceCoverObstruction AbstractFileName attribute on the specified instance header.

Arguments

instHeaderId	ID of an instance header.
fileName	A valid AbstractFileName value.

Return Value

Boolean	`TRUE`, if the specified AbstractFileName attribute value is set for the specified instance header.
	`FALSE`, if the operation fails.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range);

dbSetInPlaceCoverObstructionAbstractFileName(instHeaderId, "newFileName");

Sets the InPlaceCoverObstruction AbstractFileName attribute value of "newFileName" for the instance header instHeaderId.

dbSetInPlaceCoverObstructionAbstractFilePath

Boolean

dbSetInPlaceCoverObstructionAbstractFilePath(
dbInstHeaderId instHeaderId,
constString        filePath
);

Description

Sets value of the InPlaceCoverObstruction AbstractFilePath attribute on the specified instance header.

Arguments

instHeaderId	ID of an instance header.
filePath	A valid AbstractFilePath value.

Return Value

Boolean	`TRUE`, if the specified AbstractFilePath attribute value is set for the specified instance header.
	`FALSE`, if the operation fails.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range);

dbSetInPlaceCoverObstructionAbstractFilePath (instHeaderId, "newFilePath");

Sets the InPlaceCoverObstruction AbstractFilePath attribute value of "newFilePath" for the instance header instHeaderId.

dbSetInPlaceCoverObstructionAbstractViewName

Boolean

dbSetInPlaceCoverObstructionAbstractViewName(
dbInstHeaderId instHeaderId,
constString        viewName
)

Description

Sets value of the InPlaceCoverObstruction AbstractViewName attribute on the specified instance header.

Arguments

instHeaderId	ID of an instance header.
viewName	A valid AbstractViewName value.

Return Value

Boolean	`TRUE`, if the specified AbstractViewName attribute value is set for the specified instance header.
	`FALSE`, if the operation fails.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range);

dbSetInPlaceCoverObstructionAbstractViewName (instHeaderId, "newViewName");

Sets the dbSetInPlaceCoverObstruction AbstractViewName attribute value of "newViewName" for the instance header instHeaderId.

dbIsInPlaceCoverObstructionCurrent

Boolean

dbIsInPlaceCoverObstructionCurrent(
dbInstHeaderId     instHeaderId
);

Description

Checks whether the timestamp for the InPlaceCoverObstruction object is in sync with the timestamp of the master design for the given instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

Boolean	`TRUE`, if the timestamps are in sync.
	`FALSE`, if the timestamps are not in sync

Example

dbPoint        origin =  {10, 20};
         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)

         if (!dbIsInPlaceCoverObstructionCurrent(instHeaderId)) {
         dbSetInPlaceCoverObstructionCurrent(instHeaderId)
         }

Checks if the timestamp for the InPlaceCoverObstruction object is current and makes it current if it is not.

dbSetInPlaceCoverObstructionBloat

Boolean

dbSetInPlaceCoverObstructionBloat(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum,
int               value
);

Description

Sets value of the InPlaceCoverObstruction Bloat attribute on the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.
value	A valid Bloat value.

Return Value

Boolean

TRUE, if the InPlaceCoverObstruction Bloat attribute is set on the specified instance header on the given layer.

FALSE, if the operation fails.

Example

dbPoint        origin =  {10, 20};
       dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
       dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
       dbIntRange     range = {dbcClosedRangeType, 1, 4};

       dbCreateInPlaceCoverObstruction(instHeaderId, &range)
       dbLayer    *layersArray;
       int        num;

       dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)
       if (num > 0) {
       dbSetInPlaceCoverObstructionBloat(instHeaderId, layersArray[0], 10)
       }

Sets the InPlaceCoverObstruction Bloat attribute value of 10 for the instance header instHeaderId on the layer layersArray[0].

dbSetInPlaceCoverObstructionBlockageAttributeValue

Boolean

dbSetInPlaceCoverObstructionBlockageAttributeValue(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum,
float             value
);

Description

Sets value of the InPlaceCoverObstruction BlockageAttributeValue attribute on the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.
value	Value of BlockageAttributeValue value that needs to be set.

Return Value

Boolean	`TRUE`, if the specified BlockageAttributeValue is set on the given instance header.
	`FALSE`, if the operation fails.

Example

dbPoint        origin =  {10, 20};
         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbLayer    *layersArray;
         int        num;

         dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)
         if (num > 0) {
         dbSetInPlaceCoverObstructionBlockageAttributeValue(instHeaderId,          layersArray[0], 10.0)
         }

Sets value of the InPlaceCoverObstruction BlockageAttributeValue attribute to 10.0 for the instance header instHeaderId on the layer layersArray[0].

dbSetInPlaceCoverObstructionBlockageModel

Boolean

dbSetInPlaceCoverObstructionBlockageModel(
dbInstHeaderId         instHeaderId,
dbLayer               layerNum,
dbBlockageModelType   value
);

Description

Sets value of the InPlaceCoverObstruction BlockageModel attribute on the specified instance header on the specified layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.
value	Valid BlockageModel value.

Return Value

Boolean	`TRUE`, if the operation is successful.
	`FALSE`, if the operation fails.

Example

dbPoint        origin =  {10, 20};
       dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
       dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
       dbIntRange     range = {dbcClosedRangeType, 1, 4};
      
       dbCreateInPlaceCoverObstruction(instHeaderId, &range)
       dbLayer    *layersArray;
       int        num;
       
       dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)
       if (num > 0) {
       dbSetInPlaceCoverObstructionBlockageModel(instHeaderId, layersArray[0],        dbcDoughnutBlockageModel
       }

Sets value of the InPlaceCoverObstruction BlockageModel attribute to 10 for the instance header instHeaderId on the layer layersArray[0].

dbSetInPlaceCoverObstructionCurrent

Boolean

dbSetInPlaceCoverObstructionCurrent(
dbInstHeaderId     instHeaderId
);

Description

Updates value of the timestamp for the InPlaceCoverObstruction object with the value of the master design timestamp for the specified instance header.

Arguments

instHeaderId

ID of an instance header.

Return Value

Boolean	`TRUE`, if the operation is successful.
	`FALSE`, if the operation fails.

Example

dbPoint        origin =  {10, 20};

         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbSetInPlaceCoverObstructionCurrent(instHeaderId)

Makes the timestamp for the InPlaceCoverObstruction object current.

dbSetInPlaceCoverObstructionDoughnutHalo

Boolean

dbSetInPlaceCoverObstructionDoughnutHalo(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum,
int               value
);

Description

Sets value of the InPlaceCoverObstruction DoughnutHalo attribute on the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.
value	Valid DoughnutHalo value that needs to be set.

Return Value

Boolean	`TRUE`, if the operation is successful.
	`FALSE`, if the operation fails.

Example

dbPoint        origin =  {10, 20};
       dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
       dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
       dbIntRange     range = {dbcClosedRangeType, 1, 4};

       dbCreateInPlaceCoverObstruction(instHeaderId, &range)

       dbLayer    *layersArray;
       int        num;

       dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)
       if (num > 0) {
       dbSetInPlaceCoverObstructionDoughnutHalo(instHeaderId, layersArray[0], 10)
       }

Sets value of the InPlaceCoverObstruction DoughnutHalo attribute to 10 for the instance header instHeaderId on the layer layersArray[0].

dbSetInPlaceCoverObstructionMergeDistance

Boolean

dbSetInPlaceCoverObstructionMergeDistance(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum,
float             value
);

Description

Sets value of the InPlaceCoverObstruction MergeDistance attribute on the specified instance header.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.
value	A valid MergeDistance value.

Return Value

Boolean	`TRUE`, if the specified MergeDistance attribute value is set for the specified instance header.
	`FALSE`, if the operation fails.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range)

dbLayer *layersArray;

int num;

dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

if (num > 0) {

    dbSetInPlaceCoverObstructionMergeDistance(instHeaderId, layersArray[0], 20.0)

Sets value of the InPlaceCoverObstruction MergeDistance attribute to 20.0 for the instance header instHeaderId on the layer layersArray[0].

dbSetInPlaceCoverObstructionNeedsRemodeling

Boolean

dbSetInPlaceCoverObstructionNeedsRemodeling(
dbInstHeaderId     instHeaderId,
Boolean           value
);

Description

Sets value of the InPlaceCoverObstruction NeedsRemodeling attribute on the specified instance header.

Arguments

instHeaderId	ID of an instance header.
value	Valid NeedsRemodeling value.

Return Value

Boolean	`TRUE`, if the operation is successful.
	`FALSE`, if the operation fails.

Example

dbPoint        origin =  {10, 20};
         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

         dbIntRange     range = {dbcClosedRangeType, 1, 4};
         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbSetInPlaceCoverObstructionNeedsRemodeling(instHeaderId, true)

Sets the InPlaceCoverObstruction NeedsRemodeling attribute value to true for the instance header instHeaderId.

dbSetInPlaceCoverObstructionPinCutOut

Boolean

dbSetInPlaceCoverObstructionPinCutOut(
dbInstHeaderId    instHeaderId,
dbLayer           layerNum,
Boolean           value
);

Description

Sets value of the InPlaceCoverObstruction PinCutOut attribute on the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Physical layer number present in the technology file.
value	A valid PinCutOut value.

Return Value

Boolean	`TRUE`, if the specified PinCutOut attribute value is set for the specified instance header.
	`FALSE`, if the operation fails.

Example

dbPoint origin = {10, 20};

dbInstId inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);

dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());

dbIntRange range = {dbcClosedRangeType, 1, 4};

dbCreateInPlaceCoverObstruction(instHeaderId, &range)

dbLayer *layersArray;

int num;

dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)

if (num > 0) {

    dbSetInPlaceCoverObstructionPinCutOut(instHeaderId, layersArray[0], true)

Sets value of the InPlaceCoverObstruction PinCutOut attribute to true for the instance header instHeaderId on the layer layersArray[0].

dbSetInPlaceCoverObstructionPinRemodeling

Boolean

dbSetInPlaceCoverObstructionPinRemodeling(
dbInstHeaderId         instHeaderId,
dbPinRemodelingType   value
);

Description

Sets value of the InPlaceCoverObstruction PinRemodeling attribute on the specified instance header.

Arguments

instHeaderId	ID of an instance header.
value	Valid PinRemodeling value.

Return Value

Boolean	`TRUE`, if the operation is successful.
	`FALSE`, if the operation fails.

Example

dbPoint        origin =  {10, 20};
         dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
         dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
         dbIntRange     range = {dbcClosedRangeType, 1, 4};

         dbCreateInPlaceCoverObstruction(instHeaderId, &range)
         dbSetInPlaceCoverObstructionPinRemodeling(instHeaderId,
         dbcPerimeterOnlyPinRemodeling)

Sets the InPlaceCoverObstruction PinRemodeling attribute value of dbcPerimeterOnlyPinRemodeling for the instance header instHeaderId.

dbSetInPlaceCoverObstructionSpacingModel

Boolean

dbSetInPlaceCoverObstructionSpacingModel(
dbInstHeaderId         instHeaderId,
dbLayer               layerNum,
dbSpacingModelType    value
);

Description

Sets value of the InPlaceCoverObstruction SpacingModel attribute on the specified instance header on the given layer.

Arguments

instHeaderId	ID of an instance header.
layerNum	Name of a physical layer number specified in the technology file.
value	A valid SpacingModel value.

Return Value

Boolean

TRUE, if the InPlaceCoverObstruction SpacingModel attribute value is set on the specified instance header on the given layer.

FALSE, if the operation fails.

Example

dbPoint        origin =  {10, 20};
       dbInstId       inst = dbCreateInst(cv, master, "inst", origin, dbcR0, 1);
       dbInstHeaderId instHeaderId = dbiGetId(((oaInst*)inst)->getHeader());
       dbIntRange     range = {dbcClosedRangeType, 1, 4};

       dbCreateInPlaceCoverObstruction(instHeaderId, &range)
       dbLayer    *layersArray;
       int        num;

       dbGetInPlaceCoverObstructionLayers(instHeaderId, &num, &layersArray)
       if (num > 0) { dbSetInPlaceCoverObstructionSpacingModel(instHeaderId,        layersArray[0], dbcAsIsSpacingModel)
       }

Sets value of the InPlaceCoverObstruction SpacingModel attribute to dbcAsIsSpacingModel for the instance header instHeaderId on the layer layersArray[0].

Return to top

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

18

InPlace Cover Obstruction Database Access Functions

dbCreateInPlaceCoverObstruction

Description

Arguments

Return Value

Example

dbDestroyInPlaceCoverObstruction

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionAbstractFileName

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionAbstractFilePath

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionAbstractViewName

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionBloat

Description

Arguments

Example

dbGetInPlaceCoverObstructionBlockageAttributeValue

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionBlockageModel

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionDoughnutHalo

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionLayers

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionMaxMask

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionMergeDistance

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionMinMask

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionNeedsRemodeling

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionPinRemodeling

Description

Arguments

Return Value

Example

dbGetInPlaceCoverObstructionPinCutOut

Description

Arguments

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