Bayeux  3.4.1
Core Foundation library for SuperNEMO
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
geomtools::surrounded_boxed_model Class Reference

A geometry model with a boxed model surrounded by up to 6 other models. More...

#include <bayeux/geomtools/surrounded_boxed_model.h>

Inheritance diagram for geomtools::surrounded_boxed_model:

Classes

struct  surrounding_item
 

Public Types

typedef std::map< int, surrounding_itemsurrounding_dict_type
 
typedef std::map< std::string, int > labels_dict_type
 

Public Member Functions

const std::string & get_material_name () const
 
void set_material_name (const std::string &)
 
virtual const geomtools::boxget_box () const
 
const geomtools::boxget_solid () const
 
void set_surrounded_label (const std::string &label_)
 
const std::string & get_surrounded_label () const
 
void set_surrounded_model (const i_model &model_)
 
const i_modelget_surrounded_model () const
 
size_t get_number_of_surrounding_items () const
 
bool has_surrounding_model (const std::string &label_) const
 
void add_surrounding_model (int pos_, const i_model &, const std::string &label_="")
 
const i_modelget_surrounding_model (int i_) const
 
const surrounding_itemget_surrounding_item (int i_) const
 
const i_modelget_surrounding_model (const std::string &label_) const
 
const surrounding_itemget_surrounding_item (const std::string &label_) const
 
const labels_dict_typeget_surrounding_labels () const
 
const surrounding_dict_typeget_surrounding_items () const
 
 surrounded_boxed_model ()
 Default constructor. More...
 
virtual ~surrounded_boxed_model ()
 Destructor. More...
 
virtual std::string get_model_id () const
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. More...
 

Static Public Member Functions

static const std::vector< std::string > & position_labels ()
 

Static Public Attributes

static const std::string LABEL_PROPERTY_PREFIX
 
static const std::string MODEL_PROPERTY_PREFIX
 
static const std::string SURROUNDED_LABEL
 
static const std::string SURROUNDING_LABEL
 

Protected Member Functions

virtual void _at_construct (const std::string &name_, const datatools::properties &config_, models_col_type *models_=0)
 Construction. More...
 

Detailed Description

A geometry model with a boxed model surrounded by up to 6 other models.

Member Typedef Documentation

◆ labels_dict_type

typedef std::map<std::string, int> geomtools::surrounded_boxed_model::labels_dict_type

◆ surrounding_dict_type

Constructor & Destructor Documentation

◆ surrounded_boxed_model()

geomtools::surrounded_boxed_model::surrounded_boxed_model ( )

Default constructor.

◆ ~surrounded_boxed_model()

virtual geomtools::surrounded_boxed_model::~surrounded_boxed_model ( )
virtual

Destructor.

Member Function Documentation

◆ _at_construct()

virtual void geomtools::surrounded_boxed_model::_at_construct ( const std::string &  name_,
const datatools::properties config_,
models_col_type models_ = 0 
)
protectedvirtual

Construction.

◆ add_surrounding_model()

void geomtools::surrounded_boxed_model::add_surrounding_model ( int  pos_,
const i_model ,
const std::string &  label_ = "" 
)

◆ get_box()

virtual const geomtools::box& geomtools::surrounded_boxed_model::get_box ( ) const
virtual

◆ get_material_name()

const std::string& geomtools::surrounded_boxed_model::get_material_name ( ) const

◆ get_model_id()

virtual std::string geomtools::surrounded_boxed_model::get_model_id ( ) const
virtual

◆ get_number_of_surrounding_items()

size_t geomtools::surrounded_boxed_model::get_number_of_surrounding_items ( ) const

◆ get_solid()

const geomtools::box& geomtools::surrounded_boxed_model::get_solid ( ) const

◆ get_surrounded_label()

const std::string& geomtools::surrounded_boxed_model::get_surrounded_label ( ) const

◆ get_surrounded_model()

const i_model& geomtools::surrounded_boxed_model::get_surrounded_model ( ) const

◆ get_surrounding_item() [1/2]

const surrounding_item& geomtools::surrounded_boxed_model::get_surrounding_item ( int  i_) const

◆ get_surrounding_item() [2/2]

const surrounding_item& geomtools::surrounded_boxed_model::get_surrounding_item ( const std::string &  label_) const

◆ get_surrounding_items()

const surrounding_dict_type& geomtools::surrounded_boxed_model::get_surrounding_items ( ) const

◆ get_surrounding_labels()

const labels_dict_type& geomtools::surrounded_boxed_model::get_surrounding_labels ( ) const

◆ get_surrounding_model() [1/2]

const i_model& geomtools::surrounded_boxed_model::get_surrounding_model ( int  i_) const

◆ get_surrounding_model() [2/2]

const i_model& geomtools::surrounded_boxed_model::get_surrounding_model ( const std::string &  label_) const

◆ has_surrounding_model()

bool geomtools::surrounded_boxed_model::has_surrounding_model ( const std::string &  label_) const

◆ position_labels()

static const std::vector<std::string>& geomtools::surrounded_boxed_model::position_labels ( )
static

◆ set_material_name()

void geomtools::surrounded_boxed_model::set_material_name ( const std::string &  )

◆ set_surrounded_label()

void geomtools::surrounded_boxed_model::set_surrounded_label ( const std::string &  label_)

◆ set_surrounded_model()

void geomtools::surrounded_boxed_model::set_surrounded_model ( const i_model model_)

◆ tree_dump()

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

Smart print.

Member Data Documentation

◆ LABEL_PROPERTY_PREFIX

const std::string geomtools::surrounded_boxed_model::LABEL_PROPERTY_PREFIX
static

◆ MODEL_PROPERTY_PREFIX

const std::string geomtools::surrounded_boxed_model::MODEL_PROPERTY_PREFIX
static

◆ SURROUNDED_LABEL

const std::string geomtools::surrounded_boxed_model::SURROUNDED_LABEL
static

◆ SURROUNDING_LABEL

const std::string geomtools::surrounded_boxed_model::SURROUNDING_LABEL
static

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