Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Public Attributes | List of all members
geomtools::stackable_data Class Reference

Data for stacking along X, Y and/or Z axis. More...

#include <bayeux/geomtools/i_stackable.h>

Inheritance diagram for geomtools::stackable_data:
geomtools::i_stackable datatools::i_tree_dumpable

Public Member Functions

 stackable_data ()
 Constructor. More...
 
virtual ~stackable_data ()
 Destructor. More...
 
bool check (const stackable::stackability_mode flags_=stackable::STACKABILITY_STRONG) const
 
bool is_valid_x () const
 Check the validity of stacking information along the X axis. More...
 
bool is_valid_y () const
 Check the validity of stacking information along the Y axis. More...
 
bool is_valid_z () const
 Check the validity of stacking information along the Z axis. More...
 
bool is_valid () const
 Check the validity of stacking information for all axis. More...
 
bool is_valid_by_axis (axis_type) const
 Check the validity of stacking information for one given axis. More...
 
bool is_valid_weak () const
 Check the validity of stacking information at least for one axis. More...
 
bool is_valid_very_weak () const
 Check if at least one stacking information is set (X/Y/Z, min/max) More...
 
void invalidate ()
 Invalidate. More...
 
virtual double get_xmin () const
 Return the minimum X. More...
 
virtual double get_xmax () const
 Return the maximum X. More...
 
virtual double get_ymin () const
 Return the minimum Y. More...
 
virtual double get_ymax () const
 Return the maximum Y. More...
 
virtual double get_zmin () const
 Return the minimum Z. More...
 
virtual double get_zmax () const
 Return the maximum Z. 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...
 
void dump (std::ostream &out_=std::clog) const
 Print. More...
 
bool initialize (const datatools::properties &config_)
 Initialization. More...
 
void reset ()
 Reset. More...
 
- Public Member Functions inherited from geomtools::i_stackable
 i_stackable ()
 
virtual ~i_stackable ()
 
bool has_xmin () const
 
bool has_xmax () const
 
bool has_ymin () const
 
bool has_ymax () const
 
bool has_zmin () const
 
bool has_zmax () const
 
- 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
 

Public Attributes

double xmin
 Minimum X. More...
 
double xmax
 Maximum X. More...
 
double ymin
 Minimum Y. More...
 
double ymax
 Maximum Y. More...
 
double zmin
 Minimum Z. More...
 
double zmax
 Maximum Z. More...
 

Additional Inherited Members

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

Data for stacking along X, Y and/or Z axis.

Constructor & Destructor Documentation

◆ stackable_data()

geomtools::stackable_data::stackable_data ( )

Constructor.

◆ ~stackable_data()

virtual geomtools::stackable_data::~stackable_data ( )
virtual

Destructor.

Member Function Documentation

◆ check()

bool geomtools::stackable_data::check ( const stackable::stackability_mode  flags_ = stackable::STACKABILITY_STRONG) const

◆ dump()

void geomtools::stackable_data::dump ( std::ostream &  out_ = std::clog) const

Print.

◆ get_xmax()

virtual double geomtools::stackable_data::get_xmax ( ) const
virtual

Return the maximum X.

Implements geomtools::i_stackable.

◆ get_xmin()

virtual double geomtools::stackable_data::get_xmin ( ) const
virtual

Return the minimum X.

Implements geomtools::i_stackable.

◆ get_ymax()

virtual double geomtools::stackable_data::get_ymax ( ) const
virtual

Return the maximum Y.

Implements geomtools::i_stackable.

◆ get_ymin()

virtual double geomtools::stackable_data::get_ymin ( ) const
virtual

Return the minimum Y.

Implements geomtools::i_stackable.

◆ get_zmax()

virtual double geomtools::stackable_data::get_zmax ( ) const
virtual

Return the maximum Z.

Implements geomtools::i_stackable.

◆ get_zmin()

virtual double geomtools::stackable_data::get_zmin ( ) const
virtual

Return the minimum Z.

Implements geomtools::i_stackable.

◆ initialize()

bool geomtools::stackable_data::initialize ( const datatools::properties config_)

Initialization.

◆ invalidate()

void geomtools::stackable_data::invalidate ( )

Invalidate.

◆ is_valid()

bool geomtools::stackable_data::is_valid ( ) const

Check the validity of stacking information for all axis.

◆ is_valid_by_axis()

bool geomtools::stackable_data::is_valid_by_axis ( axis_type  ) const

Check the validity of stacking information for one given axis.

◆ is_valid_very_weak()

bool geomtools::stackable_data::is_valid_very_weak ( ) const

Check if at least one stacking information is set (X/Y/Z, min/max)

◆ is_valid_weak()

bool geomtools::stackable_data::is_valid_weak ( ) const

Check the validity of stacking information at least for one axis.

◆ is_valid_x()

bool geomtools::stackable_data::is_valid_x ( ) const

Check the validity of stacking information along the X axis.

◆ is_valid_y()

bool geomtools::stackable_data::is_valid_y ( ) const

Check the validity of stacking information along the Y axis.

◆ is_valid_z()

bool geomtools::stackable_data::is_valid_z ( ) const

Check the validity of stacking information along the Z axis.

◆ reset()

void geomtools::stackable_data::reset ( )

Reset.

◆ tree_dump()

virtual void geomtools::stackable_data::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.

Member Data Documentation

◆ xmax

double geomtools::stackable_data::xmax

Maximum X.

◆ xmin

double geomtools::stackable_data::xmin

Minimum X.

◆ ymax

double geomtools::stackable_data::ymax

Maximum Y.

◆ ymin

double geomtools::stackable_data::ymin

Minimum Y.

◆ zmax

double geomtools::stackable_data::zmax

Maximum Z.

◆ zmin

double geomtools::stackable_data::zmin

Minimum Z.


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