TClearable

#include <TClearable.h>

Brief description

A small class representing any object with a “clear()” method.

How to reference this class

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`TClearable <class-tclearable>`

Markdown

[TClearable](#class-tclearable)

Detailed description

Used notably to invoke Domaine_dis_cache::clear() properly at the end of TRUST, but without having to refer to the Domaine_dis_cache class in the MAIN of TRUST, since Domaine_dis_cache is not part of TRUST numerical kernel.

Inherited by

• public : Domaine_dis_cache

Inheritance graph

If the image is too small, right-click and open in new tab

List of Public Methods

• clear

• ~TClearable

List of Public Static Methods

• Clear_all

• Register_clearable

Complete Member Function Documentation

clear

Definition

virtual void TClearable::clear()=0

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`virtual void TClearable::clear()=0 <tclearable-public-virtual-void-tclearable-clear-equal-0>`

Markdown

[virtual void TClearable::clear()=0](#tclearable-public-virtual-void-tclearable-clear-equal-0)

~TClearable

Definition

virtual TClearable::~TClearable()

Brief description

Detailed description

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`virtual TClearable::~TClearable() <tclearable-public-virtual-tclearable-dtor-tclearable>`

Markdown

[virtual TClearable::~TClearable()](#tclearable-public-virtual-tclearable-dtor-tclearable)

Clear_all

Definition

static void TClearable::Clear_all()

Brief description

Detailed description

Clean all registered objects. Typically invoked from TRUST main.

Referenced By

• mon_main::finalize

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`static void TClearable::Clear_all() <tclearable-public-static-static-void-tclearable-clear-all>`

Markdown

[static void TClearable::Clear_all()](#tclearable-public-static-static-void-tclearable-clear-all)

Register_clearable

Definition

static void TClearable::Register_clearable(TClearable *c)

Brief description

Detailed description

Register an object to be cleared

Referenced By

• Domaine_dis_cache::Get_instance

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

RST

:ref:`static void TClearable::Register_clearable(TClearable *c) <tclearable-public-static-static-void-tclearable-register-clearable-tclearable-ptr-c>`

Markdown

[static void TClearable::Register_clearable(TClearable *c)](#tclearable-public-static-static-void-tclearable-register-clearable-tclearable-ptr-c)

Attributes Documentation

to_clear_ (private)

std::list<TClearable *> TClearable::to_clear_

list of objects to be cleared when exiting TRUST