Interface of a Salome_file managed This file is independent of a Salome module. More...

import"SALOME_Component.idl";

Inheritance diagram for Engines::Salome_file:

[legend]

Public Member Functions
void	load (in string hdf5_file) raises (SALOME::SALOME_Exception)
	Load a Salome_file from a hdf5 file. More...

void	save (in string hdf5_file) raises (SALOME::SALOME_Exception)
	Save a Salome_file into a hdf5_file. More...

void	save_all (in string hdf5_file) raises (SALOME::SALOME_Exception)
	Save a Salome_file into a hdf5_file. More...

void	setLocalFile (in string comp_file_name) raises (SALOME::SALOME_Exception)
	Add a Local file to the Salome_file. More...

void	setDistributedFile (in string comp_file_name) raises (SALOME::SALOME_Exception)
	Add a Distributed file to the Salome_file. More...

void	connect (in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception)
	Connect a Salome_file with another Salome_file. More...

void	connectDistributedFile (in string file_name, in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception)
	Connect the managed file file_name to a Salome_file. More...

void	setDistributedSourceFile (in string file_name, in string source_file_name) raises (SALOME::SALOME_Exception)
	Connect the file_name with a Distributed file_name. More...

void	recvFiles () raises (SALOME::SALOME_Exception)
	Get all the distributed files managed by the Salome_file and check all the local files. More...

void	removeFile (in string file_name) raises (SALOME::SALOME_Exception)
	Remove a file of the Salome_file. More...

void	removeFiles ()
	Remove all the files of the Salome_file. More...

Engines::files	getFilesInfos ()
	Get the list of the files managed by the Salome_file. More...

Engines::file	getFileInfos (in string file_name) raises (SALOME::SALOME_Exception)
	Get a file managed by the Salome_file. More...

Engines::SfState	getSalome_fileState ()
	Return the state of the Salome_file. More...

void	setContainer (in Engines::Container container)
	Set the container where files are. More...

long	open (in string fileName)
	Open the file transfer. More...

long	openW (in string fileName)
	Open the file transfer in write mode for file fileName. More...

void	close (in long fileId)
	Close the file transfer. More...

fileBlock	getBlock (in long fileId)
	Get a file data block. More...

void	putBlock (in long fileId, in fileBlock block)
	Put a file data block. More...

void	Register ()
	Increase the reference count (mark as used by another object). More...

void	UnRegister ()
	Decrease the reference count (release by another object). More...

void	Destroy ()
	Obsolete, left for compatibility reasons only. More...

Detailed Description

Interface of a Salome_file managed This file is independent of a Salome module.

It can managed one or more real files. It's useful for parallel files. Currently Salome_file cannot manage two files that have the same name but not the same path.

Member Function Documentation

◆ close()

void Engines::fileTransfer::close ( in long fileId )

inherited

Close the file transfer.

when the file transfer is finished, close method releases structures created by open method, identified by fileId.

◆ connect()

void Engines::Salome_file::connect	(	in Engines::Salome_file	source_Salome_file	)
raises	(	SALOME::SALOME_Exception
	)

Connect a Salome_file with another Salome_file.

It works only if the Salome_file managed only one file

Parameters

source_Salome_file Salome_file that managed the distributed version of the file.

Exceptions

raised if there is more or less than one file.

◆ connectDistributedFile()

void Engines::Salome_file::connectDistributedFile	(	in string	file_name,
		in Engines::Salome_file	source_Salome_file
	)
raises	(	SALOME::SALOME_Exception
	)

Connect the managed file file_name to a Salome_file.

Parameters

file_name	name of the file without the path.
source_Salome_file	Salome_file that managed the distributed version of the file.

Exceptions

raised if the file doesn't exist.

◆ Destroy()

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

◆ getBlock()

fileBlock Engines::fileTransfer::getBlock ( in long fileId )

inherited

Get a file data block.

Get successive blocks of octets from the original file. The last block is empty, and identifies the end of file.

◆ getFileInfos()

Engines::file Engines::Salome_file::getFileInfos	(	in string	file_name	)
raises	(	SALOME::SALOME_Exception
	)

Get a file managed by the Salome_file.

Parameters

file_name the name of the file.

Returns: CORBA file reference.

Exceptions

raised if the file doesn't exist.

◆ getFilesInfos()

Engines::files Engines::Salome_file::getFilesInfos ( )

Get the list of the files managed by the Salome_file.

The list can be empty.

◆ getSalome_fileState()

Engines::SfState Engines::Salome_file::getSalome_fileState ( )

