Salome_file_i Class Reference

A class to manage file transfer in SALOME. More...

#include <Salome_file_i.hxx>

Inheritance diagram for Salome_file_i:

Public Member Functions
	Salome_file_i ()
	Default constructor,. More...
virtual	~Salome_file_i ()
	Destructor. More...
virtual void	load (const char *hdf5_file)
	CORBA method. More...
virtual void	save (const char *hdf5_file)
	CORBA method. More...
virtual void	save_all (const char *hdf5_file)
	CORBA method. More...
virtual void	setLocalFile (const char *comp_file_name)
	CORBA method. More...
virtual void	setDistributedFile (const char *comp_file_name)
	CORBA method. More...
virtual void	connect (Engines::Salome_file_ptr source_Salome_file)
	CORBA method. More...
virtual void	connectDistributedFile (const char *file_name, Engines::Salome_file_ptr source_Salome_file)
	CORBA method. More...
virtual void	setDistributedSourceFile (const char *file_name, const char *source_file_name)
	CORBA method. More...
virtual void	recvFiles ()
	CORBA method. More...
virtual void	removeFile (const char *file_name)
	CORBA method. More...
virtual void	removeFiles ()
	CORBA method. More...
virtual void	setContainer (Engines::Container_ptr container)
virtual Engines::files *	getFilesInfos ()
	CORBA method. More...
virtual Engines::file *	getFileInfos (const char *file_name)
	CORBA method. More...
virtual Engines::SfState *	getSalome_fileState ()
	CORBA method. More...
virtual CORBA::Long	open (const char *file_name)
	CORBA method: try to open the file given. More...
virtual void	close (CORBA::Long fileId)
	CORBA method: close the file associated to the fileId given at open. More...
virtual Engines::fileBlock *	getBlock (CORBA::Long fileId)
CORBA::Long	openW (const char *fileName)
	open the given file in write mode (for copy) More...
void	putBlock (CORBA::Long fileId, const Engines::fileBlock &block)
	put a data block for copy into a file More...
virtual PortableServer::POA_ptr	_default_POA ()
	Get default POA for the servant object. More...
virtual void	Register ()
	Increment reference counter. More...
virtual void	UnRegister ()
	Decrement reference counter. More...
virtual void	Destroy ()
	Decrement reference counter. More...

Protected Types
typedef std::map< int, FILE * >	_t_fileAccess
typedef std::map< std::string, Engines::file >	_t_fileManaged
typedef std::map< std::string, Engines::Salome_file_var >	_t_fileDistributedSource

Protected Member Functions
virtual bool	checkLocalFile (std::string file_name)
	local C++ method : This method is used by revFiles to check if a local managed file is ok. More...
virtual bool	getDistributedFile (std::string file_name)
	local C++ method : this method is used by recvFiles to get a distributed file from is distributed source. More...

Protected Attributes
int	_fileId
long	_path_max
_t_fileAccess	_fileAccess
_t_fileManaged	_fileManaged
_t_fileDistributedSource	_fileDistributedSource
Engines::SfState	_state
Engines::Container_ptr	_container
Engines::Salome_file_var	_default_source_Salome_file
int	_fileKey
int	_ctr
PortableServer::POA_var	myPOA
int	myRefCounter

Detailed Description

A class to manage file transfer in SALOME.

Member Typedef Documentation

_t_fileAccess

typedef std::map<int, FILE*> Salome_file_i::_t_fileAccess

protected

_t_fileDistributedSource

typedef std::map<std::string, Engines::Salome_file_var> Salome_file_i::_t_fileDistributedSource

protected

_t_fileManaged

typedef std::map<std::string, Engines::file> Salome_file_i::_t_fileManaged

protected

Constructor & Destructor Documentation

Salome_file_i()

Salome_file_i::Salome_file_i

(

)

Default constructor,.

References _container, _default_source_Salome_file, _fileId, _path_max, _state, Engines::SfState::files_ok, Engines::SfState::hdf5_file_name, Engines::SfState::name, and Engines::SfState::number_of_files.

