Description of the class TInputFileFMU. More...

#include <TInputFileFMU.h>

Inheritance diagram for URANIE::Launcher::TInputFileFMU:

[legend]

Collaboration diagram for URANIE::Launcher::TInputFileFMU:

[legend]

Public Member Functions
Constructor and Destructor
	TInputFileFMU (TString str)
	Default constructor.

virtual	~TInputFileFMU ()
	Default destructor.

Setting and Getting attributs
void	setWorkingDirectory (TString sPathName="")
	Set the working directory.

TString	getWorkingDirectory ()
	Get the working directory.

Double_t	getStartTime ()

void	setStartTime (Double_t dval)

Double_t	getStopTime ()

void	setStopTime (Double_t dval)

Double_t	getStepTime ()

void	setStepTime (Double_t dval)

Double_t	getTolerance ()

void	setTolerance (Double_t dval)

Methods to perform initialisation and terminate states
virtual void	init ()
	The init step.

virtual void	terminate ()
	The terminate step.

File properties
Bool_t	isFileToCopy ()
	Gets the type of the file. This method is used to find InputFile of type 'Recreate'.

TString	getAttributeInKey (TString skey)
	Return the name of the attribute for the key.

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

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)
	Substitute the values of the attributes linked in the input file and write it.

methods associated to the FMI Library
void	setContext (fmi_import_context_t *fmi_ctxt)

fmi_import_context_t *	getContext ()

jm_callbacks *	getCallbackFMI ()

fmi1_import_t *	getFMU1Import ()

fmi2_import_t *	getFMU2Import ()

void	setVersion (fmi_version_enu_t fmi_version)

fmi_version_enu_t	getFMUVersion ()

const char *	getFMUVersionString ()

void	runFMI (Option_t *option="")

Int_t	simulate_fmi1_cs (Option_t *option="")
	simulate_fmi1_cs

Int_t	simulate_fmi2_cs (Option_t *option="")
	test_simulate_fmi2_cs

void	initFMI (Option_t *option="")

void	do_exit (int code)

void	init_fmi2_0 (Option_t *option="")
	init_fmi_v2_0

void	init_fmi1 (Option_t *option="")
	init_fmi1

vector< vector< double > >	getVectorValues ()

void	setListOutputVector (TArrayI *arr)

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.

Bool_t	isExist ()

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 ()

Protected Attributes
protected attributes
TString	_sFMUWorkingDirectory
	the FMU import directory

jm_callbacks *	_callbacks_FMI

fmi_import_context_t *	_context_FMI
	The FMU context.

fmi_version_enu_t	_sVersion
	The FMU version.

fmi1_import_t *	_fmi1Import
	The FMU 1.0 Object.

fmi2_import_t *	_fmi2Import
	The FMU 2.0 Object.

TString	_sGenerationTool
	The FMU generation tool.

TString	_sGenerationDateTime
	The FMU generation date and time.

TString	_sPlatformName
	The.

TString	_sModelName
	The.

TString	_sModelVersion
	The.

TString	_sGUID
	The.

Double_t	_dFMUStart
	The start time for default experiment as specified in the XML file.

Double_t	_dFMUStop
	The stop time for default experiment as specified in the XML file.

Double_t	_dFMUTolerance
	The tolerance for default experiment as specified in the XML file (not used)

Double_t	_dFMUStep
	The step for default experiment as specified in the XML file.

vector< vector< double > >	_vecOutputs
	the vector of stored kVector attributes

vector< int >	_vecVROutputs
	The vector of VR of the kVector Output attributes.

UInt_t	_no
	The number of kVector Output attributes.

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

Description of the class TInputFileFMU.

To be written by the developper.

Constructor & Destructor Documentation

◆ TInputFileFMU()

URANIE::Launcher::TInputFileFMU::TInputFileFMU ( TString str )

Default constructor.

Referenced by ClassImp().

◆ ~TInputFileFMU()

virtual URANIE::Launcher::TInputFileFMU::~TInputFileFMU ( )

virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ addAttribute()

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

virtual

addAttribute

Reimplemented from URANIE::Launcher::TInputFile.

Referenced by ClassImp().

◆ do_exit()

void URANIE::Launcher::TInputFileFMU::do_exit ( int code )

inline

Referenced by ClassImp().

◆ getAttributeInKey()

TString URANIE::Launcher::TInputFileFMU::getAttributeInKey ( TString skey )

Return the name of the attribute for the key.

The name of the attribute is the string after the last :"@" character

Referenced by ClassImp().

◆ getCallbackFMI()

jm_callbacks * URANIE::Launcher::TInputFileFMU::getCallbackFMI ( )

inline

References _callbacks_FMI.

◆ getContext()

fmi_import_context_t * URANIE::Launcher::TInputFileFMU::getContext ( )

inline

References _context_FMI.

◆ getFMU1Import()

fmi1_import_t * URANIE::Launcher::TInputFileFMU::getFMU1Import ( )

inline

References _fmi1Import.

