English Français

Documentation / Developer's manual

Available modules

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

A class for input file of a code with a key. More...

#include <TInputFileKey.h>

Inheritance diagram for URANIE::Launcher::TInputFileKey:
Collaboration diagram for URANIE::Launcher::TInputFileKey:

Public Member Functions

Constructor and Destructor
 TInputFileKey (TString str)
 Default constructor.
 
virtual ~TInputFileKey ()
 Default destructor.
 
Methods to perform initialisation and terminate states
virtual void init ()
 The init step.
 
virtual void terminate ()
 The terminate step.
 
Implement the abstract pure methods
virtual void searchIndexeAttribute (URANIE::DataServer::TAttribute *att)
 search the indexes of the attribute in the input file
 
void substitue (Int_t &n, Double_t *val, Int_t *index=NULL)
 Substitute the values of the attributes linked in the input file and write it.
 
void substitue (Int_t &n, vector< URANIE::DataServer::UEntry * > *ent, Int_t *index=NULL)
 
The Log
virtual void printLog (Option_t *option="")
 
- Public Member Functions inherited from URANIE::Launcher::TInputFile
 TInputFile (TString str)
 Default constructor.
 
virtual ~TInputFile ()
 Default destructor.
 
virtual void addAttribute (URANIE::DataServer::TAttribute *)
 Add the attribute in the file.
 
Bool_t isExist ()
 
virtual Bool_t isFileToCopy ()
 Get if the file must be copied (default is kTRUE)
 
- Public Member Functions inherited from URANIE::Launcher::TCodeFile
 TCodeFile (TString str)
 Default constructor.
 
virtual ~TCodeFile ()
 Default destructor.
 
TString getFileName ()
 
void setCommentCharacter (const char *str)
 
const char * getCommentCharacter ()
 
void setSeparatorCharacter (const char *str)
 
const char * getSeparatorCharacter ()
 
void setFieldSeparatorCharacter (const char *str)
 
const char * getFieldSeparatorCharacter ()
 
URANIE::DataServer::TAttribute * getAttribute (Int_t ind)
 
Int_t getAttributesNumber () const
 
Int_t getNAttributes () const
 
void setVectorProperties (TString beg, TString delim, TString end)
 
void setStringProperties (TString beg, TString end)
 
void getBegEndProperties (URANIE::DataServer::TAttribute *att, TString &beg, TString &end)
 
Bool_t isAttribute (TString sAttributeName)
 Verify is the attribute given by the name is is the list of attribute.
 
void setLog ()
 
void unsetLog ()
 
void changeLog ()
 
Bool_t getLog ()
 

Additional Inherited Members

- Public Attributes inherited from URANIE::Launcher::TCodeFile
vector< URANIE::DataServer::TAttribute * > _attributes
 Vector of attributes.
 
TString _svecbeg
 
TString _svecend
 
TString _svecdel
 
TString _sstrbeg
 
TString _sstrend
 string used for the beginning, end and delimitation of vectors and strings
 
TString _sFileName
 The name of file.
 
Bool_t _blog
 Boolean for edit the log.
 
TString _cComments
 The set of comment character.
 
TString _cSeparators
 The set of separator character.
 
TString _cFieldSeparator
 the separator to be used in between fields
 

Detailed Description

A class for input file of a code with a key.

Description of the class TInputFileKey.

The method is Key = value ;.

Moreover, the key must jus appear once. Contrary to the notion Flag TInputFileKeyFlag where the flag can appear several times.

To be written by the developper.

Constructor & Destructor Documentation

◆ TInputFileKey()

URANIE::Launcher::TInputFileKey::TInputFileKey ( TString  str)

Default constructor.

Referenced by ClassImp().

◆ ~TInputFileKey()

virtual URANIE::Launcher::TInputFileKey::~TInputFileKey ( )
virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ init()

virtual void URANIE::Launcher::TInputFileKey::init ( )
virtual

The init step.

Warning
not yet used

Reimplemented from URANIE::Launcher::TInputFile.

Referenced by ClassImp().

◆ printLog()

virtual void URANIE::Launcher::TInputFileKey::printLog ( Option_t *  option = "")
virtual

Reimplemented from URANIE::Launcher::TInputFile.

Referenced by ClassImp().

◆ searchIndexeAttribute()

virtual void URANIE::Launcher::TInputFileKey::searchIndexeAttribute ( URANIE::DataServer::TAttribute *  att)
virtual

search the indexes of the attribute in the input file

Parameters
att(URANIE::DataServer::TAttribute*) the attribute to search the indexes

Implements URANIE::Launcher::TInputFile.

Referenced by ClassImp().

◆ substitue() [1/2]

void URANIE::Launcher::TInputFileKey::substitue ( Int_t &  n,
Double_t *  val,
Int_t *  index = NULL 
)
virtual

Substitute the values of the attributes linked in the input file and write it.

The first value is defined par the parameter n and the values are stored in the parameter val. After the method, the parameter is increased by the number of attributes contained in the input file.

Parameters
n(Int_t &) the index of the first value in the vector of data val
val(Double_t *) the pointer of the data
index(Int_t *)the pointer of the index of data

Implements URANIE::Launcher::TInputFile.

Referenced by ClassImp().

◆ substitue() [2/2]

void URANIE::Launcher::TInputFileKey::substitue ( Int_t &  n,
vector< URANIE::DataServer::UEntry * > *  ent,
Int_t *  index = NULL 
)
virtual

◆ terminate()

virtual void URANIE::Launcher::TInputFileKey::terminate ( )
virtual

The terminate step.

Warning
not yet used

Reimplemented from URANIE::Launcher::TInputFile.

Referenced by ClassImp().