Description of a variable (field). More...

#include <TAttribute.h>

Inheritance diagram for URANIE::DataServer::TAttribute:

[legend]

Collaboration diagram for URANIE::DataServer::TAttribute:

[legend]

Public Types
enum	EOrigin { kInternal , kIterator , kConstant , kAttribute , kDeleted }

enum	EAttribute { kInput , kOutput }

enum	EType { kDefault , kReal , kVector , kString , kCategory , kInconnu }

Public Member Functions
Constructor and Destructor
For creation of variables to use in all incertainties and sensitivities studies. To define a pointer px on a non-bounded variable . TAttribute px = new TAttribute("x"); URANIE::DataServer::TAttribute Description of a variable (field). Definition* TAttribute.h:138 URANIE::DataServer::TAttribute::TAttribute TAttribute() Default constructor. To define a pointer x on a bounded attribute comprised between $\left[-1., 1.\right]$ with title $\Delta P_{e}^{F_{iso}}$ on graphs. TAttribute *x = new TAttribute("x28", -1.0, 1.0); x->SetTitle("#Delta P_{e}^{F_{iso}}");
	TAttribute ()
	Default constructor.

	TAttribute (const char name, const char title)

	TAttribute (TString name)
	Constructor by name only.

	TAttribute (TString name, EType type)
	Constructor by name and type only.

	TAttribute (TString name, TString value, EType type)
	Constructor by name and range.

	TAttribute (TString name, Double_t lower, Double_t upper)
	Constructor by name and range.

	TAttribute (const TAttribute &attr)
	Copy constructor.

TAttribute *	Clone (const char *newname) const
	Clone an attribute with a new name.

virtual	~TAttribute ()
	Default destructor.

Setting and Getting Statistical and Quantiles
The statistical informations (minimum, maximum, mean and std) are computed from the data base inside the TDataServer.
void	checkSizeBeforePush (const char *type, int iel, Double_t val)
	Internal method used to check the validity of all setters when dealing with vectors.

Double_t	checkSizeBeforeGet (const char *type, int iel=0)
	Internal method used to check the validity of all getters when dealing with vectors and return the request.

void	setQuantile (double prob, double quantile, int iel=0)
	Set the quantile value.

void	getQuantilesSize (int &nb, int iel=0)
	Returns the number of quantile computed and stored for element iel.

void	getQuantiles (double prob, double quantile, int iel=0)
	Returns all the probabilities and corresponding quantiles computed for element iel.

void	getQuantile (double &prob, double &quantile, int iel=0)
	Returns the value of the quantile for element iel, given the probability.

void	getQuantileVector (double &prob, vector< double > &quantile)
	Returns the vector of quantile given the probability.

Double_t	getMinimum (int iel=0)

Double_t	getMinimumSize ()
	Returns the size of the vector of minimum.

Bool_t	hasDefault ()
	Details whether this attribute has a default value.

void	setMinimum (Double_t val, int iel=0)
	Set the minimum value oef element iel.

Double_t	getMaximum (int iel=0)

Double_t	getMaximumSize ()
	Returns the size of the vector of maximum.

void	setMaximum (Double_t val, int iel=0)
	Set the maximum value oef element iel.

void	getStatisticalVector (const char *type, vector< double > &vec)
	Returns the vector of considered statistical value.

Double_t	getMean (int iel=0)

Double_t	getMeanSize ()
	Returns the size of the vector of mean.

void	setMean (Double_t val, int iel=0)
	Set the mean value oef element iel.

Double_t	getStd (int iel=0)

Double_t	getStdSize ()
	Returns the size of the vector of std.

void	setStd (Double_t val, int iel=0)
	Set the std value oef element iel.

void	setSlurmOption (TString value)

Setting and Getting attributes general information
EType	getDataType () const
	Returns the datatype of the considered attribute.

TString	getDataTypeStr ()
	Returns the datatype as TString.

void	setTitle (const char *title)
	Defines the title of the attribute.

void	setTitle (TString str)

TString	getTitle ()

void	setDataType (EType thetype)
	Change the type of data.

void	setDataType (TString name)
	Change the type of data.

TString	getLegend ()
	Returns the legend of the attribut.

TString	getUnit ()

void	setUnit (TString str)

TString	getUnity ()

void	setUnity (TString str)

TString	getNote ()

void	setNote (TString str)

Bool_t	setDefault (TString value)

TString	getDefault (TString format="%e")

Bool_t	setDefaultValue (Double_t val)

Bool_t	getDefaultValue (Double_t &val)

Bool_t	hasDefaultValue ()

Bool_t	setDefaultVector (vector< double > &vec)

Bool_t	getDefaultVector (vector< double > *val)

Bool_t	hasDefaultVector ()

Bool_t	setDefaultString (TString str)

Bool_t	getDefaultString (string &str)

Bool_t	hasDefaultString ()

void	setStepValue (Double_t val)

Bool_t	getStepValue (Double_t &val)

TString	getSlurmOption ()

EOrigin	getOrigin ()

void	setOrigin (EOrigin ind)

Int_t	getShare ()

void	setOutput ()
	Sets the attribute as an output attribute.

void	setInput ()
	Sets the attribute as Input.

EAttribute	getInputOutput ()
	Returns the input/Output information of the attribute.

Treament of inputs of an attribute
void	setFileNameOfKey (TString str)
	Sets the file name for a key.

list< URANIE::DataServer::TAttributeFileKey * >	getKeyList ()
	Gets KeyList for the attribute.

