SALOME_FileTransferCORBA Class Reference

A class to manage file transfer in SALOME (CORBA context) More...

#include <SALOME_FileTransferCORBA.hxx>

Public Member Functions
	SALOME_FileTransferCORBA ()
	Default constructor, not for use. More...
	SALOME_FileTransferCORBA (Engines::fileRef_ptr aFileRef)
	Constructor to use when we get a fileRef CORBA object from a component. More...
	SALOME_FileTransferCORBA (std::string refMachine, std::string origFileName, std::string containerName="")
	Constructor to use when we have the file name and machine from which to copy, plus an optional Container name on the machine. More...
virtual	~SALOME_FileTransferCORBA ()
	Destructor. More...
std::string	getLocalFile (std::string localFile="")
	Get a local copy of the reference file. More...

Protected Attributes
Engines::fileRef_var	_theFileRef
std::string	_refMachine
std::string	_origFileName
std::string	_containerName

Detailed Description

A class to manage file transfer in SALOME (CORBA context)

Constructor & Destructor Documentation

SALOME_FileTransferCORBA() [1/3]

SALOME_FileTransferCORBA::SALOME_FileTransferCORBA

(

)

Default constructor, not for use.

References ASSERT.

SALOME_FileTransferCORBA() [2/3]

SALOME_FileTransferCORBA::SALOME_FileTransferCORBA

(

Engines::fileRef_ptr

aFileRef

)

Constructor to use when we get a fileRef CORBA object from a component.

Parameters

aFileRef

file reference CORBA object

References _theFileRef, and MESSAGE.

SALOME_FileTransferCORBA() [3/3]

SALOME_FileTransferCORBA::SALOME_FileTransferCORBA	(	std::string	refMachine,
		std::string	origFileName,
		std::string	containerName = ""
	)

Constructor to use when we have the file name and machine from which to copy, plus an optional Container name on the machine.

Parameters

refMachine	the machine on which is the file to transfer
origFileName	absolute file path on refMachine
containerName	default container name used (FactoryServer) if empty

References _containerName, _origFileName, _refMachine, SALOME_ContainerPy::containerName, INFOS, and MESSAGE.

~SALOME_FileTransferCORBA()

SALOME_FileTransferCORBA::~SALOME_FileTransferCORBA ( )

virtual

Destructor.

References MESSAGE.

Member Function Documentation

getLocalFile()

std::string SALOME_FileTransferCORBA::getLocalFile

(

std::string

localFile = ""

)

Get a local copy of the reference file.

CORBA method

Parameters

localFile

optional absolute path to store the copy

Returns

the file name (absolute path) of the copy, may be different from localFile parameter if the copy was already done before the call

References _containerName, _origFileName, _refMachine, _theFileRef, ASSERT, TestComponentPy::container, Engines::ContainerParameters::container_name, SALOME_LifeCycleCORBA::getContainerManager(), Kernel_Utils::GetHostname(), SALOME_LifeCycleCORBA::getResourcesManager(), Engines::ResourceParameters::hostname, INFOS, MESSAGE, Engines::ContainerParameters::mode, SALOME_LifeCycleCORBA::preSet(), Engines::ContainerParameters::resource_params, and SCRUTE.

Referenced by SALOME_LifeCycleCORBA::copyFile(), main(), LifeCycleCORBATest::testgetLocalFile_localComputer(), and LifeCycleCORBATest::testgetLocalFile_remoteComputer().

Field Documentation

_containerName

std::string SALOME_FileTransferCORBA::_containerName

protected

Referenced by SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::_get_name(), SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::create_component_instance(), SALOME_Container.SALOME_Container_i::create_component_instance(), getLocalFile(), SALOME_FileTransferCORBA(), and SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::Shutdown().

_origFileName

std::string SALOME_FileTransferCORBA::_origFileName

protected

Referenced by getLocalFile(), and SALOME_FileTransferCORBA().

_refMachine

std::string SALOME_FileTransferCORBA::_refMachine

protected

Referenced by getLocalFile(), and SALOME_FileTransferCORBA().

_theFileRef

Engines::fileRef_var SALOME_FileTransferCORBA::_theFileRef

protected

Referenced by getLocalFile(), and SALOME_FileTransferCORBA().