Engines::Salome_file Interface Reference
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.
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
Load a Salome_file from a hdf5 file.
- Parameters:
-
| hdf5_file | name (with path) of the hdf5_file. |
- Exceptions:
-
| contains | informations of errors if the loading doesn't succeed. |
Save a Salome_file into a hdf5_file.
- Parameters:
-
| hdf5_file | name (with path) of the hdf5_file. |
- Exceptions:
-
| contains | informations of errors if the save doesn't succeed. |
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 | informations of errors if the save doesn't succeed. |
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. |
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. |
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. |
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. |
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. |
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. |
Remove a file of the Salome_file.
- Parameters:
-
| file_name | name of the file. |
- Exceptions:
-
| raised | if the file doesn't exist. |
void Engines::Salome_file::removeFiles |
( |
|
) |
|
Get the list of the files managed by the Salome_file.
The list can be empty.
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. |
Set the container where files are.
- Parameters:
-
| container | container CORBA's reference. |
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:
-
| fileName | the file to copy into with putBlock |
- Returns:
- the id to use with putBlock
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.
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.
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 |