ccpRename
ccpRename(
G_src
G_dest
[ g_overWrite ]
[ s_expFlag ]
[ s_whatToUpdate ]
[ q_updateLibList ]
[ g_existenceCheck ]
[ g_reReferenceCustomVias ]
)
=> t / nil
Description
Renames a library, cell, view, or file. The source library, cell, view, or file is copied, and then the original one is deleted. When you copy a directory (library, cell, or view), all the 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. Represents the library, cell, view, or file to be renamed.
|
|
G_dest
|
Specifies gdmSpec object as destination. Must be of the same type as the source object. For example, both must be libraries.
|
|
g_overWrite
|
Overwrites the object if it already exists at the destination. If g_overWrite is t and the object is managed and not already checked out, it is checked out by the system.
|
|
s_expFlag
|
Expands the flag options. One of the following predefined symbols:
-
CCP_EXPAND_COMANAGED: Expands a directory and includes only the coManaged and alsoManaged files, which are defined in the dataReg. Illegal if your source gdmSpec object is a file.
Some applications have co-managed files stored at different directory levels. These co-managed files will also be included for copy.
The prop.xx file, which is invalid in OpenAccess libraries, is no longer automatically included in co-managed sets.
The prop.xx file, which is invalid in OpenAccess libraries, is no longer automatically included in co-managed sets. -
CCP_EXPAND_ALL: Expands everything in a directory.
The s_expFlag argument is currently ignored. All the files in the directory are renamed, regardless of whether you specify CCP_EXPAND_COMANAGED or CCP_EXPAND_ALL.
|
|
s_whatToUpdate
|
One of the following predefined symbols, which tells 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. -
CCP_UPDATE_FROM_LIBLIST: Updates cross-references in the libraries you specify in the next argument, q_updateLibList.
This argument is optional; its default value is CCP_UPDATE_COPIED_DATA.
|
|
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.
|
|
g_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.
|
|
g_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.
This argument is typically used with the copy functions and is not needed for expansion functions.
|
Value Returned
|
t
|
The source object was renamed.
|
|
nil
|
The source object could not be renamed.
|
Related Topics
Generic Design Management (GDM) Functions
Name Spaces for Different Data Types
Return to top