◆ getFMU2Import()

fmi2_import_t * URANIE::Launcher::TInputFileFMU::getFMU2Import ( )

inline

References _fmi2Import.

◆ getFMUVersion()

fmi_version_enu_t URANIE::Launcher::TInputFileFMU::getFMUVersion ( )

inline

References _sVersion.

◆ getFMUVersionString()

const char * URANIE::Launcher::TInputFileFMU::getFMUVersionString ( )

Referenced by ClassImp().

◆ getStartTime()

Double_t URANIE::Launcher::TInputFileFMU::getStartTime ( )

inline

References _dFMUStart.

◆ getStepTime()

Double_t URANIE::Launcher::TInputFileFMU::getStepTime ( )

inline

References _dFMUStep.

◆ getStopTime()

Double_t URANIE::Launcher::TInputFileFMU::getStopTime ( )

inline

References _dFMUStop.

◆ getTolerance()

Double_t URANIE::Launcher::TInputFileFMU::getTolerance ( )

inline

References _dFMUTolerance.

◆ getVectorValues()

vector< vector< double > > URANIE::Launcher::TInputFileFMU::getVectorValues ( )

inline

References _vecOutputs.

◆ getWorkingDirectory()

TString URANIE::Launcher::TInputFileFMU::getWorkingDirectory ( )

inline

Get the working directory.

Returns

References _sFMUWorkingDirectory.

◆ init()

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

virtual

The init step.

Warning: not yet used

Reimplemented from URANIE::Launcher::TInputFile.

Referenced by ClassImp().

◆ init_fmi1()

void URANIE::Launcher::TInputFileFMU::init_fmi1 ( Option_t * option = "" )

init_fmi1

Parameters

option

Referenced by ClassImp().

◆ init_fmi2_0()

void URANIE::Launcher::TInputFileFMU::init_fmi2_0 ( Option_t * option = "" )

init_fmi_v2_0

Parameters

option

Referenced by ClassImp().

◆ initFMI()

void URANIE::Launcher::TInputFileFMU::initFMI ( Option_t * option = "" )

Referenced by ClassImp().

◆ isFileToCopy()

Bool_t URANIE::Launcher::TInputFileFMU::isFileToCopy ( )

inlinevirtual

Gets the type of the file. This method is used to find InputFile of type 'Recreate'.

Returns

Reimplemented from URANIE::Launcher::TInputFile.

◆ printLog()

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

virtual

Reimplemented from URANIE::Launcher::TInputFile.

Referenced by ClassImp().

◆ runFMI()

void URANIE::Launcher::TInputFileFMU::runFMI ( Option_t * option = "" )

Referenced by ClassImp().

◆ searchIndexeAttribute()

virtual void URANIE::Launcher::TInputFileFMU::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().

◆ setContext()

void URANIE::Launcher::TInputFileFMU::setContext ( fmi_import_context_t * fmi_ctxt )

inline

References _context_FMI.

◆ setListOutputVector()

void URANIE::Launcher::TInputFileFMU::setListOutputVector ( TArrayI * arr )

Referenced by ClassImp().

◆ setStartTime()

void URANIE::Launcher::TInputFileFMU::setStartTime ( Double_t dval )

inline

References _dFMUStart.

◆ setStepTime()

void URANIE::Launcher::TInputFileFMU::setStepTime ( Double_t dval )

inline

References _dFMUStep.

◆ setStopTime()

void URANIE::Launcher::TInputFileFMU::setStopTime ( Double_t dval )

inline

References _dFMUStop.

◆ setTolerance()

void URANIE::Launcher::TInputFileFMU::setTolerance ( Double_t dval )

inline

References _dFMUTolerance.

◆ setVersion()

void URANIE::Launcher::TInputFileFMU::setVersion ( fmi_version_enu_t fmi_version )

inline

References _sVersion.

◆ setWorkingDirectory()

void URANIE::Launcher::TInputFileFMU::setWorkingDirectory ( TString sPathName = "" )

Set the working directory.

Parameters

str

Referenced by ClassImp().

◆ simulate_fmi1_cs()

Int_t URANIE::Launcher::TInputFileFMU::simulate_fmi1_cs ( Option_t * option = "" )

simulate_fmi1_cs

Parameters

fmu

Returns

Referenced by ClassImp().

◆ simulate_fmi2_cs()

Int_t URANIE::Launcher::TInputFileFMU::simulate_fmi2_cs ( Option_t * option = "" )

test_simulate_fmi2_cs

Parameters

fmu

Returns

Referenced by ClassImp().

◆ substitue() [1/2]

