\hypertarget{class_s_p_i_c_e_1_1_subckt}{}\section{Subckt Class Reference}
\label{class_s_p_i_c_e_1_1_subckt}\index{Subckt@{Subckt}}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_a6c590c1d92248d6e5f95ea6c470fbb5a}{add\+Comment}} (std\+::string)
\begin{DoxyCompactList}\small\item\em adds a comment to the subckt. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_a7bb4a4532643568ab1ac2c229185a88e}{add\+Instance}} (\mbox{\hyperlink{class_s_p_i_c_e_1_1_instance}{Instance}} $\ast$)
\begin{DoxyCompactList}\small\item\em adds an instance to the subckt. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_ac162264683fa3d9b3384d3e8cc291fa2}{add\+Interface}} (std\+::string)
\begin{DoxyCompactList}\small\item\em adds an interface to the subckt. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_ab3ab147a16bc490ce96db905a4ca271c}{add\+Parameter}} (std\+::string, std\+::string)
\begin{DoxyCompactList}\small\item\em adds a parameter to the subckt. \end{DoxyCompactList}\item 
const std\+::vector$<$ std\+::string $>$ \& \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_aa4a73ef909ceb8d442ed2f205967613a}{get\+Comments}} ()
\begin{DoxyCompactList}\small\item\em returns the comments of the subckt. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_a8e6e58ffab876152a740092520c35d73}\label{class_s_p_i_c_e_1_1_subckt_a8e6e58ffab876152a740092520c35d73}} 
const std\+::vector$<$ \mbox{\hyperlink{class_s_p_i_c_e_1_1_instance}{Instance}} $\ast$ $>$ \& \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_a8e6e58ffab876152a740092520c35d73}{get\+Instances}} ()
\begin{DoxyCompactList}\small\item\em returns the instances of the subckt. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_a5df00fe6eb5e287abef28c76ce88bd1e}\label{class_s_p_i_c_e_1_1_subckt_a5df00fe6eb5e287abef28c76ce88bd1e}} 
const std\+::vector$<$ std\+::string $>$ \& \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_a5df00fe6eb5e287abef28c76ce88bd1e}{get\+Interfaces}} ()
\begin{DoxyCompactList}\small\item\em returns the interfaces of the subckt. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_af55b1fe10eacd22c7ff3544b5ed32ef3}\label{class_s_p_i_c_e_1_1_subckt_af55b1fe10eacd22c7ff3544b5ed32ef3}} 
const std\+::string \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_af55b1fe10eacd22c7ff3544b5ed32ef3}{get\+Name}} ()
\begin{DoxyCompactList}\small\item\em returns the name of the subckt. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_aee7d59083b78d31ac5c19ab508da91e0}\label{class_s_p_i_c_e_1_1_subckt_aee7d59083b78d31ac5c19ab508da91e0}} 
const std\+::map$<$ std\+::string, std\+::string $>$ \& \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_aee7d59083b78d31ac5c19ab508da91e0}{get\+Parameters}} ()
\begin{DoxyCompactList}\small\item\em returns the parameters of the subckt. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt_a5b9ee31a0302af435029f29a93b29d7d}{Subckt}} (std\+::string name)
\begin{DoxyCompactList}\small\item\em creates a new subckt. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class describes a subckt of the global circuit. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_a5b9ee31a0302af435029f29a93b29d7d}\label{class_s_p_i_c_e_1_1_subckt_a5b9ee31a0302af435029f29a93b29d7d}} 
\index{S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}!Subckt@{Subckt}}
\index{Subckt@{Subckt}!S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}}
\subsubsection{\texorpdfstring{Subckt()}{Subckt()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_s_p_i_c_e_1_1_subckt}{Subckt}} (\begin{DoxyParamCaption}\item[{std\+::string}]{name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



creates a new subckt. 


\begin{DoxyParams}{Parameters}
{\em name} & the name of the subckt \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_a6c590c1d92248d6e5f95ea6c470fbb5a}\label{class_s_p_i_c_e_1_1_subckt_a6c590c1d92248d6e5f95ea6c470fbb5a}} 
\index{S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}!add\+Comment@{add\+Comment}}
\index{add\+Comment@{add\+Comment}!S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}}
\subsubsection{\texorpdfstring{add\+Comment()}{addComment()}}
{\footnotesize\ttfamily void add\+Comment (\begin{DoxyParamCaption}\item[{std\+::string}]{comment }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



adds a comment to the subckt. 


\begin{DoxyParams}{Parameters}
{\em comment} & the comment to add.\\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
comments of a subckt are the first lines of the subckt to describe the interfaces of the subckt. 
\end{DoxyNote}
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_a7bb4a4532643568ab1ac2c229185a88e}\label{class_s_p_i_c_e_1_1_subckt_a7bb4a4532643568ab1ac2c229185a88e}} 
\index{S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}!add\+Instance@{add\+Instance}}
\index{add\+Instance@{add\+Instance}!S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}}
\subsubsection{\texorpdfstring{add\+Instance()}{addInstance()}}
{\footnotesize\ttfamily void add\+Instance (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_s_p_i_c_e_1_1_instance}{Instance}} $\ast$}]{instance }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



adds an instance to the subckt. 


\begin{DoxyParams}{Parameters}
{\em instance} & the instance to add. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_ac162264683fa3d9b3384d3e8cc291fa2}\label{class_s_p_i_c_e_1_1_subckt_ac162264683fa3d9b3384d3e8cc291fa2}} 
\index{S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}!add\+Interface@{add\+Interface}}
\index{add\+Interface@{add\+Interface}!S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}}
\subsubsection{\texorpdfstring{add\+Interface()}{addInterface()}}
{\footnotesize\ttfamily void add\+Interface (\begin{DoxyParamCaption}\item[{std\+::string}]{name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



adds an interface to the subckt. 


\begin{DoxyParams}{Parameters}
{\em name} & the name of the interface to add. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_ab3ab147a16bc490ce96db905a4ca271c}\label{class_s_p_i_c_e_1_1_subckt_ab3ab147a16bc490ce96db905a4ca271c}} 
\index{S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}!add\+Parameter@{add\+Parameter}}
\index{add\+Parameter@{add\+Parameter}!S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}}
\subsubsection{\texorpdfstring{add\+Parameter()}{addParameter()}}
{\footnotesize\ttfamily void add\+Parameter (\begin{DoxyParamCaption}\item[{std\+::string}]{name,  }\item[{std\+::string}]{value }\end{DoxyParamCaption})}



adds a parameter to the subckt. 


\begin{DoxyParams}{Parameters}
{\em name} & the name of the parameter to add. \\
\hline
{\em value} & the value of the parameter to add. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_s_p_i_c_e_1_1_subckt_aa4a73ef909ceb8d442ed2f205967613a}\label{class_s_p_i_c_e_1_1_subckt_aa4a73ef909ceb8d442ed2f205967613a}} 
\index{S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}!get\+Comments@{get\+Comments}}
\index{get\+Comments@{get\+Comments}!S\+P\+I\+C\+E\+::\+Subckt@{S\+P\+I\+C\+E\+::\+Subckt}}
\subsubsection{\texorpdfstring{get\+Comments()}{getComments()}}
{\footnotesize\ttfamily const std\+::vector$<$ std\+::string $>$ \& get\+Comments (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



returns the comments of the subckt. 

\begin{DoxyNote}{Note}
comments of a subckt are the first lines of the subckt to describe the interfaces of the subckt. 
\end{DoxyNote}
