TkN 2.1
Toolkit for Nuclei
tkparity Class Reference

Nuclear excited state parity. More...

Detailed Description

Nuclear excited state parity.

The tkparity class handles the parity value of a nuclear level. It inherits from the tkn::tkproperty class to be associated with possible uncertainties on the spin determination

Definition at line 85 of file tkspin_parity.h.

Inheritance diagram for tkparity:
tkproperty

#include <tkspin_parity.h>

Public Types

enum  eparity { kParityMinus = -1 , kParityUnknown = 0 , kParityPlus = 1 }
 
- Public Types inherited from tkproperty
enum  data_info {
  kKnown , kUnknown , kTentative , kTheo ,
  kAbout , kSystematic , kLimit , kUncertain
}
 flags that qualify a given data More...
 

Public Member Functions

 tkparity ()=default
 
 tkparity (tkparity::eparity p)
 
virtual ~tkparity ()=default
 
virtual void clear ()
 to clear the content More...
 
tkstring get_string ()
 returns the parity as a string More...
 
virtual short get_value ()
 returns the parity value as a tkparity::eparity More...
 
virtual bool is_parity (tkparity::eparity _parity)
 test the parity value More...
 
void print ()
 print the spin properties More...
 
virtual void set (const tkstring &_st)
 define the parity from a string More...
 
virtual void set (int _parity)
 define the parity from an integer More...
 
virtual void set (tkparity::eparity _parity)
 define the parity from tkparity::eparity More...
 
- Public Member Functions inherited from tkproperty
 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...
 

Additional Inherited Members

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

Member Enumeration Documentation

◆ eparity

enum eparity
Enumerator
kParityMinus 
kParityUnknown 
kParityPlus 

Definition at line 87 of file tkspin_parity.h.

Constructor & Destructor Documentation

◆ tkparity() [1/2]

tkparity ( )
default

◆ tkparity() [2/2]

tkparity ( tkparity::eparity  p)
inline

Definition at line 94 of file tkspin_parity.h.

◆ ~tkparity()

virtual ~tkparity ( )
virtualdefault

Member Function Documentation

◆ clear()

virtual void clear ( )
inlinevirtual

to clear the content

Definition at line 113 of file tkspin_parity.h.

◆ get_string()

tkstring get_string ( )

returns the parity as a string

Definition at line 257 of file tkspin_parity.cpp.

◆ get_value()

virtual short get_value ( )
inlinevirtual

returns the parity value as a tkparity::eparity

Definition at line 100 of file tkspin_parity.h.

◆ is_parity()

virtual bool is_parity ( tkparity::eparity  _parity)
inlinevirtual

test the parity value

Definition at line 98 of file tkspin_parity.h.

◆ print()

void print ( )

print the spin properties

Definition at line 279 of file tkspin_parity.cpp.

◆ set() [1/3]

void set ( const tkstring _st)
virtual

define the parity from a string

Definition at line 219 of file tkspin_parity.cpp.

◆ set() [2/3]

void set ( int  _parity)
virtual

define the parity from an integer

Parameters
_parityparity defined as (-1)^{p} => + : 0 , - : 1

Definition at line 241 of file tkspin_parity.cpp.

◆ set() [3/3]

virtual void set ( tkparity::eparity  _parity)
inlinevirtual

define the parity from tkparity::eparity

Definition at line 105 of file tkspin_parity.h.


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