riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coriolis/kite/doc/man/man3/Kite_VerticalTrack.3

56 lines
1.3 KiB
Groff
Raw Normal View History

Documentation cleanup & rebuild. * Change: In documentation/build.py, more PEP8 & Python 3 future compliance. Correct copy of the tools HTML docs on my laptop, to have a full offline copy of the doc. * New: In documentation/contents/pages/check-toolkit, duplicate the doc from alliance-check-toolkit README. Seems it has been inadvertently removed at some point (?). Have to be careful to maintain in synch with the toolkit. * Change: <tool>/doc/*/SoC.css, use Roboto fonts when availables. * Update: Commit the whole pre-generated docs (Doxygen, Pelican).
2020-11-12 07:22:31 -06:00
.TH "VerticalTrack" 3 "Thu Nov 12 2020" "Version 1.0" "Kite - Detailed Router" \" -*- nroff -*-
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
.ad l
.nh
.SH NAME
VerticalTrack \- Vertical track managment\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBTrack\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual bool \fBisHorizontal\fP () const"
.br
.ti -1c
.RI "virtual bool \fBisVertical\fP () const"
.br
.ti -1c
.RI "virtual unsigned int \fBgetDirection\fP () const"
.br
.ti -1c
.RI "virtual \fBPoint\fP \fBgetPosition\fP (\fBDbU::Unit\fP coordinate) const"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP
Vertical track managment\&.
.SH "Member Function Documentation"
.PP
.SS "bool isHorizontal () const\fC [virtual]\fP"
\fBReturns:\fP \fBtrue\fP if the \fBTrack\fP in horizontal direction\&.
.PP
Implements \fBTrack\fP\&.
.SS "bool isVertical () const\fC [virtual]\fP"
\fBReturns:\fP \fBfalse\fP\&.
.PP
\fBReturns:\fP \fBtrue\fP\&.
.PP
Implements \fBTrack\fP\&.
.SS "unsigned int getDirection () const\fC [virtual]\fP"
\fBReturns:\fP Katabatic::KbVertical\&.
.PP
Implements \fBTrack\fP\&.
.SS "\fBPoint\fP getPosition (\fBDbU::Unit\fP position) const\fC [virtual]\fP"
\fBReturns:\fP the point at \fC\fP(\fBgetAxis()\fP,position)\&.
.PP
Implements \fBTrack\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Kite - Detailed Router from the source code\&.