jcarr
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
coriolis/kite/doc/latex/annotated.tex

25 lines
4.4 KiB
TeX
Raw Normal View History

Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\subsection{Class List}
Analog integration part II. Analog place & route (slicing tree). * Change: In Hurricane::CellWidget, set the minimal size to 350 pixels to fit my normal DPI secondary screen... * Change: In Hurricane::Error(), reactivate the backtrace generation by default. Seriously slow down the program each time an Error is to be constructed. * Bug: In Analog::Device::preCreate(), check for NULL Technology before attempting to use it. * Change: In Hurricane/Analog, remove all '*Arguments*' classes and their Python interface. It was an obsoleted way of passing devices parameters to the Python layout generators (located in Oroshi). Now we just get them straight from the Device with the getParamter() method. * Change: In CRL::System CTOR, add Python pathes for Oroshi & Karakaze. * Change: In Oroshi/Python/WIP_*.py layout generator scripts, remove all uses of the "Arguments". Directly access the parameters through the device itself. Make the checkCoherency() with identical arguments as of layout(). * New: Bora tool that performs analog place & route. Based on a slicing tree representation. It is the thesis work of Eric Lao. Code beautyfication and some programming cleanup. * New: Karakaze tool, provide the Python base class AnalogDesign used to build an analog design. Create/configure devices and assemble them in a slicing tree. * Change: In Unicorn/cgt.py, display the stack trace in case of an ImportError exception as well as for other exceptions. Add Bora to the set for included tool engines.
2018-10-18 11:10:01 -05:00
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1DataNegociate}{Data\+Negociate}} \\*Algorimthmic datas associated the \mbox{\hyperlink{classKite_1_1TrackSegment}{Track\+Segment}} }{\pageref{classKite_1_1DataNegociate}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1HorizontalTrack}{Horizontal\+Track}} \\*Horizontal track managment }{\pageref{classKite_1_1HorizontalTrack}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1RoutingEvent_1_1Key}{Routing\+Event\+::\+Key}} \\*\mbox{\hyperlink{classKite_1_1RoutingEvent}{Routing\+Event}} cached key for maps }{\pageref{classKite_1_1RoutingEvent_1_1Key}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1KiteEngine}{Kite\+Engine}} \\*The \mbox{\hyperlink{namespaceKite}{Kite}} Tool }{\pageref{classKite_1_1KiteEngine}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1Manipulator}{Manipulator}} \\*Handle \mbox{\hyperlink{classKite_1_1TrackElement}{Track\+Element}} ripup \& topological modifications }{\pageref{classKite_1_1Manipulator}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1NegociateWindow}{Negociate\+Window}} \\*Perform the routing, main \mbox{\hyperlink{classKite_1_1RoutingEvent}{Routing\+Event}} manager }{\pageref{classKite_1_1NegociateWindow}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1RoutingEvent}{Routing\+Event}} \\*Atomic Placement Request for a \mbox{\hyperlink{classKite_1_1TrackSegment}{Track\+Segment}} }{\pageref{classKite_1_1RoutingEvent}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1RoutingEventHistory}{Routing\+Event\+History}} \\*History of \mbox{\hyperlink{classKite_1_1RoutingEvent}{Routing\+Event}} }{\pageref{classKite_1_1RoutingEventHistory}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1RoutingEventLoop}{Routing\+Event\+Loop}} \\*Simple loop dectector for \mbox{\hyperlink{classKite_1_1RoutingEvent}{Routing\+Event}} }{\pageref{classKite_1_1RoutingEventLoop}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1RoutingEventQueue}{Routing\+Event\+Queue}} \\*The priority Queue of \mbox{\hyperlink{classKite_1_1RoutingEvent}{Routing\+Event}} }{\pageref{classKite_1_1RoutingEventQueue}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1RoutingPlane}{Routing\+Plane}} \\*Array of Tracks in one Layer }{\pageref{classKite_1_1RoutingPlane}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1SegmentAction}{Segment\+Action}} \\*Store request for an event to be generated on a \mbox{\hyperlink{classKite_1_1TrackElement}{Track\+Element}} }{\pageref{classKite_1_1SegmentAction}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1SegmentFsm}{Segment\+Fsm}} \\*Pseudo-\/decorator to process a \mbox{\hyperlink{classKite_1_1RoutingEvent}{Routing\+Event}} }{\pageref{classKite_1_1SegmentFsm}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1SegmentObserver}{Segment\+Observer}} \\*Observer on the base Auto\+Segment }{\pageref{classKite_1_1SegmentObserver}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1Session}{Session}} \\*\mbox{\hyperlink{namespaceKite}{Kite}} update \mbox{\hyperlink{classKite_1_1Session}{Session}} }{\pageref{classKite_1_1Session}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1Track}{Track}} \\*Structure managing one routing track }{\pageref{classKite_1_1Track}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1TrackElement}{Track\+Element}} \\*Abstract Class for all Elements inserted inside a \mbox{\hyperlink{classKite_1_1Track}{Track}} }{\pageref{classKite_1_1TrackElement}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1TrackFixedSegment}{Track\+Fixed\+Segment}} \\*\mbox{\hyperlink{classKite_1_1Track}{Track}} elements for fixed wires }{\pageref{classKite_1_1TrackFixedSegment}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1TrackMarker}{Track\+Marker}} \\*Tag part of \mbox{\hyperlink{classKite_1_1Track}{Track}} with a weight }{\pageref{classKite_1_1TrackMarker}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1TrackSegment}{Track\+Segment}} \\*Derived \textbf{ Katabatic\+::\+Auto\+Segment} for the router }{\pageref{classKite_1_1TrackSegment}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKite_1_1VerticalTrack}{Vertical\+Track}} \\*Vertical track managment }{\pageref{classKite_1_1VerticalTrack}}{}
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\end{DoxyCompactList}