Reference documentation for deal.II version 9.4.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Private Attributes | List of all members
Triangulation< dim, spacedim >::Signals::LegacySignal Class Reference

#include <deal.II/grid/tria.h>

Public Types

using signature_type = unsigned int(const cell_iterator &, const CellStatus)
 
using combiner_type = CellWeightSum< unsigned int >
 
using slot_function_type = boost::function< signature_type >
 
using slot_type = boost::signals2::slot< signature_type, slot_function_type >
 

Public Member Functions

 LegacySignal (boost::signals2::signal< signature_type, combiner_type > &new_signal)
 
 ~LegacySignal ()
 
boost::signals2::connection connect (const slot_type &slot, boost::signals2::connect_position position=boost::signals2::at_back)
 
std::size_t num_slots () const
 
bool empty () const
 
template<typename S >
void disconnect (const S &connection)
 
unsigned int operator() (const cell_iterator &iterator, const CellStatus status)
 

Private Attributes

boost::signals2::connection base_weight
 
boost::signals2::signal< signature_type, combiner_type > & new_signal
 

Detailed Description

template<int dim, int spacedim = dim>
class Triangulation< dim, spacedim >::Signals::LegacySignal

Legacy signal emulation to deprecate the old signal.

Definition at line 2226 of file tria.h.

Member Typedef Documentation

◆ signature_type

template<int dim, int spacedim = dim>
using Triangulation< dim, spacedim >::Signals::LegacySignal::signature_type = unsigned int(const cell_iterator &, const CellStatus)

Definition at line 2229 of file tria.h.

◆ combiner_type

template<int dim, int spacedim = dim>
using Triangulation< dim, spacedim >::Signals::LegacySignal::combiner_type = CellWeightSum<unsigned int>

Definition at line 2231 of file tria.h.

◆ slot_function_type

template<int dim, int spacedim = dim>
using Triangulation< dim, spacedim >::Signals::LegacySignal::slot_function_type = boost::function<signature_type>

Definition at line 2233 of file tria.h.

◆ slot_type

template<int dim, int spacedim = dim>
using Triangulation< dim, spacedim >::Signals::LegacySignal::slot_type = boost::signals2::slot<signature_type, slot_function_type>

Definition at line 2234 of file tria.h.

Constructor & Destructor Documentation

◆ LegacySignal()

template<int dim, int spacedim = dim>
Triangulation< dim, spacedim >::Signals::LegacySignal::LegacySignal ( boost::signals2::signal< signature_type, combiner_type > &  new_signal)
inline

Constructor.

Definition at line 2240 of file tria.h.

◆ ~LegacySignal()

template<int dim, int spacedim = dim>
Triangulation< dim, spacedim >::Signals::LegacySignal::~LegacySignal ( )
inline

Destructor.

Definition at line 2248 of file tria.h.

Member Function Documentation

◆ connect()

template<int dim, int spacedim = dim>
boost::signals2::connection Triangulation< dim, spacedim >::Signals::LegacySignal::connect ( const slot_type slot,
boost::signals2::connect_position  position = boost::signals2::at_back 
)
inline

Connects a function to the signal.

Connects an additional base weight function if signal was previously empty.

Definition at line 2261 of file tria.h.

◆ num_slots()

template<int dim, int spacedim = dim>
std::size_t Triangulation< dim, spacedim >::Signals::LegacySignal::num_slots ( ) const
inline

Returns the number of connected functions without the base weight.

Definition at line 2284 of file tria.h.

◆ empty()

template<int dim, int spacedim = dim>
bool Triangulation< dim, spacedim >::Signals::LegacySignal::empty ( ) const
inline

Checks if there are any connected functions to the signal.

Definition at line 2295 of file tria.h.

◆ disconnect()

template<int dim, int spacedim = dim>
template<typename S >
void Triangulation< dim, spacedim >::Signals::LegacySignal::disconnect ( const S &  connection)
inline

Disconnects a function from the signal.

Also disconnects the base weight function if it is the last connected function.

Definition at line 2313 of file tria.h.

◆ operator()()

template<int dim, int spacedim = dim>
unsigned int Triangulation< dim, spacedim >::Signals::LegacySignal::operator() ( const cell_iterator iterator,
const CellStatus  status 
)
inline

Triggers the signal.

Definition at line 2330 of file tria.h.

Member Data Documentation

◆ base_weight

template<int dim, int spacedim = dim>
boost::signals2::connection Triangulation< dim, spacedim >::Signals::LegacySignal::base_weight
private

Monitors the connection of the base weight function.

Definition at line 2339 of file tria.h.

◆ new_signal

template<int dim, int spacedim = dim>
boost::signals2::signal<signature_type, combiner_type>& Triangulation< dim, spacedim >::Signals::LegacySignal::new_signal
private

Reference to the successor signal.

Definition at line 2344 of file tria.h.


The documentation for this class was generated from the following file: