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

#include <bayeux/geomtools/display_data.h>

Inheritance diagram for geomtools::display_data:
datatools::i_serializable datatools::i_tree_dumpable datatools::i_clear

Classes

struct  display_entry
 
struct  display_item
 
struct  label_item
 

Public Types

enum  display_type { DISPLAY_STATIC = 0, DISPLAY_FRAMED = 1 }
 
enum  display_style_type { DISPLAY_STYLE_UNDEFINED = -1, DISPLAY_STYLE_WIRES = 0 }
 
typedef std::map< int32_t, display_item > items_dict_type
 
typedef std::map< std::string, display_entry > entries_dict_type
 
- 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

void reset ()
 
 display_data ()
 Constructor. More...
 
virtual ~display_data ()
 Destructor. More...
 
virtual void clear ()
 Clear (reset) the object's internals (typically empty a container) More...
 
const std::vector< std::string > & get_colors () const
 
std::vector< std::string > & grab_colors ()
 
const std::vector< std::string > & get_groups () const
 
std::vector< std::string > & grab_groups ()
 
const std::map< std::string, display_entry > & get_entries () const
 
std::map< std::string, display_entry > & grab_entries ()
 
const std::map< int32_t, std::string > & get_frames () const
 
std::map< int32_t, std::string > & grab_frames ()
 
void add_frame_info (int frame_index_, const std::string &frame_info_=0)
 
const datatools::properties & get_auxiliaries () const
 
datatools::properties & grab_auxiliaries ()
 
virtual void tree_dump (std::ostream &a_out=std::clog, const std::string &a_title="", const std::string &a_indent="", bool a_inherit=false) const
 Main old interface method for printing. More...
 
display_item & add_static_item (const std::string &name_, const std::string &group_="", const std::string &color_="")
 
display_item & add_framed_item (const std::string &name_, int frame_, const std::string &group_="", const std::string &color_="", const std::string &frame_info_="")
 
void process ()
 
- Public Member Functions inherited from datatools::i_serializable
 i_serializable ()
 Default constructor. More...
 
virtual ~i_serializable ()
 Destructor. More...
 
virtual const std::string & get_serial_tag () const =0
 Return the serialization string identifier of the class. 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
 
- Public Member Functions inherited from datatools::i_clear
virtual ~i_clear ()
 Destructor. More...
 

Protected Member Functions

display_item & _add_item (const std::string &name_, int entry_type_, int frame_, const std::string &group_, const std::string &color_)
 

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_)
 

Member Typedef Documentation

◆ entries_dict_type

typedef std::map<std::string, display_entry> geomtools::display_data::entries_dict_type

◆ items_dict_type

typedef std::map<int32_t, display_item> geomtools::display_data::items_dict_type

Member Enumeration Documentation

◆ display_style_type

enum geomtools::display_data::display_style_type
Enumerator
DISPLAY_STYLE_UNDEFINED 
DISPLAY_STYLE_WIRES 

◆ display_type

enum geomtools::display_data::display_type
Enumerator
DISPLAY_STATIC 
DISPLAY_FRAMED 

Constructor & Destructor Documentation

◆ display_data()

geomtools::display_data::display_data ( )

Constructor.

◆ ~display_data()

virtual geomtools::display_data::~display_data ( )
virtual

Destructor.

Member Function Documentation

◆ _add_item()

display_item& geomtools::display_data::_add_item ( const std::string &  name_,
int  entry_type_,
int  frame_,
const std::string &  group_,
const std::string &  color_ 
)
protected

◆ add_frame_info()

void geomtools::display_data::add_frame_info ( int  frame_index_,
const std::string &  frame_info_ = 0 
)

◆ add_framed_item()

display_item& geomtools::display_data::add_framed_item ( const std::string &  name_,
int  frame_,
const std::string &  group_ = "",
const std::string &  color_ = "",
const std::string &  frame_info_ = "" 
)

◆ add_static_item()

display_item& geomtools::display_data::add_static_item ( const std::string &  name_,
const std::string &  group_ = "",
const std::string &  color_ = "" 
)

◆ clear()

virtual void geomtools::display_data::clear ( )
virtual

Clear (reset) the object's internals (typically empty a container)

Implements datatools::i_clear.

◆ get_auxiliaries()

const datatools::properties& geomtools::display_data::get_auxiliaries ( ) const

◆ get_colors()

const std::vector<std::string>& geomtools::display_data::get_colors ( ) const

◆ get_entries()

const std::map<std::string, display_entry>& geomtools::display_data::get_entries ( ) const

◆ get_frames()

const std::map<int32_t,std::string>& geomtools::display_data::get_frames ( ) const

◆ get_groups()

const std::vector<std::string>& geomtools::display_data::get_groups ( ) const

◆ grab_auxiliaries()

datatools::properties& geomtools::display_data::grab_auxiliaries ( )

◆ grab_colors()

std::vector<std::string>& geomtools::display_data::grab_colors ( )

◆ grab_entries()

std::map<std::string, display_entry>& geomtools::display_data::grab_entries ( )

◆ grab_frames()

std::map<int32_t,std::string>& geomtools::display_data::grab_frames ( )

◆ grab_groups()

std::vector<std::string>& geomtools::display_data::grab_groups ( )

◆ process()

void geomtools::display_data::process ( )

◆ reset()

void geomtools::display_data::reset ( )

◆ tree_dump()

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

Main old interface method for printing.

Reimplemented from datatools::i_tree_dumpable.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.15