Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Types | Public Member Functions | Friends | List of all members
cuts::cut_entry_type Class Reference

Internal record that handles a dynamically allocated cut. More...

#include <bayeux/cuts/cut_tools.h>

Inheritance diagram for cuts::cut_entry_type:
datatools::i_tree_dumpable

Public Types

enum  status_type { STATUS_BLANK = 0, STATUS_CREATED = datatools::bit_mask::bit00, STATUS_INITIALIZED = datatools::bit_mask::bit01 }
 Status of the cut entry. More...
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
 Enumeration for standard output streams. More...
 

Public Member Functions

const datatools::propertiesget_cut_config () const
 Return non mutable cut configuration. More...
 
datatools::propertiesgrab_cut_config ()
 Return mutable cut configuration. More...
 
void set_cut_config (const datatools::properties &)
 Set the cut configuration. More...
 
const std::string & get_cut_name () const
 Return the cut name. More...
 
void set_cut_name (const std::string &)
 Set the cut name. More...
 
const std::string & get_cut_id () const
 Return the cut class identifier. More...
 
void set_ptr (i_cut *)
 Set the address of the embedded. More...
 
void set_cut_id (const std::string &)
 Set the cut class identifier. More...
 
bool has_manager () const
 Check the availability of a cut manager. More...
 
void set_manager (cut_manager &)
 Set the cut manager address. More...
 
void set_blank ()
 Set the blank flag. More...
 
void set_created ()
 Set the 'creation' flag. More...
 
void set_initialized ()
 Set the 'initialization' flag. More...
 
void set_uninitialized ()
 Unset the 'initialization' flag. More...
 
bool is_created () const
 Check the 'creation' flag. More...
 
bool is_initialized () const
 Check the 'initialization' flag. More...
 
 cut_entry_type ()
 Constructor. More...
 
bool has_cut () const
 Check is the cut is referenced in the embedded handle. More...
 
const i_cutget_cut () const
 Return a non mutable reference to the cut. More...
 
i_cutgrab_cut ()
 Return a mutable reference to the cut. More...
 
const cut_handle_typeget_cut_handle () const
 Return a non mutable handle to the cut. More...
 
cut_handle_typegrab_cut_handle ()
 Return a mutable handle to the cut. More...
 
cut_handle_typegrab_initialized_cut_handle ()
 Return a mutable handle to the initialized cut. More...
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. More...
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 Constructor. More...
 
virtual ~i_tree_dumpable ()
 Destructor. More...
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 Main new interface method for printing. More...
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 Printing with jsonized options. More...
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 Printing with jsonized options. More...
 
void tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
 
void tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
 
void smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const
 

Friends

class cut_manager
 

Additional Inherited Members

- Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree & empty_options ()
 
static boost::property_tree::ptree make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
 
static std::ostream & last_skip_tag (std::ostream &out_)
 
static std::ostream & skip_tag (std::ostream &out_)
 
static std::ostream & last_tag (std::ostream &out_)
 
static std::ostream & tag (std::ostream &out_)
 

Detailed Description

Internal record that handles a dynamically allocated cut.

It also contains additional setup/status informations.

Member Enumeration Documentation

◆ status_type

Status of the cut entry.

Enumerator
STATUS_BLANK 
STATUS_CREATED 
STATUS_INITIALIZED 

Constructor & Destructor Documentation

◆ cut_entry_type()

cuts::cut_entry_type::cut_entry_type ( )

Constructor.

Member Function Documentation

◆ get_cut()

const i_cut& cuts::cut_entry_type::get_cut ( ) const

Return a non mutable reference to the cut.

◆ get_cut_config()

const datatools::properties& cuts::cut_entry_type::get_cut_config ( ) const

Return non mutable cut configuration.

◆ get_cut_handle()

const cut_handle_type& cuts::cut_entry_type::get_cut_handle ( ) const

Return a non mutable handle to the cut.

◆ get_cut_id()

const std::string& cuts::cut_entry_type::get_cut_id ( ) const

Return the cut class identifier.

◆ get_cut_name()

const std::string& cuts::cut_entry_type::get_cut_name ( ) const

Return the cut name.

◆ grab_cut()

i_cut& cuts::cut_entry_type::grab_cut ( )

Return a mutable reference to the cut.

◆ grab_cut_config()

datatools::properties& cuts::cut_entry_type::grab_cut_config ( )

Return mutable cut configuration.

◆ grab_cut_handle()

cut_handle_type& cuts::cut_entry_type::grab_cut_handle ( )

Return a mutable handle to the cut.

◆ grab_initialized_cut_handle()

cut_handle_type& cuts::cut_entry_type::grab_initialized_cut_handle ( )

Return a mutable handle to the initialized cut.

◆ has_cut()

bool cuts::cut_entry_type::has_cut ( ) const

Check is the cut is referenced in the embedded handle.

◆ has_manager()

bool cuts::cut_entry_type::has_manager ( ) const

Check the availability of a cut manager.

◆ is_created()

bool cuts::cut_entry_type::is_created ( ) const

Check the 'creation' flag.

◆ is_initialized()

bool cuts::cut_entry_type::is_initialized ( ) const

Check the 'initialization' flag.

◆ set_blank()

void cuts::cut_entry_type::set_blank ( )

Set the blank flag.

◆ set_created()

void cuts::cut_entry_type::set_created ( )

Set the 'creation' flag.

◆ set_cut_config()

void cuts::cut_entry_type::set_cut_config ( const datatools::properties )

Set the cut configuration.

◆ set_cut_id()

void cuts::cut_entry_type::set_cut_id ( const std::string &  )

Set the cut class identifier.

◆ set_cut_name()

void cuts::cut_entry_type::set_cut_name ( const std::string &  )

Set the cut name.

◆ set_initialized()

void cuts::cut_entry_type::set_initialized ( )

Set the 'initialization' flag.

◆ set_manager()

void cuts::cut_entry_type::set_manager ( cut_manager )

Set the cut manager address.

◆ set_ptr()

void cuts::cut_entry_type::set_ptr ( i_cut )

Set the address of the embedded.

◆ set_uninitialized()

void cuts::cut_entry_type::set_uninitialized ( )

Unset the 'initialization' flag.

◆ tree_dump()

virtual void cuts::cut_entry_type::tree_dump ( std::ostream &  out_ = std::clog,
const std::string &  title_ = "",
const std::string &  indent_ = "",
bool  inherit_ = false 
) const
virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

Friends And Related Function Documentation

◆ cut_manager

friend class cut_manager
friend

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