void	setFieldOfKey (Int_t ind)
	Sets index ind in the unique field related to a unique key.

void	setFieldOfKey (Int_t sIndex, Int_t ind)

void	setFileKey (TString sfile, TString skey="", TString sformatToSubstitute="%e", TAttributeFileKey::EFileType FileType=TAttributeFileKey::kKey)
	Defines the input files and eventually others informations like key, format to substitute.

void	setFileFlag (TString sfile, TString skey="", TString sformatToSubstitute="%e")
	Defines the input files as in the "flag" format and eventually others informations like key, format to substitute.

void	setFileXMLAttribute (TString sfile, TString sXPathAttribute, TString sformatToSubstitute="%e")
	Defines the input files as an "XML" input file with XPath attribute format and eventually the format to substitute.

void	setFileXMLField (TString sfile, TString sXPathField, TString sformatToSubstitute="%e")
	Defines the input files as an "XML" input file with XPath field and eventually the format to substitute.

void	setFileFMU (TString sfile, TString sXPathField, TString sformatToSubstitute="%e")

Substitution of value
const char *	getFormatToSubstitute ()
	Returns the format of substitution.

void	setFormatToSubstitute (TString str)
	Sets the format of substitution.

Treatment of the properties of an attribute
Bool_t	isInput ()
	Tests if the attribute is an input attribute.

Bool_t	isOutput ()
	Tests if the attribute is an output attribute.

void	addShare ()

void	delShare ()

void	initShare ()

void	clearVectors ()

Treatment the boundaries of an attribute
virtual void	setLowerBound (Double_t val, bool internalcall=false)
	Sets the lower bound value of the attribute.

Double_t	getLowerBound ()
	Gets the lower bound value of the attribute.

Bool_t	isLowerBounded ()
	Returns a boolean if the attribute have a lower bound.

virtual void	setUpperBound (Double_t val, bool internalcall=false)
	Sets the upper bound value of the attribute.

Double_t	getUpperBound ()
	Gets the upper bound value of the attribute.

Bool_t	isUpperBounded ()
	Returns a boolean if the attribute have an upper bound.

virtual void	setBounds (Double_t lower, Double_t upper)
	Sets the two bounds values (lower and upper) of the attribute.

Bool_t	isBounded ()
	Returns a boolean if the attribute have a lower AND an upper bounds.

Printing Log
void	setLog ()

void	unsetLog ()

void	changeLog ()

Bool_t	getLog ()

virtual void	printLog ()

Internal methode used to estimate the quantile by importance sampling
TAttribute *	getSonAttribute ()

void	setSonAttribute (TAttribute *tatt)

void	removeSonAttribute ()

Int_t	getLevel ()

void	setLevel (Int_t nlevel)

Bool_t	haveSon ()

Protected Attributes
String informations of an attribute
TString	_sunity
	Unity.

TString	_snote
	Note.

Bool_t	_blog
	Log printing.

Int_t	_nshare
	The number of time this attribute is shared in TDataServer.

TAttribute *	_attSon
	Son attribute.

Int_t	_nlevel
	level to its "father"

Bool_t	_haveSon
	true if the attribute have a son

Informations about inputs of an attribute
TString	_sFormatSubstitute
	Format to substitute the value.

list< TEventList * >	_nfields
	List of all TEventLists created for the attribute.

list< TAttributeFileKey * >	_KeyList
	List of Keys Attributes structures.

Numerical information of an attribute
Double_t	upperBound
	Upper bound.

Bool_t	_bHaveUpperBound
	If have an upper bound.

Double_t	lowerBound
	Lower bound.

Bool_t	_bHaveLowerBound
	If have a lower bound.

Double_t	_defaultValue
	Default value.

Bool_t	_bHaveDefaultValue
	If have a default value.

vector< double >	_defaultVector
	Default value for vector.

Bool_t	_bHaveDefaultVector
	If have a default value for vector.

string	_defaultString
	Default value for string.

Bool_t	_bHaveDefaultString
	If have a default value for string.

Double_t	_stepValue
	Step value when using in Optimization.

Bool_t	_bHaveStepValue
	If have a step value.

Statistical information of an attribute
vector< Double_t >	_vminimum
	All minimun calculated.

vector< Double_t >	_vmaximum
	All maximun calculated.

vector< Double_t >	_vmean
	All mean calculated.

vector< Double_t >	_vstd
	All std calculated.

vector< Double_t > *	_vbuffer

vector< map< double, double > * >	_vquantile
	‍buffer pointer to check addresses

EOrigin	_norigin
	The origin of the attribute (Internal of uranie, attribute or Input, Output...)

EAttribute	_nAttribute
	The nature of attributes : kInput (default) or kOutput.

EType	_nType
	The type of attribute: real (double), vector (of double), string...

Allows to generate remote cluster scripts
TString	_slurmValue

Detailed Description

Description of a variable (field).

Avalaible informations are:

name : the name of the attribute
title : the title of the attribute on graphs. It can be be different than the name.
_sunity : unit on graphs
bounds : Min and Max Bounds if necessary
default : the default value of this variable (can be used in optimization module)
step : the step of variable (can be used in optimization module)
_snote : additional note on variable
- ordering
- taxonomy
- normalization

For creation of variables to use in all incertainties and sensitivities studies.

To define a pointer px on a non-bounded variable $ x$ .

TAttribute *px = new TAttribute("x");

To define a pointer x on a bounded attribute $ x28$ comprised between $\left[-1., 1.\right]$ with title $\Delta P_{e}^{F_{iso}}$ on graphs.

TAttribute *x = new TAttribute("x28", -1.0, 1.0);

x->SetTitle("#Delta P_{e}^{F_{iso}}");

To draw this attribute in a TDataServer, apply the draw method

tds->draw("x28");

Member Enumeration Documentation

◆ EAttribute

enum URANIE::DataServer::TAttribute::EAttribute

Enumerator
kInput
kOutput

◆ EOrigin

enum URANIE::DataServer::TAttribute::EOrigin

Enumerator
kInternal
kIterator
kConstant
kAttribute
kDeleted

◆ EType

enum URANIE::DataServer::TAttribute::EType

Enumerator
kDefault
kReal
kVector
kString
kCategory
kInconnu

Constructor & Destructor Documentation

◆ TAttribute() [1/7]

URANIE::DataServer::TAttribute::TAttribute ( )

Default constructor.

Referenced by ClassImp().

◆ TAttribute() [2/7]

URANIE::DataServer::TAttribute::TAttribute	(	const char *	name,
		const char *	title
	)

◆ TAttribute() [3/7]

URANIE::DataServer::TAttribute::TAttribute ( TString name )

Constructor by name only.

Parameters

name	Name of the attribute

◆ TAttribute() [4/7]

URANIE::DataServer::TAttribute::TAttribute	(	TString	name,
		EType	type
	)

Constructor by name and type only.

Parameters

name	Name of the attribute
type	Type of the attribute

◆ TAttribute() [5/7]

URANIE::DataServer::TAttribute::TAttribute	(	TString	name,
		TString	value,
		EType	type
	)

Constructor by name and range.

Parameters

name	Name of the attribute
value	Value of the attribute
type	Type of the attribute

◆ TAttribute() [6/7]

URANIE::DataServer::TAttribute::TAttribute	(	TString	name,
		Double_t	lower,
		Double_t	upper
	)

Constructor by name and range.

Parameters

name	(TString) Name of the attribut.
value	(TString) slurm field value.

◆ TAttribute() [7/7]

URANIE::DataServer::TAttribute::TAttribute ( const TAttribute & attr )

Copy constructor.

◆ ~TAttribute()

virtual URANIE::DataServer::TAttribute::~TAttribute ( )

virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ addShare()

void URANIE::DataServer::TAttribute::addShare ( )

inline

References _nshare.

Referenced by ClassImp(), and ClassImp().

◆ changeLog()

void URANIE::DataServer::TAttribute::changeLog ( )

inline

References _blog.

◆ checkSizeBeforeGet()

Double_t URANIE::DataServer::TAttribute::checkSizeBeforeGet	(	const char *	type,
		int	iel = `0`
	)

Internal method used to check the validity of all getters when dealing with vectors and return the request.

Parameters

type	which statistical object considered amongst min, max, mean and std
iel	number of the element in the vector

Exceptions

if	iel is negative, if iel greater than the considered vector size (works with push_back)

Referenced by ClassImp(), getMaximum(), getMean(), getMinimum(), and getStd().

◆ checkSizeBeforePush()

void URANIE::DataServer::TAttribute::checkSizeBeforePush	(	const char *	type,
		int	iel,
		Double_t	val
	)

Internal method used to check the validity of all setters when dealing with vectors.

Parameters

type	which statistical object considered amongst min, max, mean and std
iel	number of the element in the vector
val	value to be stored

Exceptions

if	iel is negative, if iel greater than the considered vector size (works with push_back)

Referenced by ClassImp(), setMaximum(), and setMinimum().

◆ clearVectors()

void URANIE::DataServer::TAttribute::clearVectors ( )

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), and URANIE::DataServer::TDataServer::cleanStatAndQuantiles().

◆ Clone()

TAttribute * URANIE::DataServer::TAttribute::Clone ( const char * newname ) const

Clone an attribute with a new name.

Make a clone of an attribute using the Streamer facility with a new name. All the information of the origin attribute are stored in the new attribute (title, unity, bounds, ...).

Parameters

newname (const char *) The new name of the attribute

Referenced by ClassImp().

◆ delShare()

void URANIE::DataServer::TAttribute::delShare ( )

inline

References _nshare.

Referenced by ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ getDataType()

EType URANIE::DataServer::TAttribute::getDataType ( ) const

inline

Returns the datatype of the considered attribute.

References _nType.

◆ getDataTypeStr()

TString URANIE::DataServer::TAttribute::getDataTypeStr ( )

Returns the datatype as TString.

Returns "V" <=> vector "S" <=> string "D" <=> double

Referenced by ClassImp(), ClassImp(), and ClassImp().

◆ getDefault()

TString URANIE::DataServer::TAttribute::getDefault ( TString format = "%e" )

Referenced by ClassImp().

◆ getDefaultString()

Bool_t URANIE::DataServer::TAttribute::getDefaultString ( string & str )

Referenced by ClassImp().

◆ getDefaultValue()

Bool_t URANIE::DataServer::TAttribute::getDefaultValue ( Double_t & val )

Referenced by ClassImp().

◆ getDefaultVector()

Bool_t URANIE::DataServer::TAttribute::getDefaultVector ( vector< double > * val )

Referenced by ClassImp().

◆ getFormatToSubstitute()

const char * URANIE::DataServer::TAttribute::getFormatToSubstitute ( )

inline

Returns the format of substitution.

References _sFormatSubstitute.

◆ getInputOutput()

EAttribute URANIE::DataServer::TAttribute::getInputOutput ( )

inline

Returns the input/Output information of the attribute.

References _nAttribute.

◆ getKeyList()

list< URANIE::DataServer::TAttributeFileKey * > URANIE::DataServer::TAttribute::getKeyList ( )

inline

Gets KeyList for the attribute.

References _KeyList.

◆ getLegend()

TString URANIE::DataServer::TAttribute::getLegend ( )

Returns the legend of the attribut.

The legend is the Title plus, if exists, "[" unity "]"

Referenced by ClassImp(), and ClassImp().

◆ getLevel()

Int_t URANIE::DataServer::TAttribute::getLevel ( )

Referenced by ClassImp().

◆ getLog()

Bool_t URANIE::DataServer::TAttribute::getLog ( )

inline

References _blog.

◆ getLowerBound()

Double_t URANIE::DataServer::TAttribute::getLowerBound ( )

inline

Gets the lower bound value of the attribute.

References lowerBound.

Referenced by ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ getMaximum()

Double_t URANIE::DataServer::TAttribute::getMaximum ( int iel = 0 )

inline

References checkSizeBeforeGet().

Referenced by ClassImp().

◆ getMaximumSize()

Double_t URANIE::DataServer::TAttribute::getMaximumSize ( )

inline

Returns the size of the vector of maximum.

References _vmaximum.

◆ getMean()

Double_t URANIE::DataServer::TAttribute::getMean ( int iel = 0 )

inline

References checkSizeBeforeGet().

Referenced by ClassImp(), and ClassImp().

◆ getMeanSize()

Double_t URANIE::DataServer::TAttribute::getMeanSize ( )

inline

Returns the size of the vector of mean.

References _vmean.

◆ getMinimum()

Double_t URANIE::DataServer::TAttribute::getMinimum ( int iel = 0 )

inline

References checkSizeBeforeGet().

Referenced by ClassImp().

◆ getMinimumSize()

Double_t URANIE::DataServer::TAttribute::getMinimumSize ( )

inline

Returns the size of the vector of minimum.

References _vminimum.

◆ getNote()

TString URANIE::DataServer::TAttribute::getNote ( )

inline

References _snote.

◆ getOrigin()

EOrigin URANIE::DataServer::TAttribute::getOrigin ( )

inline

References _norigin.

Referenced by ClassImp().

◆ getQuantile()

void URANIE::DataServer::TAttribute::getQuantile	(	double &	prob,
		double &	quantile,
		int	iel = `0`
	)

Returns the value of the quantile for element iel, given the probability.

Warning: Quantile map is cleared (as statistical vectors) as soon as the selection is changed in TDataServer. The value stored in this map is the latest one computed. No history is kept to know the method and option used

Referenced by ClassImp().

◆ getQuantiles()

void URANIE::DataServer::TAttribute::getQuantiles	(	double *	prob,
		double *	quantile,
		int	iel = `0`
	)

Returns all the probabilities and corresponding quantiles computed for element iel.

Warning: the size of the prob and quantile array has to be carefully set. This method should be called like
int nbQ=0, iel=0;

tds->getAttribute("x")->getQuantilesSize(nbQ,iel);

double prob[nbQ], quan[nbQ];

tds->getAttribute("x")->getQuantiles(prob,quan,iel);; Quantile map is cleared (as statistical vectors) as soon as the selection is changed in TDataServer. The value stored in this map is the latest one computed. No history is kept to know the method and option used

Referenced by ClassImp().

◆ getQuantilesSize()

void URANIE::DataServer::TAttribute::getQuantilesSize	(	int &	nb,
		int	iel = `0`
	)

Returns the number of quantile computed and stored for element iel.

Referenced by ClassImp().

◆ getQuantileVector()

void URANIE::DataServer::TAttribute::getQuantileVector	(	double &	prob,
		vector< double > &	quantile
	)

Returns the vector of quantile given the probability.

Warning: Quantile map is cleared (as statistical vectors) as soon as the selection is changed in TDataServer. The value stored in this map is the latest one computed. No history is kept to know the method and option used

Referenced by ClassImp().

◆ getShare()

Int_t URANIE::DataServer::TAttribute::getShare ( )

inline

References _nshare.

Referenced by ClassImp().

◆ getSlurmOption()

TString URANIE::DataServer::TAttribute::getSlurmOption ( )

inline

References _slurmValue.

◆ getSonAttribute()

TAttribute * URANIE::DataServer::TAttribute::getSonAttribute ( )

Referenced by ClassImp().

◆ getStatisticalVector()

void URANIE::DataServer::TAttribute::getStatisticalVector	(	const char *	type,
		vector< double > &	vec
	)

Returns the vector of considered statistical value.

Parameters

type	"min", "max", "mean" or "std"
vec	vector in which results will be stored

Referenced by ClassImp().

◆ getStd()

Double_t URANIE::DataServer::TAttribute::getStd ( int iel = 0 )

inline

References checkSizeBeforeGet().

Referenced by ClassImp(), and ClassImp().

◆ getStdSize()

Double_t URANIE::DataServer::TAttribute::getStdSize ( )

inline

Returns the size of the vector of std.

References _vstd.

◆ getStepValue()

Bool_t URANIE::DataServer::TAttribute::getStepValue ( Double_t & val )

Referenced by ClassImp().

◆ getTitle()

TString URANIE::DataServer::TAttribute::getTitle ( )

inline

◆ getUnit()

TString URANIE::DataServer::TAttribute::getUnit ( )

inline

References _sunity.

◆ getUnity()

TString URANIE::DataServer::TAttribute::getUnity ( )

inline

References _sunity.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ getUpperBound()

Double_t URANIE::DataServer::TAttribute::getUpperBound ( )

inline

Gets the upper bound value of the attribute.

References upperBound.

Referenced by ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ hasDefault()

Bool_t URANIE::DataServer::TAttribute::hasDefault ( )

inline

Details whether this attribute has a default value.

References _nType, hasDefaultString(), hasDefaultValue(), hasDefaultVector(), kString, and kVector.

◆ hasDefaultString()

Bool_t URANIE::DataServer::TAttribute::hasDefaultString ( )

Referenced by ClassImp(), and hasDefault().

◆ hasDefaultValue()

Bool_t URANIE::DataServer::TAttribute::hasDefaultValue ( )

Referenced by ClassImp(), and hasDefault().

◆ hasDefaultVector()

Bool_t URANIE::DataServer::TAttribute::hasDefaultVector ( )

Referenced by ClassImp(), and hasDefault().

◆ haveSon()

Bool_t URANIE::DataServer::TAttribute::haveSon ( )

Referenced by ClassImp().

◆ initShare()

void URANIE::DataServer::TAttribute::initShare ( )

inline

References _nshare.

◆ isBounded()

Bool_t URANIE::DataServer::TAttribute::isBounded ( )

inline

Returns a boolean if the attribute have a lower AND an upper bounds.

References _bHaveLowerBound, and _bHaveUpperBound.

◆ isInput()

Bool_t URANIE::DataServer::TAttribute::isInput ( )

inline

Tests if the attribute is an input attribute.

References _nAttribute, _norigin, kAttribute, kConstant, and kInput.

◆ isLowerBounded()

Bool_t URANIE::DataServer::TAttribute::isLowerBounded ( )

inline

Returns a boolean if the attribute have a lower bound.

References _bHaveLowerBound.

Referenced by ClassImp().

◆ isOutput()

Bool_t URANIE::DataServer::TAttribute::isOutput ( )

inline

Tests if the attribute is an output attribute.

References _nAttribute, _norigin, kAttribute, and kOutput.

◆ isUpperBounded()

Bool_t URANIE::DataServer::TAttribute::isUpperBounded ( )

inline

Returns a boolean if the attribute have an upper bound.

References _bHaveUpperBound.

Referenced by ClassImp().

◆ printLog()

virtual void URANIE::DataServer::TAttribute::printLog ( )

virtual

◆ removeSonAttribute()

void URANIE::DataServer::TAttribute::removeSonAttribute ( )

Referenced by ClassImp().

◆ setBounds()

virtual void URANIE::DataServer::TAttribute::setBounds	(	Double_t	lower,
		Double_t	upper
	)

virtual

Sets the two bounds values (lower and upper) of the attribute.

Reimplemented in URANIE::DataServer::TLogNormalDistribution, URANIE::DataServer::TLogUniformDistribution, and URANIE::DataServer::TInfiniteDistribution.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ setDataType() [1/2]

void URANIE::DataServer::TAttribute::setDataType ( EType thetype )

inline

Change the type of data.

References _nType.

Referenced by ClassImp(), and ClassImp().

◆ setDataType() [2/2]

void URANIE::DataServer::TAttribute::setDataType ( TString name )

Change the type of data.

"real" or "double" or "d" <=> kReal "vector" or "v" <=> kVector "string" or "s" <=> kString

◆ setDefault()

Bool_t URANIE::DataServer::TAttribute::setDefault ( TString value )

Referenced by ClassImp().

◆ setDefaultString()

Bool_t URANIE::DataServer::TAttribute::setDefaultString ( TString str )

Referenced by ClassImp().

◆ setDefaultValue()

Bool_t URANIE::DataServer::TAttribute::setDefaultValue ( Double_t val )

Referenced by ClassImp().

◆ setDefaultVector()

Bool_t URANIE::DataServer::TAttribute::setDefaultVector ( vector< double > & vec )

Referenced by ClassImp().

◆ setFieldOfKey() [1/2]

void URANIE::DataServer::TAttribute::setFieldOfKey ( Int_t ind )

Sets index ind in the unique field related to a unique key.

Deprecated:: Multiple fields can be defined for a same attribute. Use the method setFieldOfKey(Int_t sIndex, Int_t ind).

Referenced by ClassImp().

◆ setFieldOfKey() [2/2]

void URANIE::DataServer::TAttribute::setFieldOfKey	(	Int_t	sIndex,
		Int_t	ind
	)

◆ setFileFlag()

void URANIE::DataServer::TAttribute::setFileFlag	(	TString	sfile,
		TString	skey = `""`,
		TString	sformatToSubstitute = `"%e"`
	)

inline

Defines the input files as in the "flag" format and eventually others informations like key, format to substitute.

This method is an alias to the setFileKey method with TAttributeFileKey::kFlag as the fourth argument.

See also: setFileKey

Parameters

sfile	(TString) the input file where to change the values of the attribute
skey	(TString) ("") the key in the input file when it was different than the name of the attribute. The default value (empty string) means that is the name of the attribute.
sformatToSubstitute	(TString)["%e"] the format to substitue. The default value ["%e"] means that it is with the scientifist format x.yzE-uv.

References URANIE::DataServer::STRUCT::kFlag, and setFileKey().

◆ setFileFMU()

void URANIE::DataServer::TAttribute::setFileFMU	(	TString	sfile,
		TString	sXPathField,
		TString	sformatToSubstitute = `"%e"`
	)

inline

References URANIE::DataServer::STRUCT::kFMU, and setFileKey().

◆ setFileKey()

void URANIE::DataServer::TAttribute::setFileKey	(	TString	sfile,
		TString	skey = `""`,
		TString	sformatToSubstitute = `"%e"`,
		TAttributeFileKey::EFileType	FileType = `TAttributeFileKey::kKey`
	)

Defines the input files and eventually others informations like key, format to substitute.

In this method, you can associate the input file, the key and the format to store the value for all patterns in the design of experiments. The input must be existed before (kKey and kFlag), or does not exist before (kNewRow, kNewColumn, kNewKey). You can defines also the type of input file:

TAttributeFileKey::kKey : the input file is key format (i.e. "key = value")
Rw = 0.0500 ;

R = 33366.67 ;

Tu = 63070.0 ;
TAttributeFileKey::kFlag : the input file is "flag format (i.e. "information value1 value2 @value3@") @code kW @Kw@ information_Tu Champ_Uniforme 1 @Tu@ information_Tl Champ_Uniforme 1 @Tl@ information_L { precision @L@ } convergence { criterion relative_max_du_dt precision 1.e-6 } \endcode \li TAttributeFileKey::kNewRow : the input file is creted on the fly with values on \em line. @code 1.123982e-01 1.507645e+04 1.101851e+05 1.000706e+02 1.086654e+03 7.556420e+02 1.600970e+03 1.194875e+04 \endcode \li TAttributeFileKey::kNewColumn : the input file is creted on the fly with values on \em column. @code 1.123982e-01 1.507645e+04 1.101851e+05 ... \endcode \li TAttributeFileKey::kNewKey : the input file is creted on the fly with Key and values on \em line. @code Rw = 1.123982e-01 Tu = 1.507645e+04 Tl = 1.101851e+05 ... \endcode @param sfile (TString) the input file where to change the values of the attribute @param skey (TString) ("") the key in the input file when it was different than the name of the attribute. The default value (empty string) means that is the name of the attribute. @param sformatToSubstitute (TString)["e"] the format to substitue. The default value ["e"] means that it is with the scientifist format x.yzE-uv.
Parameters

FileType (TAttributeFileKey::EFileType) [TAttributeFileKey::kKey] the type of input files. The default value is kKey

Referenced by ClassImp(), setFileFlag(), setFileFMU(), setFileXMLAttribute(), and setFileXMLField().

◆ setFileNameOfKey()

void URANIE::DataServer::TAttribute::setFileNameOfKey ( TString str )

Sets the file name for a key.

New implementation for old setKey method.

◆ setFileXMLAttribute()

void URANIE::DataServer::TAttribute::setFileXMLAttribute	(	TString	sfile,
		TString	sXPathAttribute,
		TString	sformatToSubstitute = `"%e"`
	)

inline

Defines the input files as an "XML" input file with XPath attribute format and eventually the format to substitute.

This method is an alias to the setFileKey method with TAttributeFileKey::kXMLAttribute as the fourth argument.

See also: setFileKey

Parameters

sfile	(TString) the XML input filename where to change the values of the attribute
sXPathAttribute	(TString) the XPath for an attribute in the XML input file.
sformatToSubstitute	(TString)["%e"] the format to substitue. The default value ["%e"] means that it is with the scientifist format x.yzE-uv.

References URANIE::DataServer::STRUCT::kXMLAttribute, and setFileKey().

◆ setFileXMLField()

void URANIE::DataServer::TAttribute::setFileXMLField	(	TString	sfile,
		TString	sXPathField,
		TString	sformatToSubstitute = `"%e"`
	)

inline

Defines the input files as an "XML" input file with XPath field and eventually the format to substitute.

This method is an alias to the setFileKey method with TAttributeFileKey::kXMLField as the fourth argument.

See also: setFileKey

Parameters

sfile	(TString) the XML input filename where to change the values of the attribute
sXPathField	(TString) the XPath for a field in the XML input file.
sformatToSubstitute	(TString)["%e"] the format to substitue. The default value ["%e"] means that it is with the scientifist format x.yzE-uv.

References URANIE::DataServer::STRUCT::kXMLField, and setFileKey().

◆ setFormatToSubstitute()

void URANIE::DataServer::TAttribute::setFormatToSubstitute ( TString str )

inline

Sets the format of substitution.

References _sFormatSubstitute.

◆ setInput()

void URANIE::DataServer::TAttribute::setInput ( )

inline

Sets the attribute as Input.

References _nAttribute, and kInput.

◆ setLevel()

void URANIE::DataServer::TAttribute::setLevel ( Int_t nlevel )

Referenced by ClassImp().

◆ setLog()

void URANIE::DataServer::TAttribute::setLog ( )

inline

References _blog.

◆ setLowerBound()

virtual void URANIE::DataServer::TAttribute::setLowerBound	(	Double_t	val,
		bool	internalcall = `false`
	)

virtual

Sets the lower bound value of the attribute.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ setMaximum()

void URANIE::DataServer::TAttribute::setMaximum	(	Double_t	val,
		int	iel = `0`
	)

inline

Set the maximum value oef element iel.

The vector of maximum is of size N+1 if the vector considered is of size N. The last element is the maximum of the global vector

References checkSizeBeforePush().

Referenced by ClassImp(), and ClassImp().

◆ setMean()

