English Français

Documentation / Manuel développeur

Modules disponibles

Calibration,  DataServer,  Launcher,  MetaModelOptim,  Modeler,  Optimizer,  ReLauncher,  Reliability,  ReOptimizer,  Sampler,  Sensitivity,  UncertModeler,  XmlProblem,   Uranie / DataServer: URANIE::DataServer::TPossibilityAttribute Class Reference
Uranie / DataServer v4.9.0
/* @license-end */
URANIE::DataServer::TPossibilityAttribute Class Reference

#include <TPossibilityAttribute.h>

Inheritance diagram for URANIE::DataServer::TPossibilityAttribute:
Collaboration diagram for URANIE::DataServer::TPossibilityAttribute:

Public Types

enum  EPossibilityType {
  kUniform , kTriangular , kTrapezium , kPolygonal ,
  kUnknown
}
 The list of possibility that a TAttribute can follow. More...
 
enum  EMonotonousRelationship { kIncreasing , kDecreasing , kNotDefined }
 The list of monotonous relationship
More...
 
- Public Types inherited from URANIE::DataServer::TAttribute
enum  EOrigin {
  kInternal , kIterator , kConstant , kAttribute ,
  kDeleted
}
 
enum  EAttribute { kInput , kOutput }
 
enum  EType {
  kDefault , kReal , kVector , kString ,
  kCategory , kInconnu
}
 

Public Member Functions

 TPossibilityAttribute (TString str)
 Constructor setting default possibility by the name.
 
 TPossibilityAttribute (TString str, EPossibilityType value, EMonotonousRelationship monotonous)
 Constructor setting the name and the law type.
 
 TPossibilityAttribute (TString str, EPossibilityType value, Double_t min, Double_t max, EMonotonousRelationship monotonous)
 Constructor setting the name, the law type, and the range (lower and upper bounds)
 
virtual ~TPossibilityAttribute ()
 Default Destructor.
 
Treat the relationship of monotonous
int getMonotonousRelationship ()
 Get the relationship of monotonous.
 
Bool_t isIncreasing ()
 is the relationship of monotonous of the attribute is Increasing
 
Bool_t isDecreasing ()
 is the relationship of monotonous of the attribute is Decreasing
 
Possibility Representation
int getLawType ()
 Returns the law type as an integer.
 
Printing Log
virtual void printLog ()
 Display information specific to this class.
 
- Public Member Functions inherited from URANIE::DataServer::TAttribute
 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.
 
TAttributeClone (const char *newname) const
 Clone an attribute with a new name.
 
virtual ~TAttribute ()
 Default destructor.
 
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)
 
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.
 
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")
 
const char * getFormatToSubstitute ()
 Returns the format of substitution.
 
void setFormatToSubstitute (TString str)
 Sets the format of substitution.
 
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 ()
 
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.
 
void setLog ()
 
void unsetLog ()
 
void changeLog ()
 
Bool_t getLog ()
 
TAttributegetSonAttribute ()
 
void setSonAttribute (TAttribute *tatt)
 
void removeSonAttribute ()
 
Int_t getLevel ()
 
void setLevel (Int_t nlevel)
 
Bool_t haveSon ()
 

Public Attributes

EPossibilityType _PossibilityType
 The possibility type EPossibilityType.
 
EMonotonousRelationship _MonotonousRelationship
 The relationship of monotonous.
 

Additional Inherited Members

- Protected Attributes inherited from URANIE::DataServer::TAttribute
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
 
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.
 
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.
 
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...
 
TString _slurmValue
 

Detailed Description

This is the parent class for all attributes which values can be generated by a possibilty (cf RaFu IRSN). Child objects are possibility attributes following a specific possibility.

Each must be redefined in the daughter classes.

Member Enumeration Documentation

◆ EMonotonousRelationship

The list of monotonous relationship

Enumerator
kIncreasing 
kDecreasing 
kNotDefined 

◆ EPossibilityType

The list of possibility that a TAttribute can follow.

Enumerator
kUniform 
kTriangular 
kTrapezium 
kPolygonal 
kUnknown 

Constructor & Destructor Documentation

◆ TPossibilityAttribute() [1/3]

URANIE::DataServer::TPossibilityAttribute::TPossibilityAttribute ( TString  str)

Constructor setting default possibility by the name.

The default is possibility "kUnknown" and the relationshio of monotonous is "kNotDefined"

Parameters
str(TString) Name of the attribute

Referenced by ClassImp().

◆ TPossibilityAttribute() [2/3]

URANIE::DataServer::TPossibilityAttribute::TPossibilityAttribute ( TString  str,
EPossibilityType  value,
EMonotonousRelationship  monotonous 
)

Constructor setting the name and the law type.

Parameters
str(TString) Name of the attribute
value(EPossibilityType) The type of the probability law of the attribute.
monotonous(EMonotonousRelationship) The relationship of monotonous The available types are defined in the EPossibilityType enumerator

◆ TPossibilityAttribute() [3/3]

URANIE::DataServer::TPossibilityAttribute::TPossibilityAttribute ( TString  str,
EPossibilityType  value,
Double_t  min,
Double_t  max,
EMonotonousRelationship  monotonous 
)

Constructor setting the name, the law type, and the range (lower and upper bounds)

Parameters
str(TString) Name of the attribute
value(EPossibilityType) The type of the probability law of the attribute.
monotonous(EMonotonousRelationship) The relationship of monotonous
min(Double_t) Lower bound of the attribute's range
max(Double_t) Upper bound of the attribute's range

◆ ~TPossibilityAttribute()

virtual URANIE::DataServer::TPossibilityAttribute::~TPossibilityAttribute ( )
virtual

Default Destructor.

Referenced by ClassImp().

Member Function Documentation

◆ getLawType()

int URANIE::DataServer::TPossibilityAttribute::getLawType ( )
inline

Returns the law type as an integer.

References _PossibilityType.

◆ getMonotonousRelationship()

int URANIE::DataServer::TPossibilityAttribute::getMonotonousRelationship ( )
inline

Get the relationship of monotonous.

References _PossibilityType.

◆ isDecreasing()

Bool_t URANIE::DataServer::TPossibilityAttribute::isDecreasing ( )
inline

is the relationship of monotonous of the attribute is Decreasing

References _MonotonousRelationship, and kDecreasing.

◆ isIncreasing()

Bool_t URANIE::DataServer::TPossibilityAttribute::isIncreasing ( )
inline

is the relationship of monotonous of the attribute is Increasing

References _MonotonousRelationship, and kIncreasing.

◆ printLog()

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

Display information specific to this class.

Reimplemented from URANIE::DataServer::TAttribute.

Reimplemented in URANIE::DataServer::TTrapeziumPossibility, and URANIE::DataServer::TTriangularPossibility.

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

Member Data Documentation

◆ _MonotonousRelationship

EMonotonousRelationship URANIE::DataServer::TPossibilityAttribute::_MonotonousRelationship

The relationship of monotonous.

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

◆ _PossibilityType

EPossibilityType URANIE::DataServer::TPossibilityAttribute::_PossibilityType

The possibility type EPossibilityType.

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