~Salome_file_i()

Salome_file_i::~Salome_file_i ( )

virtual

Destructor.

Member Function Documentation

_default_POA()

PortableServer::POA_ptr SALOME::GenericObj_i::_default_POA ( )

virtualinherited

Get default POA for the servant object.

This function is implicitly called from "_this()" function. Default POA can be set via the constructor.

Returns

reference to the default POA for the servant

Reimplemented in SALOMEDS_UseCaseIterator_i, SALOMEDS_UseCaseBuilder_i, SALOMEDS_SObject_i, SALOMEDS_SComponentIterator_i, SALOMEDS_GenericAttribute_i, and SALOMEDS_ChildIterator_i.

References SALOME::GenericObj_i::myPOA.

checkLocalFile()

bool Salome_file_i::checkLocalFile ( std::string  file_name )

protectedvirtual

local C++ method : This method is used by revFiles to check if a local managed file is ok.

Parameters

fileName

name of the file

References _fileManaged, and ORBConfigFile::path.

Referenced by recvFiles(), and Parallel_Salome_file_i::recvFiles_node().

close()

void Salome_file_i::close ( CORBA::Long  fileId )

virtual

CORBA method: close the file associated to the fileId given at open.

Parameters

fileId

got in return from open method

References _fileAccess, and MESSAGE.

Referenced by load().

connect()

void Salome_file_i::connect ( Engines::Salome_file_ptr  source_Salome_file )

virtual

CORBA method.

See also

Engines::Salome_file::connect

Reimplemented in Parallel_Salome_file_i.

References _default_source_Salome_file, _fileDistributedSource, _fileManaged, SALOME::INTERNAL_ERROR, SALOME::ExceptionStruct::text, and SALOME::ExceptionStruct::type.

Referenced by Parallel_Salome_file_i::connect().

connectDistributedFile()

void Salome_file_i::connectDistributedFile ( const char *  file_name, Engines::Salome_file_ptr  source_Salome_file  )

virtual

CORBA method.

See also

Engines::Salome_file::connectDistributedFile

Reimplemented in Parallel_Salome_file_i.

References _fileDistributedSource, _fileManaged, SALOME::INTERNAL_ERROR, SALOME::ExceptionStruct::text, and SALOME::ExceptionStruct::type.

Referenced by Parallel_Salome_file_i::connectDistributedFile(), and main().

Destroy()

void SALOME::GenericObj_i::Destroy ( )

virtualinherited

Decrement reference counter.

Deprecated:

Use UnRegister() instead.

References MESSAGE, and SALOME::GenericObj_i::UnRegister().

getBlock()

Engines::fileBlock * Salome_file_i::getBlock ( CORBA::Long  fileId )

virtual

References _fileAccess, and FILEBLOCK_SIZE.

getDistributedFile()

bool Salome_file_i::getDistributedFile ( std::string  file_name )

protectedvirtual

local C++ method : this method is used by recvFiles to get a distributed file from is distributed source.

If there is no source_file_name for the file, it tries to get the file from the source. In this case, the source distributed file has to managed only one file to be able to the send the file.

Parameters

fileName

name of the file

References _fileDistributedSource, _fileManaged, MESSAGE, and ORBConfigFile::path.

Referenced by recvFiles(), and Parallel_Salome_file_i::recvFiles_node().

getFileInfos()

Engines::file * Salome_file_i::getFileInfos ( const char *  file_name )

virtual

CORBA method.

See also

Engines::Salome_file::getFileInfos

References _fileManaged, SALOME::INTERNAL_ERROR, SALOME::ExceptionStruct::text, and SALOME::ExceptionStruct::type.

Referenced by main().

getFilesInfos()

Engines::files * Salome_file_i::getFilesInfos ( )

virtual

CORBA method.

See also

Engines::Salome_file::getFilesInfos

References _fileManaged.

Referenced by main().

getSalome_fileState()

Engines::SfState * Salome_file_i::getSalome_fileState ( )

virtual

CORBA method.

See also

Engines::Salome_file::getSalome_fileState

References _state.

Referenced by main().

load()

void Salome_file_i::load ( const char *  hdf5_file )

virtual

CORBA method.

See also

Engines::Salome_file::load

Reimplemented in Parallel_Salome_file_i.

References _container, _fileManaged, _path_max, _state, close(), HDFdataset::CloseOnDisk(), Engines::file::container, Engines::file::file_name, Engines::SfState::files_ok, HDFdataset::GetSize(), Engines::SfState::hdf5_file_name, HDF_RDONLY, SALOME::INTERNAL_ERROR, pythfilter::name, Engines::file::node, Engines::SfState::number_of_files, open(), HDFdataset::OpenOnDisk(), HDFgroup::OpenOnDisk(), HDFfile::OpenOnDisk(), ORBConfigFile::path, Engines::file::path, HDFdataset::ReadFromDisk(), Engines::file::source_file_name, salomeContext::status, Engines::file::status, SALOME::ExceptionStruct::text, Engines::file::type, and SALOME::ExceptionStruct::type.

Referenced by main().

open()

CORBA::Long Salome_file_i::open ( const char *  file_name )

virtual

CORBA method: try to open the file given.

If the file is readable, return a positive integer else return 0;

Parameters

fileName

file name to be transferred

Returns

fileId = positive integer > 0 if open OK.

References _fileAccess, _fileId, _fileManaged, MESSAGE, and ORBConfigFile::path.

Referenced by load().

openW()

CORBA::Long fileTransfer_i::openW ( const char *  fileName )

inherited

open the given file in write mode (for copy)

CORBA method: try to open the file. If the file is writable, return a positive integer else return 0;

Parameters

fileName

path to the file to be transferred

Returns

fileId = positive integer > 0 if open OK.

References fileTransfer_i::_ctr, fileTransfer_i::_fileAccess, and fileTransfer_i::_fileKey.

putBlock()

void fileTransfer_i::putBlock ( CORBA::Long  fileId, const Engines::fileBlock &  block  )

inherited

put a data block for copy into a file

CORBA method: put a block of data into the file associated to the fileId given at openW.

Parameters

fileId	got in return from openW method
block	an octet sequence to copy into opened file

References fileTransfer_i::_fileAccess, and SALOME_utilities::SCRUTE().

recvFiles()

void Salome_file_i::recvFiles ( )

virtual

CORBA method.

See also

Engines::Salome_file::recvFiles

Reimplemented in Parallel_Salome_file_i.

References _fileManaged, _state, checkLocalFile(), Engines::file::file_name, Engines::SfState::files_ok, getDistributedFile(), SALOME::INTERNAL_ERROR, Engines::file::status, SALOME::ExceptionStruct::text, Engines::file::type, and SALOME::ExceptionStruct::type.

Referenced by Engines_Component_i::checkInputFilesToService(), Engines_Component_i::checkOutputFilesToService(), Abstract_Engines_Container_i::createSalome_file(), Engines_Parallel_Container_i::createSalome_file(), and main().

Register()

void SALOME::GenericObj_i::Register ( )

virtualinherited

Increment reference counter.

References IS_OBJ_IN_QUESTION, MESSAGE, and SALOME::GenericObj_i::myRefCounter.

removeFile()

void Salome_file_i::removeFile ( const char *  file_name )

virtual

CORBA method.

See also

Engines::Salome_file::removeFile

References MESSAGE.

removeFiles()

void Salome_file_i::removeFiles ( )

virtual

CORBA method.

See also

Engines::Salome_file::removeFiles

References MESSAGE.

save()

void Salome_file_i::save ( const char *  hdf5_file )

virtual

CORBA method.

See also

Engines::Salome_file::save

Reimplemented in Parallel_Salome_file_i.

References _fileManaged, _state, HDFdataset::CloseOnDisk(), HDFfile::CloseOnDisk(), HDFgroup::CloseOnDisk(), HDFdataset::CreateOnDisk(), HDFfile::CreateOnDisk(), HDFgroup::CreateOnDisk(), Engines::file::file_name, Engines::SfState::hdf5_file_name, HDF_STRING, SALOME::INTERNAL_ERROR, ORBConfigFile::path, Engines::file::path, Engines::file::source_file_name, Engines::file::status, SALOME::ExceptionStruct::text, Engines::file::type, SALOME::ExceptionStruct::type, and HDFdataset::WriteOnDisk().

Referenced by main().

save_all()

void Salome_file_i::save_all ( const char *  hdf5_file )

virtual

CORBA method.

See also

Engines::Salome_file::save_all

Reimplemented in Parallel_Salome_file_i.

References _fileManaged, _state, HDFdataset::CloseOnDisk(), HDFfile::CloseOnDisk(), HDFgroup::CloseOnDisk(), HDFdataset::CreateOnDisk(), HDFfile::CreateOnDisk(), HDFgroup::CreateOnDisk(), Engines::file::file_name, Engines::SfState::files_ok, HDFConvert::FromAscii(), Engines::SfState::hdf5_file_name, HDF_STRING, SALOME::INTERNAL_ERROR, ORBConfigFile::path, Engines::file::path, Engines::file::source_file_name, Engines::file::status, SALOME::ExceptionStruct::text, Engines::file::type, SALOME::ExceptionStruct::type, and HDFdataset::WriteOnDisk().

Referenced by main().

setContainer()

void Salome_file_i::setContainer ( Engines::Container_ptr  container )

virtual

Reimplemented in Parallel_Salome_file_i.

References _container, _fileManaged, and TestComponentPy::container.

Referenced by Abstract_Engines_Container_i::createSalome_file(), Engines_Component_i::setInputFileToService(), and Engines_Component_i::setOutputFileToService().

setDistributedFile()

void Salome_file_i::setDistributedFile ( const char *  comp_file_name )

virtual

CORBA method.

See also

Engines::Salome_file::setDistributedFile

References _container, _default_source_Salome_file, _fileDistributedSource, _fileManaged, _path_max, _state, Engines::file::container, Engines::file::file_name, Engines::SfState::files_ok, python_test_driver::index, SALOME::INTERNAL_ERROR, Engines::file::node, Engines::SfState::number_of_files, ORBConfigFile::path, Engines::file::path, Engines::file::source_file_name, salomeContext::status, Engines::file::status, SALOME::ExceptionStruct::text, Engines::file::type, and SALOME::ExceptionStruct::type.

Referenced by main().

setDistributedSourceFile()

void Salome_file_i::setDistributedSourceFile ( const char *  file_name, const char *  source_file_name  )

virtual

CORBA method.

See also

Engines::Salome_file::setDistributedSourceFile

Reimplemented in Parallel_Salome_file_i.

References _fileManaged, SALOME::INTERNAL_ERROR, SALOME::ExceptionStruct::text, and SALOME::ExceptionStruct::type.

Referenced by Parallel_Salome_file_i::setDistributedSourceFile().

setLocalFile()

void Salome_file_i::setLocalFile ( const char *  comp_file_name )

virtual

CORBA method.

See also

Engines::Salome_file::setLocalFile

References _container, _fileManaged, _path_max, _state, Engines::file::container, Engines::file::file_name, Engines::SfState::files_ok, python_test_driver::index, SALOME::INTERNAL_ERROR, Engines::file::node, Engines::SfState::number_of_files, ORBConfigFile::path, Engines::file::path, Engines::file::source_file_name, salomeContext::status, Engines::file::status, SALOME::ExceptionStruct::text, Engines::file::type, and SALOME::ExceptionStruct::type.

Referenced by Abstract_Engines_Container_i::createSalome_file(), Engines_Parallel_Container_i::createSalome_file(), and main().

UnRegister()

void SALOME::GenericObj_i::UnRegister ( )

virtualinherited

Decrement reference counter.

As soon as reference counter goes to zero, the object is automatically deactivated.

References IS_OBJ_IN_QUESTION, MESSAGE, SALOME::GenericObj_i::myPOA, and SALOME::GenericObj_i::myRefCounter.

Referenced by SALOME::GenericObj_i::Destroy(), and SALOME_PyNode.Generic::Destroy().

Field Documentation

_container

Engines::Container_ptr Salome_file_i::_container

protected

Referenced by SALOME_Container.SALOME_Container_Abstract_i::create_component_instance(), load(), Salome_file_i(), setContainer(), Parallel_Salome_file_i::setContainer(), setDistributedFile(), setLocalFile(), and Parallel_Salome_file_i::updateFile().

_ctr

int fileTransfer_i::_ctr

protectedinherited

Referenced by fileTransfer_i::open(), and fileTransfer_i::openW().

_default_source_Salome_file

Engines::Salome_file_var Salome_file_i::_default_source_Salome_file

protected

Referenced by connect(), Salome_file_i(), and setDistributedFile().

_fileAccess

_t_fileAccess Salome_file_i::_fileAccess

protected

Referenced by close(), getBlock(), and open().

_fileDistributedSource

_t_fileDistributedSource Salome_file_i::_fileDistributedSource

protected

Referenced by connect(), connectDistributedFile(), getDistributedFile(), Parallel_Salome_file_i::getParallelDistributedFile(), Parallel_Salome_file_i::recvFiles_node(), setDistributedFile(), and Parallel_Salome_file_i::setFileNode().

_fileId

int Salome_file_i::_fileId

protected

Referenced by open(), and Salome_file_i().

_fileKey

int fileTransfer_i::_fileKey

protectedinherited

Referenced by fileTransfer_i::fileTransfer_i(), fileTransfer_i::open(), and fileTransfer_i::openW().

_fileManaged

_t_fileManaged Salome_file_i::_fileManaged

protected

Referenced by checkLocalFile(), connect(), Parallel_Salome_file_i::connect(), connectDistributedFile(), Parallel_Salome_file_i::connectDistributedFile(), getDistributedFile(), getFileInfos(), Parallel_Salome_file_i::getFileNode(), getFilesInfos(), Parallel_Salome_file_i::getParallelDistributedFile(), load(), open(), recvFiles(), Parallel_Salome_file_i::recvFiles_node(), save(), save_all(), setContainer(), Parallel_Salome_file_i::setContainer(), setDistributedFile(), setDistributedSourceFile(), Parallel_Salome_file_i::setDistributedSourceFile(), Parallel_Salome_file_i::setFileNode(), setLocalFile(), and Parallel_Salome_file_i::updateFile().

_path_max

long Salome_file_i::_path_max

protected

Referenced by load(), Salome_file_i(), setDistributedFile(), and setLocalFile().

_state

Engines::SfState Salome_file_i::_state

protected

Referenced by getSalome_fileState(), load(), recvFiles(), Parallel_Salome_file_i::recvFiles(), Salome_file_i(), save(), save_all(), setDistributedFile(), and setLocalFile().

myPOA

PortableServer::POA_var SALOME::GenericObj_i::myPOA

protectedinherited

Referenced by SALOME::GenericObj_i::_default_POA(), SALOMEDS_ChildIterator_i::_default_POA(), SALOMEDS_GenericAttribute_i::_default_POA(), SALOMEDS_SComponentIterator_i::_default_POA(), SALOMEDS_SObject_i::_default_POA(), SALOMEDS_UseCaseBuilder_i::_default_POA(), SALOMEDS_UseCaseIterator_i::_default_POA(), SALOME::GenericObj_i::GenericObj_i(), and SALOME::GenericObj_i::UnRegister().

myRefCounter

int SALOME::GenericObj_i::myRefCounter

protectedinherited

Referenced by SALOME::GenericObj_i::Register(), and SALOME::GenericObj_i::UnRegister().