void URANIE::DataServer::TAttribute::setMean	(	Double_t	val,
		int	iel = `0`
	)

Set the mean value oef element iel.

The vector of mean is of size N+1 if the vector considered is of size N. The last element is the mean of the global vector

Referenced by ClassImp(), and ClassImp().

◆ setMinimum()

void URANIE::DataServer::TAttribute::setMinimum	(	Double_t	val,
		int	iel = `0`
	)

inline

Set the minimum value oef element iel.

The vector of minimum is of size N+1 if the vector considered is of size N. The last element is the minimum of the global vector

References checkSizeBeforePush().

Referenced by ClassImp(), and ClassImp().

◆ setNote()

void URANIE::DataServer::TAttribute::setNote ( TString str )

inline

References _snote.

◆ setOrigin()

void URANIE::DataServer::TAttribute::setOrigin ( EOrigin ind )

inline

References _norigin.

Referenced by ClassImp(), ClassImp(), and ClassImp().

◆ setOutput()

void URANIE::DataServer::TAttribute::setOutput ( )

inline

Sets the attribute as an output attribute.

References _nAttribute, and kOutput.

◆ setQuantile()

void URANIE::DataServer::TAttribute::setQuantile	(	double	prob,
		double	quantile,
		int	iel = `0`
	)

Set the quantile value.

Store the quantile value computed for prob (used as key), for element iel (in case of a vector The method called for the first time for element iel creeate a new map and add the couple (key,value) as (proba,quantile). If this is not the first call for this element, only the second part is done.

Exceptions

if	iel is negative, if iel greater than the considered vector size (works with push_back)

Referenced by ClassImp(), and ClassImp().

◆ setSlurmOption()

void URANIE::DataServer::TAttribute::setSlurmOption ( TString value )

inline

References _slurmValue.

◆ setSonAttribute()

void URANIE::DataServer::TAttribute::setSonAttribute ( TAttribute * tatt )

Referenced by ClassImp().

◆ setStd()

void URANIE::DataServer::TAttribute::setStd	(	Double_t	val,
		int	iel = `0`
	)

Set the std value oef element iel.

The vector of std is of size N+1 if the vector considered is of size N. The last element is the std of the global vector

Referenced by ClassImp(), and ClassImp().

◆ setStepValue()

void URANIE::DataServer::TAttribute::setStepValue ( Double_t val )

Referenced by ClassImp().

◆ setTitle() [1/2]

void URANIE::DataServer::TAttribute::setTitle ( const char * title )

inline

Defines the title of the attribute.

We must define this method to uniform all the method name

◆ setTitle() [2/2]

void URANIE::DataServer::TAttribute::setTitle ( TString str )

inline

◆ setUnit()

void URANIE::DataServer::TAttribute::setUnit ( TString str )

inline

References _sunity.

◆ setUnity()

void URANIE::DataServer::TAttribute::setUnity ( TString str )

inline

References _sunity.

◆ setUpperBound()

virtual void URANIE::DataServer::TAttribute::setUpperBound	(	Double_t	val,
		bool	internalcall = `false`
	)

virtual

Sets the upper bound value of the attribute.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ unsetLog()

void URANIE::DataServer::TAttribute::unsetLog ( )

inline

References _blog.

Member Data Documentation

◆ _attSon

TAttribute* URANIE::DataServer::TAttribute::_attSon

protected

Son attribute.

Referenced by ClassImp().

◆ _bHaveDefaultString

Bool_t URANIE::DataServer::TAttribute::_bHaveDefaultString

protected

If have a default value for string.

Referenced by ClassImp().

◆ _bHaveDefaultValue

Bool_t URANIE::DataServer::TAttribute::_bHaveDefaultValue

protected

If have a default value.

Referenced by ClassImp().

◆ _bHaveDefaultVector

Bool_t URANIE::DataServer::TAttribute::_bHaveDefaultVector

protected

If have a default value for vector.

Referenced by ClassImp().

◆ _bHaveLowerBound

Bool_t URANIE::DataServer::TAttribute::_bHaveLowerBound

protected

If have a lower bound.

Referenced by ClassImp(), isBounded(), and isLowerBounded().

◆ _bHaveStepValue

Bool_t URANIE::DataServer::TAttribute::_bHaveStepValue

protected

If have a step value.

Referenced by ClassImp().

◆ _bHaveUpperBound

Bool_t URANIE::DataServer::TAttribute::_bHaveUpperBound

protected

If have an upper bound.

Referenced by ClassImp(), isBounded(), and isUpperBounded().

◆ _blog

Bool_t URANIE::DataServer::TAttribute::_blog

protected

Log printing.

Referenced by changeLog(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), getLog(), setLog(), and unsetLog().

◆ _defaultString

string URANIE::DataServer::TAttribute::_defaultString

protected

Default value for string.

Referenced by ClassImp().

◆ _defaultValue

Double_t URANIE::DataServer::TAttribute::_defaultValue

protected

Default value.

Referenced by ClassImp().

◆ _defaultVector

vector<double> URANIE::DataServer::TAttribute::_defaultVector

protected

Default value for vector.

Referenced by ClassImp().

◆ _haveSon

Bool_t URANIE::DataServer::TAttribute::_haveSon

protected

true if the attribute have a son

Referenced by ClassImp().

◆ _KeyList

list<TAttributeFileKey *> URANIE::DataServer::TAttribute::_KeyList

protected

List of Keys Attributes structures.

Referenced by ClassImp(), and getKeyList().

◆ _nAttribute

EAttribute URANIE::DataServer::TAttribute::_nAttribute

protected

The nature of attributes : kInput (default) or kOutput.

Referenced by ClassImp(), getInputOutput(), isInput(), isOutput(), setInput(), and setOutput().

◆ _nfields

list<TEventList *> URANIE::DataServer::TAttribute::_nfields

protected

List of all TEventLists created for the attribute.

Referenced by ClassImp().

◆ _nlevel

Int_t URANIE::DataServer::TAttribute::_nlevel

protected

level to its "father"

Referenced by ClassImp().

◆ _norigin

EOrigin URANIE::DataServer::TAttribute::_norigin

protected

The origin of the attribute (Internal of uranie, attribute or Input, Output...)

Referenced by ClassImp(), getOrigin(), isInput(), isOutput(), and setOrigin().

◆ _nshare

Int_t URANIE::DataServer::TAttribute::_nshare

protected

The number of time this attribute is shared in TDataServer.

Referenced by addShare(), delShare(), getShare(), and initShare().

◆ _nType

EType URANIE::DataServer::TAttribute::_nType

protected

The type of attribute: real (double), vector (of double), string...

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), getDataType(), hasDefault(), and setDataType().

