TkN 2.1
Toolkit for Nuclei
tkproperty_list Class Reference

Contains list of properties. More...

Detailed Description

Contains list of properties.

nuclei, levels and decays are storing properties in a tkproperty_list
As the properties available are nucleus/level/decay dependant, this allows to only store the available properties and provide an easy access to it.
An exemple of how to use tkproperty_list elements is given in the tkn::tknucleus documentation. The same applies with levels and decays.

Definition at line 55 of file tkproperty_list.h.

Inheritance diagram for tkproperty_list:
tkdecay tklevel tknucleus tkgammadecay

#include <tkproperty_list.h>

Public Member Functions

 tkproperty_list (tkstring _name)
 
virtual ~tkproperty_list ()=default
 
shared_ptr< tkmeasureget (const tkstring &_property) const
 get the property as tkmeasure More...
 
vector< shared_ptr< tkmeasure > > get_data_properties (const tkstring &_opt="*")
 get a vector of data properties according to a regular expression More...
 
const std::map< tkstring, property_string > get_properties ()
 get the properties map More...
 
tkstring get_property (const tkstring &_property) const
 get the property value as a string More...
 
tkstring get_property_type (const tkstring &_property) const
 get the property type as a string More...
 
tkstring get_property_unit (const tkstring &_property) const
 get the property unnit as a string More...
 
bool has_property (const tkstring &_property) const
 to check if the property is available More...
 
void list_data_properties (const tkstring &_opt="*") const
 list the available tkmeasure properties More...
 
void list_properties (const tkstring &_opt="*") const
 list the available properties More...
 

Constructor & Destructor Documentation

◆ tkproperty_list()

tkproperty_list ( tkstring  _name)
inline

Definition at line 74 of file tkproperty_list.h.

◆ ~tkproperty_list()

virtual ~tkproperty_list ( )
virtualdefault

Member Function Documentation

◆ get()

shared_ptr< tkmeasure > get ( const tkstring _property) const

get the property as tkmeasure

Definition at line 102 of file tkproperty_list.cpp.

◆ get_data_properties()

vector< shared_ptr< tkmeasure > > get_data_properties ( const tkstring _opt = "*")

get a vector of data properties according to a regular expression

Definition at line 93 of file tkproperty_list.cpp.

◆ get_properties()

const std::map< tkstring, property_string > get_properties ( )
inline

get the properties map

Definition at line 99 of file tkproperty_list.h.

◆ get_property()

tkstring get_property ( const tkstring _property) const

get the property value as a string

Definition at line 59 of file tkproperty_list.cpp.

◆ get_property_type()

tkstring get_property_type ( const tkstring _property) const

get the property type as a string

Definition at line 71 of file tkproperty_list.cpp.

◆ get_property_unit()

tkstring get_property_unit ( const tkstring _property) const

get the property unnit as a string

Definition at line 65 of file tkproperty_list.cpp.

◆ has_property()

bool has_property ( const tkstring _property) const

to check if the property is available

Definition at line 54 of file tkproperty_list.cpp.

◆ list_data_properties()

void list_data_properties ( const tkstring _opt = "*") const

list the available tkmeasure properties

Definition at line 85 of file tkproperty_list.cpp.

◆ list_properties()

void list_properties ( const tkstring _opt = "*") const

list the available properties

Definition at line 77 of file tkproperty_list.cpp.


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