coriolis/katabatic/doc/man/man3/Katabatic_Observable.3

.TH "Observable" 3 "Thu Nov 12 2020" "Version 1.0" "Katabatic - Routing Toolbox" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Observable \- \fBObserver\fP Design Pattern, Subject part\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBObservable\fP ()"
.br
.ti -1c
.RI "template<typename T > T * \fBgetObserver\fP ()"
.br
.ti -1c
.RI "void \fBaddObserver\fP (\fBBaseObserver\fP *)"
.br
.ti -1c
.RI "void \fBremoveObserver\fP (\fBBaseObserver\fP *)"
.br
.ti -1c
.RI "void \fBnotify\fP (unsigned int flags)"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBObserver\fP Design Pattern, Subject part\&. 

\fBObservable\fP is the implementation of the \fIsubject\fP part of the \fBObserver\fP design pattern\&. For the time beeing it's a simplificated version that allows only one \fBObserver\fP to watch the subject\&.
.PP
\fBObservable\fP is designed to be an attribute of the subject, not one of it's base class\&.
.PP
This implantation is completly generic and has nothing specific to \fBKatabatic\fP\&. It may be moved sometimes in Hurricane at Property level in \fBHurricane::DBo\fP\&.
.PP
\fBNote to Myself:\fP \fBObserver\fP pattern is the one behind signal/slots\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "\fBObservable\fP ()\fC [inline]\fP"
Default and only constructor\&. The copy constructor is disabled (made private and unimplemented)\&. 
.SH "Member Function Documentation"
.PP 
.SS "T * getObserver ()\fC [inline]\fP"
\fBReturns:\fP The (only) observer, \fCNULL\fP if there is none\&. It is the object of which the \fBObserver\fP is an attribute, that is, it's \fIowner\fP, and not the \fBObserver\fP itself which is returned\&. 
.SS "void addObserver (\fBBaseObserver\fP * observer)\fC [inline]\fP"
Adds an observer\&. If more than one is added, throw an error\&. 
.SS "void removeObserver (\fBBaseObserver\fP * observer)\fC [inline]\fP"
Removes an observer\&. If the observer do not belong to this observable, throw an exception\&. 
.SS "void notify (unsigned int flags)\fC [inline]\fP"
Used by the subject to signal a change in it's state to the observers\&. The \fCflags\fP parameter can be used to indicates what kind of change is occuring\&. Values for \fCflags\fP are defined between the subject and the observers\&. 
.PP
References BaseObserver::notify()\&.
.PP
Referenced by AutoSegment::_invalidate(), AutoSegment::_postCreate(), AutoSegment::_preDestroy(), and AutoSegment::revalidate()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Katabatic - Routing Toolbox from the source code\&.
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 "Observable" 3 "Thu Nov 12 2020" "Version 1.0" "Katabatic - Routing Toolbox" \" -- nroff --`
Full update of the generated documentation. 2020-04-27 07:14:03 -05:00			`.ad l`
			`.nh`
			`.SH NAME`
			`Observable \- \fBObserver\fP Design Pattern, Subject part\&.`

			`.SH SYNOPSIS`
			`.br`
			`.PP`
			`.SS "Public Member Functions"`

			`.in +1c`
			`.ti -1c`
			`.RI "\fBObservable\fP ()"`
			`.br`
			`.ti -1c`
			`.RI "template<typename T > T * \fBgetObserver\fP ()"`
			`.br`
			`.ti -1c`
			`.RI "void \fBaddObserver\fP (\fBBaseObserver\fP *)"`
			`.br`
			`.ti -1c`
			`.RI "void \fBremoveObserver\fP (\fBBaseObserver\fP *)"`
			`.br`
			`.ti -1c`
			`.RI "void \fBnotify\fP (unsigned int flags)"`
			`.br`
			`.in -1c`
			`.SH "Detailed Description"`
			`.PP`
			`\fBObserver\fP Design Pattern, Subject part\&.`

			`\fBObservable\fP is the implementation of the \fIsubject\fP part of the \fBObserver\fP design pattern\&. For the time beeing it's a simplificated version that allows only one \fBObserver\fP to watch the subject\&.`
			`.PP`
			`\fBObservable\fP is designed to be an attribute of the subject, not one of it's base class\&.`
			`.PP`
			`This implantation is completly generic and has nothing specific to \fBKatabatic\fP\&. It may be moved sometimes in Hurricane at Property level in \fBHurricane::DBo\fP\&.`
			`.PP`
			`\fBNote to Myself:\fP \fBObserver\fP pattern is the one behind signal/slots\&.`
			`.SH "Constructor & Destructor Documentation"`
			`.PP`
			`.SS "\fBObservable\fP ()\fC [inline]\fP"`
			`Default and only constructor\&. The copy constructor is disabled (made private and unimplemented)\&.`
			`.SH "Member Function Documentation"`
			`.PP`
			`.SS "T * getObserver ()\fC [inline]\fP"`
			`\fBReturns:\fP The (only) observer, \fCNULL\fP if there is none\&. It is the object of which the \fBObserver\fP is an attribute, that is, it's \fIowner\fP, and not the \fBObserver\fP itself which is returned\&.`
			`.SS "void addObserver (\fBBaseObserver\fP * observer)\fC [inline]\fP"`
			`Adds an observer\&. If more than one is added, throw an error\&.`
			`.SS "void removeObserver (\fBBaseObserver\fP * observer)\fC [inline]\fP"`
			`Removes an observer\&. If the observer do not belong to this observable, throw an exception\&.`
			`.SS "void notify (unsigned int flags)\fC [inline]\fP"`
			`Used by the subject to signal a change in it's state to the observers\&. The \fCflags\fP parameter can be used to indicates what kind of change is occuring\&. Values for \fCflags\fP are defined between the subject and the observers\&.`
			`.PP`
			`References BaseObserver::notify()\&.`
			`.PP`
			`Referenced by AutoSegment::_invalidate(), AutoSegment::_postCreate(), AutoSegment::_preDestroy(), and AutoSegment::revalidate()\&.`

			`.SH "Author"`
			`.PP`
			`Generated automatically by Doxygen for Katabatic - Routing Toolbox from the source code\&.`