◆ _sFormatSubstitute

TString URANIE::DataServer::TAttribute::_sFormatSubstitute

protected

Format to substitute the value.

Referenced by getFormatToSubstitute(), and setFormatToSubstitute().

◆ _slurmValue

TString URANIE::DataServer::TAttribute::_slurmValue

protected

Referenced by getSlurmOption(), and setSlurmOption().

◆ _snote

TString URANIE::DataServer::TAttribute::_snote

protected

Note.

Referenced by ClassImp(), getNote(), and setNote().

◆ _stepValue

Double_t URANIE::DataServer::TAttribute::_stepValue

protected

Step value when using in Optimization.

Referenced by ClassImp().

◆ _sunity

TString URANIE::DataServer::TAttribute::_sunity

protected

Unity.

Referenced by ClassImp(), getUnit(), getUnity(), setUnit(), and setUnity().

◆ _vbuffer

vector<Double_t>* URANIE::DataServer::TAttribute::_vbuffer

protected

Referenced by ClassImp().

◆ _vmaximum

vector<Double_t> URANIE::DataServer::TAttribute::_vmaximum

protected

All maximun calculated.

Referenced by ClassImp(), and getMaximumSize().

◆ _vmean

vector<Double_t> URANIE::DataServer::TAttribute::_vmean

protected

All mean calculated.

Referenced by ClassImp(), and getMeanSize().

◆ _vminimum

vector<Double_t> URANIE::DataServer::TAttribute::_vminimum

protected

All minimun calculated.

Referenced by ClassImp(), and getMinimumSize().

◆ _vquantile

vector<map<double,double>* > URANIE::DataServer::TAttribute::_vquantile

protected

‍buffer pointer to check addresses

All Computed quantiles

Referenced by ClassImp().

◆ _vstd

vector<Double_t> URANIE::DataServer::TAttribute::_vstd

protected

All std calculated.

Referenced by ClassImp(), and getStdSize().

◆ lowerBound

Double_t URANIE::DataServer::TAttribute::lowerBound

protected

Lower bound.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and getLowerBound().

◆ upperBound

Double_t URANIE::DataServer::TAttribute::upperBound

protected

Upper bound.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and getUpperBound().

Documentation / Manuel développeur

Modules disponibles

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ EAttribute

◆ EOrigin

◆ EType

Constructor & Destructor Documentation

◆ TAttribute() [1/7]

◆ TAttribute() [2/7]

◆ TAttribute() [3/7]

◆ TAttribute() [4/7]

◆ TAttribute() [5/7]

◆ TAttribute() [6/7]

◆ TAttribute() [7/7]

◆ ~TAttribute()

Member Function Documentation

◆ addShare()

◆ changeLog()

◆ checkSizeBeforeGet()

◆ checkSizeBeforePush()

◆ clearVectors()

◆ Clone()

◆ delShare()

◆ getDataType()

◆ getDataTypeStr()

◆ getDefault()

◆ getDefaultString()

◆ getDefaultValue()

◆ getDefaultVector()

◆ getFormatToSubstitute()

◆ getInputOutput()

◆ getKeyList()

◆ getLegend()

◆ getLevel()

◆ getLog()

◆ getLowerBound()

◆ getMaximum()

◆ getMaximumSize()

◆ getMean()

◆ getMeanSize()

◆ getMinimum()

◆ getMinimumSize()

◆ getNote()

◆ getOrigin()

◆ getQuantile()

◆ getQuantiles()

◆ getQuantilesSize()

◆ getQuantileVector()

◆ getShare()

◆ getSlurmOption()

◆ getSonAttribute()

◆ getStatisticalVector()

◆ getStd()

◆ getStdSize()

◆ getStepValue()

◆ getTitle()

◆ getUnit()

◆ getUnity()

◆ getUpperBound()

◆ hasDefault()

◆ hasDefaultString()

◆ hasDefaultValue()

◆ hasDefaultVector()

◆ haveSon()

◆ initShare()

◆ isBounded()

◆ isInput()

◆ isLowerBounded()

◆ isOutput()

◆ isUpperBounded()

◆ printLog()

◆ removeSonAttribute()

◆ setBounds()

◆ setDataType() [1/2]

◆ setDataType() [2/2]

◆ setDefault()