x11r4 man page for flattenphfig

FLATTENPHFIG(3) 					  MBK PHYSICAL UTILITY FUNCTIONS					   FLATTENPHFIG(3)

NAME
       flatenphfig - flatten a instance in a figure

ORIGIN
       This  software  belongs	to  the  ALLIANCE CAD SYSTEM developed by the ASIM team at LIP6 laboratory of Universite Pierre et Marie CURIE, in
       Paris, France.

       Web : http://asim.lip6.fr/recherche/alliance/
       E-mail : alliance-users@asim.lip6.fr

SYNOPSYS
       #include "mph.h"
       void flatenphfig(ptfig, insname, concat)
       phfig_list *ptfig;
       char *insname;
       char concat;

PARAMETERS
       ptfig		   Pointer to a physical figure

       insname		   Name of the instance to be flattened

       concat		   Name generation mode

DESCRIPTION
       flatenphfig flattens the instance called insname in the figure pointed to by ptfig. Flattening means  incorporating  the  contents  of  the
       instance in the figure and removing it from its instance list.
       the  concat  argument  can  take  either  the  value  YES  in  which  case  the	name  of  the  object  comming from the instance are named
       insname'X'objectname, where 'X' is the caracter set int the MBK_SEPAR(1) environment variable, or the value NO, and then  the  object  name
       remains	inchanged.  This is quite dangerous since name unicity is no more warrantied, and may cause the flatten to fail. See MBK_SEPAR(1),
       mbkenv(3) and concatname(3) for details.

ERRORS
       No errors can directly result from a call to flatenphfig, but since it uses many other mbk functions, it may be an error starting point.

EXAMPLE
       #include "mph.h"
       void flatten_na2_y_s(ptfig)
       phfig_list *ptfig;
       {
       phins_list *pt;
	  for (pt = ptfig->PHINS; pt; pt = pt->NEXT) /* scan instance list */
	     if (!strcmp(pt->FIGNAME, "na2_y"))
		flatenphfig(ptfig, pt->INSNAME, NO);
       }

SEE ALSO
       mbk(1), mbkenv(3), phfig(3), addphfig(3), getphfig(3), delphfig(3), loadphfig(3), savephfig(3), rflatenphfig(3), MBK_SEPAR(1).

BUG REPORT
       This tool is under development at the ASIM department of the LIP6 laboratory.
       We need your feedback to improve documentation and tools.

ASIM
/LIP6							  October 1, 1997						   FLATTENPHFIG(3)