bbWrapper

Define that this BB replaces another one.
Due to PDK changes, older BBs may need migration to new ones. Using this field allows to define at the definition of the new BB the mapping from the old one. You can change parameters and ports.
Remove the old BB from the PDK, a new definition will be added which gives the replace by.. type of message on its use. This allows designers to quickly migrate their design.
You can use the optional (plain) text content for additional information.

Structure

The attributes and elements are shown below, in a sorted per type fashion.
In case a list is printed after an element, it indicates that you can have many, otherwise it should be a single element. With a optional it tells the element is not required.

<bbWrapper  bb="..."  instargs="..."  layoutargs="..."  ports="..."  scope="..."  setLayoutPort="..." ... > ...
  <sptFooter> ... </sptFooter>    optional
  <sptHeader> ... </sptHeader>    optional
</bbWrapper>

XSD

The schema file can be downloaded or viewed at OptoDesigner.

Details

bb

Name of the BB that will be wrapped. Type bb documentation:

instargs

Arguments used in the call to the new BB

layoutargs

The arguments of the old BB definition, so used in the layout header.

ports

The ports used for connecting the new and old element. this is the old element.

scope

Define the scope of the wrapper; typically this is migrate, which gives a drc::Warn() and calls the new BB. After a longer while, it can be set to fail to indicate it will be removed from the design kit later on.
Use pass to avoid the warnings and simply call the new one behind the scenes.
pxfactory can be used to change / add arguments compared to the pxFactory definitions of elements. It acts as a pass flag, but is more specific in its purpose.
For 'pass', 'pxfactory' and 'migrate' the BB will appear in the element dialog under the foundry; for 'fail' it will be hidden. Type scope documentation: