Back to index

salome-kernel  6.5.0
Public Member Functions
Engines::Parallel_Salome_file Interface Reference

Interface of a Parallel_Salome_file This interface is used by parallel components and containers. More...

import "SALOME_PACOExtension.idl";

Inheritance diagram for Engines::Parallel_Salome_file:
Inheritance graph
[legend]
Collaboration diagram for Engines::Parallel_Salome_file:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void setFileNode (in string file_name, in long node_nbr) raises (SALOME::SALOME_Exception)
 Set a number of node for the file.
long getFileNode (in string file_name) raises (SALOME::SALOME_Exception)
 Get the number of the node that actually managed the file.
Engines::Container updateFile (in Engines::file new_file)
 This method update the state of file for the Parallel_Salome_file.
void recvFiles_node () raises (SALOME::SALOME_Exception)
 This method is used by the parallel implementation of recvFiles.
void load (in string hdf5_file) raises (SALOME::SALOME_Exception)
 Load a Salome_file from a hdf5 file.
void save (in string hdf5_file) raises (SALOME::SALOME_Exception)
 Save a Salome_file into a hdf5_file.
void save_all (in string hdf5_file) raises (SALOME::SALOME_Exception)
 Save a Salome_file into a hdf5_file.
void setLocalFile (in string comp_file_name) raises (SALOME::SALOME_Exception)
 Add a Local file to the Salome_file.
void setDistributedFile (in string comp_file_name) raises (SALOME::SALOME_Exception)
 Add a Distributed file to the Salome_file.
void connect (in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception)
 Connect a Salome_file with another Salome_file.
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.
void setDistributedSourceFile (in string file_name, in string source_file_name) raises (SALOME::SALOME_Exception)
 Connect the file_name with a Distributed file_name.
void recvFiles () raises (SALOME::SALOME_Exception)
 Get all the distributed files managed by the Salome_file and check all the local files.
void removeFile (in string file_name) raises (SALOME::SALOME_Exception)
 Remove a file of the Salome_file.
void removeFiles ()
 Remove all the files of the Salome_file.
Engines::files getFilesInfos ()
 Get the list of the files managed by the Salome_file.
Engines::file getFileInfos (in string file_name) raises (SALOME::SALOME_Exception)
 Get a file managed by the Salome_file.
Engines::SfState getSalome_fileState ()
 Return the state of the Salome_file.
void setContainer (in Engines::Container container)
 Set the container where files are.
long open (in string fileName)
 Open the file transfer.
long openW (in string fileName)
 Open the file transfer in write mode for file fileName.
void close (in long fileId)
 Close the file transfer.
fileBlock getBlock (in long fileId)
 Get a file data block.
void putBlock (in long fileId, in fileBlock block)
 Put a file data block.
void Register ()
 Increase the reference count (mark as used by another object).
void UnRegister ()
 Decrease the reference count (release by another object).
void Destroy ()
 Obsolete, left for compatibility reasons only.

Detailed Description

Interface of a Parallel_Salome_file This interface is used by parallel components and containers.

It adds methods to enable to choose on which node of the parallel component the file has to be received.

Definition at line 77 of file SALOME_PACOExtension.idl.


Member Function Documentation

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.

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

Connect a Salome_file with another Salome_file.

It works only if the Salome_file managed only one file

Parameters:
source_Salome_fileSalome_file that managed the distributed version of the file.
Exceptions:
raisedif there is more or less than one file.
void Engines::Salome_file::connectDistributedFile ( in string  file_name,
in Engines::Salome_file  source_Salome_file 
) raises (SALOME::SALOME_Exception) [inherited]

Connect the managed file file_name to a Salome_file.

Parameters:
file_namename of the file without the path.
source_Salome_fileSalome_file that managed the distributed version of the file.
Exceptions:
raisedif the file doesn't exist.
void SALOME::GenericObj::Destroy ( ) [inherited]

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

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.

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

Get a file managed by the Salome_file.

Parameters:
file_namethe name of the file.
Returns:
CORBA file reference.
Exceptions:
raisedif the file doesn't exist.

Get the number of the node that actually managed the file.

Parameters:
file_namename of managed file.
Returns:
node number of the file
Exceptions:
raisedif the file doesn't exist.

Get the list of the files managed by the Salome_file.

The list can be empty.

Return the state of the Salome_file.

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

Load a Salome_file from a hdf5 file.

Parameters:
hdf5_filename (with path) of the hdf5_file.
Exceptions:
containsinformations of errors if the loading doesn't succeed.
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.

long Engines::fileTransfer::openW ( in string  fileName) [inherited]

Open the file transfer in write mode for file fileName.

Parameters:
fileNamethe file to copy into with putBlock
Returns:
the id to use with putBlock
void Engines::fileTransfer::putBlock ( in long  fileId,
in fileBlock  block 
) [inherited]

Put a file data block.

Parameters:
fileIdidentification of the file obtained by openW
blocka data block to copy into the file identified by fileId

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

Exceptions:
raisedif some of the files are not ok.

This method is used by the parallel implementation of recvFiles.

Exceptions:
raisedif the file cannot be ok.
void SALOME::GenericObj::Register ( ) [inherited]

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

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

Remove a file of the Salome_file.

Parameters:
file_namename of the file.
Exceptions:
raisedif the file doesn't exist.
void Engines::Salome_file::removeFiles ( ) [inherited]

Remove all the files of the Salome_file.

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

Save a Salome_file into a hdf5_file.

Parameters:
hdf5_filename (with path) of the hdf5_file.
Exceptions:
containsinformations of errors if the save doesn't succeed.
void Engines::Salome_file::save_all ( in string  hdf5_file) raises (SALOME::SALOME_Exception) [inherited]

Save a Salome_file into a hdf5_file.

All files that are managed are saved into the hdf5_file

Parameters:
hdf5_filename (with path) of the hdf5_file.
Exceptions:
containsinformations of errors if the save doesn't succeed.
void Engines::Salome_file::setContainer ( in Engines::Container  container) [inherited]

Set the container where files are.

Parameters:
containercontainer CORBA's reference.
void Engines::Salome_file::setDistributedFile ( in string  comp_file_name) raises (SALOME::SALOME_Exception) [inherited]

Add a Distributed file to the Salome_file.

Parameters:
comp_file_namename of the file with the path.
Exceptions:
raisedif the file is already added into the Salome_file.
void Engines::Salome_file::setDistributedSourceFile ( in string  file_name,
in string  source_file_name 
) raises (SALOME::SALOME_Exception) [inherited]

Connect the file_name with a Distributed file_name.

Parameters:
file_namename of the file without the path.
source_file_nameIt's the name of the file managed by the distributed source Salome_file.
Exceptions:
raisedif the file doesn't exist.
void Engines::Parallel_Salome_file::setFileNode ( in string  file_name,
in long  node_nbr 
) raises (SALOME::SALOME_Exception)

Set a number of node for the file.

Default is the node 0.

 \param file_name name of the file.
 \param node_nbr node number where the file is.

 \exception raised if the file doesn't exist.
void Engines::Salome_file::setLocalFile ( in string  comp_file_name) raises (SALOME::SALOME_Exception) [inherited]

Add a Local file to the Salome_file.

Parameters:
file_namename of the file with the path.
Exceptions:
raisedif the file is already added into the Salome_file.
void SALOME::GenericObj::UnRegister ( ) [inherited]

Decrease the reference count (release by another object).

Here is the caller graph for this function:

This method update the state of file for the Parallel_Salome_file.

Parameters:
new_filethe new state of file.

The documentation for this interface was generated from the following file: