tkproperty Class Reference

Any property (data) with flags. More...

Detailed Description

Any property (data) with flags.

This class allows to get/set some flag informations concerning any data. A data is something that can be measured or obtained experimentally and has, through this InfoData class, some qualitative flags:

kKnown	The data is known
kUnknown	The data is unknown
kTentative	The data is based on some hypothesis
kTheo	The data is known only theoretically
kAbout	The data is known roughly
kSystematic	The data is determined from systematics
kLimit	The data is a lower or upper limit
kUncertain	The data is uncertain

It also print a flag when a value is not printed in its original unit but after a non trivial conversion (ex: B(E2) form e2b2 to Weisskopf units)

Definition at line 50 of file tkproperty.h.

Inheritance diagram for tkproperty:

#include <tkproperty.h>

Public Types
enum	data_info {   kKnown , kUnknown , kTentative , kTheo ,   kAbout , kSystematic , kLimit , kUncertain }
	flags that qualify a given data More...

Public Member Functions
	tkproperty ()
	tkproperty (tkproperty::data_info _info)
virtual	~tkproperty ()
void	clear ()
	clear the property More...
data_info	get_info ()
	to get information about this data More...
data_info	get_info_const () const
tkstring	get_info_str (bool _showknown=true) const
	to print in string the data_info More...
tkstring	get_reference ()
	to get the reference of this data More...
bool	is_converted () const
	to know if the value has been converted More...
bool	is_info (data_info _info) const
	to get some information about this data More...
bool	is_known () const
	to get some information about this data More...
void	set_converted (bool _val=true)
	to define the value as a converted one More...
void	set_info (tkproperty::data_info _info)
	to set some information about this data More...
void	set_reference (const char *_st)
	to set the reference of this data More...

Static Public Member Functions
static data_info	what_is (const tkstring &_st)
	It deduces from a string the kind of data. More...

Member Enumeration Documentation

data_info

enum data_info

flags that qualify a given data

Enumerator
kKnown
kUnknown
kTentative
kTheo
kAbout
kSystematic
kLimit
kUncertain

Definition at line 55 of file tkproperty.h.

Constructor & Destructor Documentation

tkproperty() [1/2]

tkproperty ( )

inline

Definition at line 63 of file tkproperty.h.

tkproperty() [2/2]

tkproperty ( tkproperty::data_info  _info )

inlineexplicit

Definition at line 64 of file tkproperty.h.

~tkproperty()

virtual ~tkproperty ( )

inlinevirtual

Definition at line 66 of file tkproperty.h.

Member Function Documentation

clear()

void clear ( )

inline

clear the property

Definition at line 100 of file tkproperty.h.

get_info()

data_info get_info ( )

inline

to get information about this data

Definition at line 81 of file tkproperty.h.

get_info_const()

data_info get_info_const ( ) const

inline

Definition at line 82 of file tkproperty.h.

get_info_str()

tkstring get_info_str

(

bool

_showknown = true

)

const

to print in string the data_info

Definition at line 93 of file tkproperty.cpp.

get_reference()

tkstring get_reference ( )

inline

to get the reference of this data

Definition at line 97 of file tkproperty.h.

is_converted()

bool is_converted ( ) const

inline

to know if the value has been converted

Definition at line 75 of file tkproperty.h.

is_info()

bool is_info ( data_info  _info ) const

inline

to get some information about this data

Definition at line 88 of file tkproperty.h.

is_known()

bool is_known ( ) const

inline

to get some information about this data

Definition at line 91 of file tkproperty.h.

set_converted()

void set_converted ( bool  _val = true )

inline

to define the value as a converted one

Definition at line 72 of file tkproperty.h.

set_info()

void set_info ( tkproperty::data_info  _info )

inline

to set some information about this data

Definition at line 78 of file tkproperty.h.

set_reference()

void set_reference ( const char *  _st )

inline

to set the reference of this data

Definition at line 94 of file tkproperty.h.

what_is()

tkproperty::data_info what_is ( const tkstring &  _st )

static

It deduces from a string the kind of data.

Definition at line 67 of file tkproperty.cpp.

---

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

• tkn.doxygen/src/physics/tkproperty.h
• tkn.doxygen/src/physics/tkproperty.cpp