Product Documentation
Cadence Application Infrastructure SKILL Reference
Product Version IC23.1, November 2023

ccpDmRename

ccpDmRename(
G_src
G_dest
[ ?destLibPath t_destLibPath ]
[ ?whatToUpdate s_whatToUpdate ]
[ ?updateLibList q_updateLibList ]
[ ?existenceCheck x_existenceCheck ]
[ ?reReferenceCustomVias x_reReferenceCustomVias ]
[ ?tag t_tag ]
[ ?description t_description ]
[ ?xtraArgs t_xtraArgs ]
[ ?feedbackStyle x_feedbackStyle ]
[ ?limitChecks x_limitChecks ]
[ ?checkOnly g_checkOnly ]
[ ?returnGdmContext g_returnGdmContext ]
[ ?returnCcpResults g_returnCcpResults ]
[ ?feedbackCallback u_feedbackCallback ]
[ ?doneCallback u_doneCallback ]
[ ?gdmContextCallback u_gdmContextCallback ]
[ ?nconsTag l_nconsTag ]
[ ?dpl l_dpl ]
)
=> t / nil

Description

Renames a specified gdmSpec object representing a cellview. The source object is deleted after a copy is created. When you copy a directory containing the cellview, all files in the directory are copied, regardless of whether they are co-managed or not.

You can set the maximum cell name length allowed by using the CDS_MAX_CELL_NAME_LENGTH environment variable.

Arguments

G_src

Sources gdmSpec object representing a cellview.

G_dest

Specifies gdmSpec object as destination. Must be of the same type as the source object.

?destLibPath t_destLibPath

Specifies the path for the library when renaming creates a new library. The parent directory specified in the path must already exist.

?whatToUpdate s_whatToUpdate

One of the following predefined symbols that tell the cross-reference updater what to update:

  • CCP_UPDATE_COPIED_DATA: Updates cross-references in only the renamed data.
  • CCP_UPDATE_DESTLIB_ONLY: Updates all cross-references in the destination library. This is the default value.
  • CCP_UPDATE_FROM_LIBLIST: Updates cross-references in the libraries you specify in the next argument, q_updateLibList.

?updateLibList q_updateLibList

Takes a gdmSpecList object containing library gdmSpec objects, which specify the libraries in which to update cross-references.

Valid only if the s_whatToUpdate argument has a value of CCP_UPDATE_FROM_LIBLIST. Otherwise, this argument is ignored.

If q_updateLibList is empty and s_whatToUpdate is CCP_UPDATE_FROM_LIBLIST, rename proceeds but no updating is done.

?existenceCheck x_existenceCheck

Sets a flag for the Virtuoso post-copy updater to validate the existence of layers, purposes, viaDefs, and siteDefs in the technology database of the destination library after the copy command is completed. Default is 0.

?reReferenceCustomVias x_reReferenceCustomVias

Sets a flag for the Virtuoso post-copy updater to update custom via definitions to point to cellviews in the destination library. Default is 0.

?tag t_tag

Returns callback functions and final return values.

?description t_description

Displays the DM comment provided while renaming.

?xtraArgs t_xtraArgs

The custom optional arguments of the DMS.

?feedbackStyle x_feedbackStyle

Set of bit flags.

?limitChecks x_limitChecks

Set of bit flags.

?checkOnly g_checkOnly

Enables the checking mode. When set to t, it checks for permissions without renaming. When set to nil, it checks for permissions and then renames when no error is found.

?returnGdmContext g_returnGdmContext

GDM rename context from calling functions.

?returnCcpResults g_returnCcpResults

Final return value details of the rename, as a disembodied property list (DPL).

?feedbackCallback u_feedbackCallback

Callbacks indicating that specific DM rename phases have run.

?doneCallback u_doneCallback

The one-time callback when rename is done, before returning to the calling function.

?gdmContextCallback u_gdmContextCallback

The callback after the GDM context has been defined for the rename operation.

?nconsTag l_nconsTag

Returns object tag with callback functions.

?dpl l_dpl

A disembodied property list (DPL) of arguments that can be assigned, overriding keyword arguments.

Value Returned

t

The object was renamed, and related tasks, such as preserving DM history, were completed successfully.

nil

The object could not be renamed, or one or more of the related tasks failed.

Related Topics

Generic Design Management (GDM) Functions

Name Spaces for Different Data Types

ccpCopy


Return to top
 ⠀
X