coriolis/stratus1/doc/stratus/man_get_ref.tex

52 lines
1.9 KiB
TeX

\subsubsection{Name}
GetRefXY -- Returns the coordinates of a reference
\subsubsection{Synopsys}
\begin{verbatim}
GetRefXY ( pathname, refname )
\end{verbatim}
\subsubsection{Description}
Computation of coordinates.\\
\indent The point returned (object XY) represents the location of the reference of name \verb-refname- within the coodinates system of the top cell. The reference \verb-refname- is instanciated in an instance found thanks to \verb-pathname- which represents an ordered sequence of instances through the hierarchy.
\subsubsection{Parameters}
\begin{itemize}
\item \verb-pathname- : The path in order to obtain, from the top cell, the instance the reference \verb-refname- belongs to
\item \verb-refname- : The name of the reference
\end{itemize}
\subsubsection{Example}
\indent The cell which is being created (the top cell), instanciates a generator with instance name "my\_dpgen\_and2". This generator instanciates an instance called "cell\_1" which the reference "i0\_20" belongs to.
\begin{verbatim}
GetRefXY ( "my_dpgen_and2.cell_1", "i0_20" )
\end{verbatim}
\subsubsection{Errors}
Some errors may occur :
\begin{itemize}
\item \verb-[Stratus ERROR] GetRefXY :-\\\verb-The instance's path must be put with a string.-
\item \verb-[Stratus ERROR] GetRefXY :-\\\verb-The reference must be done with it's name : a string.-
\item \verb-[Stratus ERROR] GetRefXY :-\\\verb-No reference found with name ... in masterCell ...-
\end{itemize}
\begin{htmlonly}
\subsubsection{See Also}
\hyperref[ref]{\emph{Introduction}}{}{Introduction}{secintroduction}
\hyperref[ref]{\emph{Layout}}{}{Layout}{seclayout}
\hyperref[ref]{\emph{PlaceSegment}}{}{PlaceSegment}{secsegment}
\hyperref[ref]{\emph{PlaceContact}}{}{PlaceContact}{seccontact}
\hyperref[ref]{\emph{PlacePin}}{}{PlacePin}{secpin}
\hyperref[ref]{\emph{PlaceRef}}{}{PlaceRef}{secref}
\hyperref[ref]{\emph{CopyUpSegment}}{}{CopyUpSegment}{seccopy}
\end{htmlonly}