void URANIE::Launcher::TInputFileFMU::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::TInputFileFMU::substitue	(	Int_t &	n,
		vector< URANIE::DataServer::UEntry * > *	ent,
		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.

◆ terminate()

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

virtual

The terminate step.

Warning: not yet used

Reimplemented from URANIE::Launcher::TInputFile.

Referenced by ClassImp().

Member Data Documentation

◆ _callbacks_FMI

jm_callbacks* URANIE::Launcher::TInputFileFMU::_callbacks_FMI

protected

Referenced by ClassImp(), and getCallbackFMI().

◆ _context_FMI

fmi_import_context_t* URANIE::Launcher::TInputFileFMU::_context_FMI

protected

The FMU context.

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

◆ _dFMUStart

Double_t URANIE::Launcher::TInputFileFMU::_dFMUStart

protected

The start time for default experiment as specified in the XML file.

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

◆ _dFMUStep

Double_t URANIE::Launcher::TInputFileFMU::_dFMUStep

protected

The step for default experiment as specified in the XML file.

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

◆ _dFMUStop

Double_t URANIE::Launcher::TInputFileFMU::_dFMUStop

protected

The stop time for default experiment as specified in the XML file.

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

◆ _dFMUTolerance

Double_t URANIE::Launcher::TInputFileFMU::_dFMUTolerance

protected

The tolerance for default experiment as specified in the XML file (not used)

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

◆ _fmi1Import

fmi1_import_t* URANIE::Launcher::TInputFileFMU::_fmi1Import

protected

The FMU 1.0 Object.

Referenced by ClassImp(), and getFMU1Import().

◆ _fmi2Import

fmi2_import_t* URANIE::Launcher::TInputFileFMU::_fmi2Import

protected

The FMU 2.0 Object.

Referenced by ClassImp(), and getFMU2Import().

◆ _no

UInt_t URANIE::Launcher::TInputFileFMU::_no

protected

The number of kVector Output attributes.

Referenced by ClassImp().

◆ _sFMUWorkingDirectory

TString URANIE::Launcher::TInputFileFMU::_sFMUWorkingDirectory

protected

the FMU import directory

Referenced by ClassImp(), and getWorkingDirectory().

◆ _sGenerationDateTime

TString URANIE::Launcher::TInputFileFMU::_sGenerationDateTime

protected

The FMU generation date and time.

Referenced by ClassImp().

◆ _sGenerationTool

TString URANIE::Launcher::TInputFileFMU::_sGenerationTool

protected

The FMU generation tool.

Referenced by ClassImp().

◆ _sGUID

TString URANIE::Launcher::TInputFileFMU::_sGUID

protected

The.

Referenced by ClassImp().

◆ _sModelName

TString URANIE::Launcher::TInputFileFMU::_sModelName

protected

The.

Referenced by ClassImp().

◆ _sModelVersion

TString URANIE::Launcher::TInputFileFMU::_sModelVersion

protected

The.

Referenced by ClassImp().

◆ _sPlatformName

TString URANIE::Launcher::TInputFileFMU::_sPlatformName

protected

The.

Referenced by ClassImp().

◆ _sVersion

fmi_version_enu_t URANIE::Launcher::TInputFileFMU::_sVersion

protected

The FMU version.

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

◆ _vecOutputs

vector<vector<double> > URANIE::Launcher::TInputFileFMU::_vecOutputs

protected

the vector of stored kVector attributes

Referenced by ClassImp(), and getVectorValues().

◆ _vecVROutputs

vector<int> URANIE::Launcher::TInputFileFMU::_vecVROutputs

protected

The vector of VR of the kVector Output attributes.

Referenced by ClassImp().

Documentation / Manuel développeur

Modules disponibles

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TInputFileFMU()

◆ ~TInputFileFMU()

Member Function Documentation

◆ addAttribute()

◆ do_exit()

◆ getAttributeInKey()

◆ getCallbackFMI()

◆ getContext()

◆ getFMU1Import()

◆ getFMU2Import()

◆ getFMUVersion()

◆ getFMUVersionString()

◆ getStartTime()

◆ getStepTime()

◆ getStopTime()

◆ getTolerance()

◆ getVectorValues()

◆ getWorkingDirectory()

◆ init()

◆ init_fmi1()

◆ init_fmi2_0()

◆ initFMI()

◆ isFileToCopy()

◆ printLog()

◆ runFMI()

◆ searchIndexeAttribute()

◆ setContext()

◆ setListOutputVector()

◆ setStartTime()

◆ setStepTime()

◆ setStopTime()

◆ setTolerance()

◆ setVersion()

◆ setWorkingDirectory()

◆ simulate_fmi1_cs()

◆ simulate_fmi2_cs()

◆ substitue() [1/2]

◆ substitue() [2/2]

◆ terminate()

Member Data Documentation

◆ _callbacks_FMI

◆ _context_FMI

◆ _dFMUStart

◆ _dFMUStep

◆ _dFMUStop

◆ _dFMUTolerance

◆ _fmi1Import

◆ _fmi2Import

◆ _no

◆ _sFMUWorkingDirectory

◆ _sGenerationDateTime

◆ _sGenerationTool

◆ _sGUID

◆ _sModelName

◆ _sModelVersion

◆ _sPlatformName

◆ _sVersion

◆ _vecOutputs

◆ _vecVROutputs