Return the state of the Salome_file.

◆ load()

void Engines::Salome_file::load	(	in string	hdf5_file	)
raises	(	SALOME::SALOME_Exception
	)

Load a Salome_file from a hdf5 file.

Parameters

hdf5_file name (with path) of the hdf5_file.

Exceptions

contains information of errors if the loading doesn't succeed.

◆ open()

long Engines::fileTransfer::open ( in string fileName )

inherited

Open the file transfer.

open method returns a key (fileId) that identifies the structure (ex: C FILE), associated to the original file on the server. The structure is created by a container for transfer of files availables on the computer which runs the container. Each open gives a unique fileId, to allow concurrent reads of the same File.

◆ openW()

long Engines::fileTransfer::openW ( in string fileName )

inherited

Open the file transfer in write mode for file fileName.

Parameters

fileName the file to copy into with putBlock

Returns: the id to use with putBlock

◆ putBlock()

void Engines::fileTransfer::putBlock	(	in long	fileId,
		in fileBlock	block
	)

inherited

Put a file data block.

Parameters

fileId	identification of the file obtained by openW
block	a data block to copy into the file identified by fileId

◆ recvFiles()

void Engines::Salome_file::recvFiles	(		)
raises	(	SALOME::SALOME_Exception
	)

Get all the distributed files managed by the Salome_file and check all the local files.

Exceptions

raised if some of the files are not ok.

◆ Register()

void SALOME::GenericObj::Register ( )

inherited

Increase the reference count (mark as used by another object).

◆ removeFile()

void Engines::Salome_file::removeFile	(	in string	file_name	)
raises	(	SALOME::SALOME_Exception
	)

Remove a file of the Salome_file.

Parameters

file_name name of the file.

Exceptions

raised if the file doesn't exist.

◆ removeFiles()

void Engines::Salome_file::removeFiles ( )

Remove all the files of the Salome_file.

◆ save()

void Engines::Salome_file::save	(	in string	hdf5_file	)
raises	(	SALOME::SALOME_Exception
	)

Save a Salome_file into a hdf5_file.

Parameters

hdf5_file name (with path) of the hdf5_file.

Exceptions

contains information of errors if the save doesn't succeed.

◆ save_all()

void Engines::Salome_file::save_all	(	in string	hdf5_file	)
raises	(	SALOME::SALOME_Exception
	)

Save a Salome_file into a hdf5_file.

All files that are managed are saved into the hdf5_file

Parameters

hdf5_file name (with path) of the hdf5_file.

Exceptions

contains information of errors if the save doesn't succeed.

◆ setContainer()

void Engines::Salome_file::setContainer ( in Engines::Container container )

Set the container where files are.

Parameters

container container CORBA's reference.

◆ setDistributedFile()

void Engines::Salome_file::setDistributedFile	(	in string	comp_file_name	)
raises	(	SALOME::SALOME_Exception
	)

Add a Distributed file to the Salome_file.

Parameters

comp_file_name name of the file with the path.

Exceptions

raised if the file is already added into the Salome_file.

◆ setDistributedSourceFile()

void Engines::Salome_file::setDistributedSourceFile	(	in string	file_name,
		in string	source_file_name
	)
raises	(	SALOME::SALOME_Exception
	)

Connect the file_name with a Distributed file_name.

Parameters

file_name	name of the file without the path.
source_file_name	It's the name of the file managed by the distributed source Salome_file.

Exceptions

raised if the file doesn't exist.

◆ setLocalFile()

void Engines::Salome_file::setLocalFile	(	in string	comp_file_name	)
raises	(	SALOME::SALOME_Exception
	)

Add a Local file to the Salome_file.

Parameters

file_name name of the file with the path.

Exceptions

raised if the file is already added into the Salome_file.

◆ UnRegister()

void SALOME::GenericObj::UnRegister ( )

inherited

Decrease the reference count (release by another object).

Referenced by SALOME_PyNode.Generic::Destroy().

Public Member Functions

Detailed Description

Member Function Documentation

◆ close()

◆ connect()

◆ connectDistributedFile()

◆ Destroy()

◆ getBlock()

◆ getFileInfos()

◆ getFilesInfos()

◆ getSalome_fileState()

◆ load()

◆ open()

◆ openW()

◆ putBlock()

◆ recvFiles()

◆ Register()

◆ removeFile()

◆ removeFiles()

◆ save()

◆ save_all()

◆ setContainer()

◆ setDistributedFile()

◆ setDistributedSourceFile()

◆ setLocalFile()

◆ UnRegister()