English Français

Documentation / Manuel développeur

Modules disponibles

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

Abstract class for an input file of a code. More...

#include <TInputFile.h>

Inheritance diagram for URANIE::Launcher::TInputFile:
Collaboration diagram for URANIE::Launcher::TInputFile:

Public Member Functions

Constructor and Destructor
 TInputFile (TString str)
 Default constructor.
 
virtual ~TInputFile ()
 Default destructor.
 
Setting and Getting attributes
virtual void addAttribute (URANIE::DataServer::TAttribute *)
 Add the attribute in the file.
 
Bool_t isExist ()
 
Methods to perform initialisation and terminate states
virtual void init ()
 The init step.
 
virtual void terminate ()
 The terminate step.
 
File properties
virtual Bool_t isFileToCopy ()
 Get if the file must be copied (default is kTRUE)
 
Abstract pure methods

these two methods must be implement in a daughter class.

virtual void searchIndexeAttribute (URANIE::DataServer::TAttribute *att)=0
 search the indexes of the attribute in the input file
 
virtual void substitue (Int_t &n, Double_t *val, Int_t *index=NULL)=0
 Substitute the values of the attributes linked in the input file and write it.
 
virtual void substitue (Int_t &n, vector< URANIE::DataServer::UEntry * > *ent, Int_t *index=NULL)=0
 
The Log
virtual void printLog (Option_t *option="")
 
- 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

Abstract class for an input file of a code.

Warning
This class contains two pure abstracted methods
  • searchIndexeAttribute : the method is to find the indexes of the attribute in the input file
  • substitue : the method is to substitute the value in the input file must to implement in a daughter class.

Constructor & Destructor Documentation

◆ TInputFile()

URANIE::Launcher::TInputFile::TInputFile ( TString  str)

Default constructor.

Referenced by ClassImp().

◆ ~TInputFile()

virtual URANIE::Launcher::TInputFile::~TInputFile ( )
virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ addAttribute()

virtual void URANIE::Launcher::TInputFile::addAttribute ( URANIE::DataServer::TAttribute *  )
virtual

Add the attribute in the file.

Reimplemented from URANIE::Launcher::TCodeFile.

Reimplemented in URANIE::Launcher::TInputFileFMU.

Referenced by ClassImp().

◆ init()

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

The init step.

Warning
not yet used

Reimplemented in URANIE::Launcher::TInputFileFMU, and URANIE::Launcher::TInputFileKey.

Referenced by ClassImp().

◆ isExist()

Bool_t URANIE::Launcher::TInputFile::isExist ( )

Referenced by ClassImp().

◆ isFileToCopy()

virtual Bool_t URANIE::Launcher::TInputFile::isFileToCopy ( )
inlinevirtual

Get if the file must be copied (default is kTRUE)

Returns

Reimplemented in URANIE::Launcher::TInputFileFMU, URANIE::Launcher::TInputFileRecreate, and URANIE::Launcher::TInputFileXML.

Referenced by ClassImp().

◆ printLog()

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

◆ searchIndexeAttribute()

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

search the indexes of the attribute in the input file

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

Implemented in URANIE::Launcher::TInputFileFlag, URANIE::Launcher::TInputFileFMU, URANIE::Launcher::TInputFileKey, URANIE::Launcher::TInputFileRecreate, and URANIE::Launcher::TInputFileXML.

Referenced by ClassImp().

◆ substitue() [1/2]

virtual void URANIE::Launcher::TInputFile::substitue ( Int_t &  n,
Double_t *  val,
Int_t *  index = NULL 
)
pure 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

Implemented in URANIE::Launcher::TInputFileFlag, URANIE::Launcher::TInputFileFMU, URANIE::Launcher::TInputFileKey, URANIE::Launcher::TInputFileRecreate, and URANIE::Launcher::TInputFileXML.

Referenced by ClassImp().

◆ substitue() [2/2]

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

◆ terminate()

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

The terminate step.

Warning
not yet used

Reimplemented in URANIE::Launcher::TInputFileFMU, and URANIE::Launcher::TInputFileKey.

Referenced by ClassImp().