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_SegmentObserver.3

36 lines
1.2 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 "SegmentObserver" 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
SegmentObserver \- Observer on the base AutoSegment\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBObserver< class >\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBnotify\fP (unsigned int flags)"
.br
.in -1c
.SH "Detailed Description"
.PP
Observer on the base AutoSegment\&.
The observer that will be hooked into the observable in the associated canonical AutoSegment\&. Used to propagate the invalidation/revalidation events from AutoSegment toward \fBTrackSegment\fP\&.
.PP
As a secondary function, it is used by the \fBSession::lookup()\fP method to quicly retrieve \fBTrackSegment\fP from \fBKatabatic::AutoSegment\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void notify (unsigned int flags)\fC [virtual]\fP"
Implement the asymmetric invalidate/revalidate policy described in \fBKite::Session\fP\&. The invalidate is immediatly passed on while the revalidate is ignored\&.
.PP
Reimplemented from \fBBaseObserver\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Kite - Detailed Router from the source code\&.