#include <SALOME_TestComponent_i.hxx>

Inheritance diagram for Engines_TestComponent_i:

Public Member Functions
	Engines_TestComponent_i ()

	Engines_TestComponent_i (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa, PortableServer::ObjectId contId, const char instanceName, const char *interfaceName)

virtual	~Engines_TestComponent_i ()

char *	Coucou (CORBA::Long L)

void	Setenv ()

char *	instanceName ()
	CORBA method: return name of the instance, unique in this Container. More...

char *	interfaceName ()
	CORBA method: return name of the component class. More...

void	ping ()
	CORBA method: Test if instance is alive and responds. More...

void	destroy ()
	CORBA method: Deactivate this instance. More...

CORBA::Long	getStudyId ()
	CORBA method: Get study Id. More...

Engines::Container_ptr	GetContainerRef ()
	CORBA method: return CORBA reference of the Container. More...

void	setProperties (const Engines::FieldsDict &dico)
	CORBA method: Gives a sequence of (key=string,value=any) to the component. More...

Engines::FieldsDict *	getProperties ()
	CORBA method: returns a previously stored map (key=string,value=any) as a sequence. More...

virtual void	SetOption (const char , const char )
	CORBA method: This method is to set an option specific to a certain EngineComponent. More...

virtual char *	GetOption (const char *)
	CORBA method: This method is to get value of an option specific to a certain EngineComponent. More...

void	Names (const char graphName, const char nodeName)
	CORBA method: used by Supervision to give names to this instance. More...

bool	Kill_impl ()
	CORBA method: used in Supervision. More...

bool	Stop_impl ()
	CORBA method: used in Supervision. More...

bool	Suspend_impl ()
	CORBA method: used in Supervision. More...

bool	Resume_impl ()
	CORBA method: used in Supervision. More...

CORBA::Long	CpuUsed_impl ()
	CORBA method: More...

virtual Engines::TMPFile *	DumpPython (CORBA::Object_ptr theStudy, CORBA::Boolean isPublished, CORBA::Boolean isMultiFile, CORBA::Boolean &isValidScript)
	C++ method: DumpPython default implementation. More...

virtual Engines::Salome_file_ptr	getInputFileToService (const char service_name, const char Salome_file_name)

virtual Engines::Salome_file_ptr	getOutputFileToService (const char service_name, const char Salome_file_name)

virtual void	checkInputFilesToService (const char *service_name)

virtual Engines::Salome_file_ptr	setInputFileToService (const char service_name, const char Salome_file_name)

virtual void	checkOutputFilesToService (const char *service_name)

virtual Engines::Salome_file_ptr	setOutputFileToService (const char service_name, const char Salome_file_name)

virtual bool	hasObjectInfo ()

virtual char *	getObjectInfo (CORBA::Long studyId, const char *entry)

virtual char *	getVersion ()
	Get version of the component. More...

PortableServer::ObjectId *	getId ()
	C++ method: return CORBA instance id, the id is set in derived class constructor, when instance is activated. More...

Engines_Container_i *	GetContainerPtr ()
	C++ method: return Container Servant. More...

std::string	getContainerName ()
	C++ method: return the name of the container associated with this component This name does not contains the "/Containers" string and all "/" are replaced by "_". More...

void	setContainerName ()
	C++ method: set the name of the container associated with this component (attribute containerName) This name does not contains the "/Containers" string and all "/" are replaced by "</em>". More...

virtual bool	setStudyId (CORBA::Long studyId)
	C++ method: set study Id. More...

void	beginService (const char *serviceName)
	C++ method: used by derived classes for supervision. More...

void	endService (const char *serviceName)
	C++ method: used by derived classes for supervision. More...

void	sendMessage (const char event_type, const char message)
	C++ method: Send message to event channel. More...

char *	graphName ()
	C++ method: – CHECK IF USED –. More...

char *	nodeName ()
	C++ method: – CHECK IF USED –. More...

bool	Killer (pthread_t ThreadId, int signum)
	C++ method: used in Supervision (see kill_impl) More...

void	SetCurCpu ()
	C++ method: More...

long	CpuUsed ()
	C++ method: More...

void	CancelThread ()
	C++ method: More...

virtual void	configureSalome_file (std::string service_name, std::string file_port_name, Salome_file_i *file)
	C++ method: used to configure the Salome_file into the runtime. More...

Static Public Member Functions
static bool	isMultiStudy ()

static bool	isMultiInstance ()

static std::string	GetDynLibraryName (const char *componentName)
	C++ method: return standard library name built on component name. More...

Protected Types
typedef std::map< std::string, Salome_file_i * >	_t_Salome_file_map

typedef std::map< std::string, Engines_Component_i::_t_Salome_file_map * >	_t_Service_file_map

Protected Attributes
int	_studyId

std::string	_instanceName

std::string	_interfaceName

std::string	_containerName

CORBA::ORB_var	_orb

PortableServer::POA_var	_poa

PortableServer::ObjectId *	_id

PortableServer::ObjectId *	_contId

Engines::Container_var	_container

Engines_Component_i *	_thisObj

RegistryConnexion *	_myConnexionToRegistry

NOTIFICATION_Supplier *	_notifSupplier

std::map< std::string, CORBA::Any >	_fieldsDict

_t_Service_file_map	_Input_Service_file_map

_t_Service_file_map	_Output_Service_file_map

_t_Service_file_map::iterator	_Service_file_map_it

_t_Salome_file_map::iterator	_Salome_file_map_it

std::string	_serviceName

std::string	_graphName

std::string	_nodeName

Static Protected Attributes
static bool	_isMultiStudy = true

static bool	_isMultiInstance = false

Member Typedef Documentation

typedef std::map<std::string, Salome_file_i*> Engines_Component_i::_t_Salome_file_map

protectedinherited

typedef std::map<std::string, Engines_Component_i::_t_Salome_file_map*> Engines_Component_i::_t_Service_file_map

protectedinherited

Constructor & Destructor Documentation

Engines_TestComponent_i::Engines_TestComponent_i ( )

Engines_TestComponent_i::Engines_TestComponent_i	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_ptr	poa,
		PortableServer::ObjectId *	contId,
		const char *	instanceName,
		const char *	interfaceName
	)

References Engines_Component_i::_id, Engines_Component_i::_poa, Engines_Component_i::_thisObj, and MESSAGE.

Engines_TestComponent_i::~Engines_TestComponent_i ( )

virtual

References MESSAGE.

Member Function Documentation

void Engines_Component_i::beginService ( const char * serviceName )

inherited

C++ method: used by derived classes for supervision.

References Engines_Component_i::_Executed, Engines_Component_i::_fieldsDict, Engines_Component_i::_instanceName, Engines_Component_i::_serviceName, Engines_Component_i::_StartUsed, Engines_Component_i::_ThreadCpuUsed, Engines_Component_i::_ThreadId, Engines_Component_i::CpuUsed_impl(), and MESSAGE.

Referenced by Superv_Component_i::beginService().

void Engines_Component_i::CancelThread ( )

inherited

C++ method:

References Engines_Component_i::_CanceledThread.

Referenced by CallCancelThread().

void Engines_Component_i::checkInputFilesToService ( const char * service_name )

virtualinherited

References Engines_Component_i::_Input_Service_file_map, Engines_Component_i::_Service_file_map_it, Engines_Component_i::configureSalome_file(), and Salome_file_i::recvFiles().

void Engines_Component_i::checkOutputFilesToService ( const char * service_name )

virtualinherited

References Engines_Component_i::_Output_Service_file_map, Engines_Component_i::_Service_file_map_it, Engines_Component_i::configureSalome_file(), and Salome_file_i::recvFiles().

void Engines_Component_i::configureSalome_file	(	std::string	service_name,
		std::string	file_port_name,
		Salome_file_i *	file
	)

virtualinherited

C++ method: used to configure the Salome_file into the runtime.

Parameters

service_name	name of the service that use this Salome_file
file_port_name	name of the Salome_file
file	Salome_file C++ object

Referenced by Engines_Component_i::checkInputFilesToService(), and Engines_Component_i::checkOutputFilesToService().

char * Engines_TestComponent_i::Coucou ( CORBA::Long L )

long Engines_Component_i::CpuUsed ( )

inherited

C++ method:

References Engines_Component_i::_Executed, Engines_Component_i::_StartUsed, and Engines_Component_i::_ThreadId.

Referenced by Engines_Component_i::CpuUsed_impl(), and Engines_Component_i::SetCurCpu().

CORBA::Long Engines_Component_i::CpuUsed_impl ( )

inherited

CORBA method:

References Engines_Component_i::_Executed, _Sleeping, Engines_Component_i::_ThreadCpuUsed, Engines_Component_i::_ThreadId, Engines_Component_i::CpuUsed(), and Engines_Component_i::Killer().

Referenced by Engines_Component_i::beginService(), and Engines_Component_i::endService().

void Engines_Component_i::destroy ( )

inherited

CORBA method: Deactivate this instance.

CORBA object is deactivated (do not respond any more to CORBA calls), the connection to Regsitry is removed (Registry informed of deactivation), internal server reference counter on the derived servant class is decremented, to allow destruction of the class (delete) by POA, when there are no more references. – TO BE USED BY CONTAINER ONLY (Container housekeeping) –

References Engines_Component_i::_id, Engines_Component_i::_poa, and MESSAGE.

Engines::TMPFile * Engines_Component_i::DumpPython	(	CORBA::Object_ptr	theStudy,
		CORBA::Boolean	isPublished,
		CORBA::Boolean	isMultiFile,
		CORBA::Boolean &	isValidScript
	)

virtualinherited

C++ method: DumpPython default implementation.

void Engines_Component_i::endService ( const char * serviceName )

inherited

C++ method: used by derived classes for supervision.

References Engines_Component_i::_CanceledThread, Engines_Component_i::_instanceName, Engines_Component_i::_StartUsed, Engines_Component_i::_ThreadCpuUsed, Engines_Component_i::_ThreadId, Engines_Component_i::CpuUsed_impl(), and MESSAGE.

std::string Engines_Component_i::getContainerName ( )

inherited

C++ method: return the name of the container associated with this component This name does not contains the "/Containers" string and all "/" are replaced by "_".

Returns: the container name (reformatted)

References Engines_Component_i::_containerName.

Referenced by create_calcium_port(), CalciumInterface::ecp_cd(), CalciumInterface::ecp_ecriture(), CalciumInterface::ecp_effi(), CalciumInterface::ecp_efft(), CalciumInterface::ecp_fin(), CalciumInterface::ecp_fini(), CalciumInterface::ecp_fint(), and CalciumInterface::ecp_lecture().

Engines_Container_i * Engines_Component_i::GetContainerPtr ( )

inherited

C++ method: return Container Servant.

References Engines_Component_i::_container, and Engines_Component_i::_poa.

Engines::Container_ptr Engines_Component_i::GetContainerRef ( )

inherited

CORBA method: return CORBA reference of the Container.

References Engines_Component_i::_container.

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

std::string Engines_Component_i::GetDynLibraryName ( const char * componentName )

staticinherited

C++ method: return standard library name built on component name.

Referenced by Engines_Container_i::decInstanceCnt(), and Engines_Parallel_Container_i::decInstanceCnt().

PortableServer::ObjectId * Engines_Component_i::getId ( )

inherited

C++ method: return CORBA instance id, the id is set in derived class constructor, when instance is activated.

References Engines_Component_i::_id.

Referenced by SalomeTestComponentEngine_factory(), and TestMPIComponentEngine_factory().

Engines::Salome_file_ptr Engines_Component_i::getInputFileToService	(	const char *	service_name,
		const char *	Salome_file_name
	)

virtualinherited

References Engines_Component_i::_Input_Service_file_map, Engines_Component_i::_Salome_file_map_it, Engines_Component_i::_Service_file_map_it, SALOME::INTERNAL_ERROR, SALOME::ExceptionStruct::text, and SALOME::ExceptionStruct::type.

virtual char* Engines_Component_i::getObjectInfo	(	CORBA::Long	studyId,
		const char *	entry
	)

virtualinherited

char * Engines_Component_i::GetOption ( const char * )

virtualinherited

CORBA method: This method is to get value of an option specific to a certain EngineComponent.

Engines::Salome_file_ptr Engines_Component_i::getOutputFileToService	(	const char *	service_name,
		const char *	Salome_file_name
	)

virtualinherited

References Engines_Component_i::_Output_Service_file_map, Engines_Component_i::_Salome_file_map_it, Engines_Component_i::_Service_file_map_it, SALOME::INTERNAL_ERROR, SALOME::ExceptionStruct::text, and SALOME::ExceptionStruct::type.

Engines::FieldsDict * Engines_Component_i::getProperties ( )

inherited

CORBA method: returns a previously stored map (key=string,value=any) as a sequence.

(see setProperties)

References Engines_Component_i::_fieldsDict.

CORBA::Long Engines_Component_i::getStudyId ( )

inherited

CORBA method: Get study Id.

Returns: -1: not initialised (Internal Error) 0: multistudy component instance >0: study id associated to this instance

References Engines_Component_i::_studyId.

Referenced by Engines_Container_i::find_or_create_instance(), and Engines_Parallel_Container_i::find_or_create_instance().

char * Engines_Component_i::getVersion ( )

virtualinherited

Get version of the component.

This method is supposed to be implemented in all derived classes; default implementation returns empty string that means that no version information about the component is available.

Note: The version of the component is stored to the study, as a part of general persistence mechanism; once stored, version information in the study cannot be changed.

Returns: string containing component's version, e.g. "1.0"

char * Engines_Component_i::graphName ( )

inherited

C++ method: – CHECK IF USED –.

References Engines_Component_i::_graphName.

Referenced by Engines_Component_i::Names().

virtual bool Engines_Component_i::hasObjectInfo ( )

virtualinherited

char * Engines_Component_i::instanceName ( )

inherited

CORBA method: return name of the instance, unique in this Container.

References Engines_Component_i::_instanceName.

Referenced by create_calcium_port(), CalciumInterface::ecp_cd(), CalciumInterface::ecp_ecriture(), CalciumInterface::ecp_effi(), CalciumInterface::ecp_efft(), CalciumInterface::ecp_fin(), CalciumInterface::ecp_fini(), CalciumInterface::ecp_fint(), and CalciumInterface::ecp_lecture().

char * Engines_Component_i::interfaceName ( )

inherited

CORBA method: return name of the component class.

References Engines_Component_i::_interfaceName.

static bool Engines_Component_i::isMultiInstance ( )

staticinherited

static bool Engines_Component_i::isMultiStudy ( )

staticinherited

bool Engines_Component_i::Kill_impl ( )

inherited

CORBA method: used in Supervision.

References Engines_Component_i::_ThreadId, and Engines_Component_i::Killer().

bool Engines_Component_i::Killer	(	pthread_t	ThreadId,
		int	signum
	)

inherited

C++ method: used in Supervision (see kill_impl)

References MESSAGE.

Referenced by Engines_Component_i::CpuUsed_impl(), Engines_Component_i::Kill_impl(), Engines_Component_i::Stop_impl(), and Engines_Component_i::Suspend_impl().

void Engines_Component_i::Names	(	const char *	graphName,
		const char *	nodeName
	)

inherited

CORBA method: used by Supervision to give names to this instance.

References Engines_Component_i::_graphName, Engines_Component_i::_nodeName, Engines_Component_i::graphName(), and Engines_Component_i::nodeName().

char * Engines_Component_i::nodeName ( )

inherited

C++ method: – CHECK IF USED –.

References Engines_Component_i::_nodeName.

Referenced by Engines_Component_i::Names().

void Engines_Component_i::ping ( )

inherited

CORBA method: Test if instance is alive and responds.

References MESSAGE.

bool Engines_Component_i::Resume_impl ( )

inherited

CORBA method: used in Supervision.

References Engines_Component_i::_id, Engines_Component_i::_instanceName, Engines_Component_i::_interfaceName, _Sleeping, Engines_Component_i::_ThreadId, Kernel_Utils::GetHostname(), and MESSAGE.

void Engines_Component_i::sendMessage	(	const char *	event_type,
		const char *	message
	)

inherited

C++ method: Send message to event channel.

References Engines_Component_i::_graphName, Engines_Component_i::_nodeName, Engines_Component_i::_notifSupplier, and NOTIFICATION_Supplier::Send().

void Engines_Component_i::setContainerName ( )

inherited

C++ method: set the name of the container associated with this component (attribute containerName) This name does not contains the "/Containers" string and all "/" are replaced by "</em>".

Returns: the container name (reformatted)

References Engines_Component_i::_container, and Engines_Component_i::_containerName.

Referenced by Engines_Component_i::Engines_Component_i().

void Engines_Component_i::SetCurCpu ( )

inherited

C++ method:

References Engines_Component_i::_ThreadCpuUsed, and Engines_Component_i::CpuUsed().

Referenced by SetCpuUsed().

void Engines_TestComponent_i::Setenv ( )

References Engines_Component_i::_fieldsDict, and MESSAGE.

Engines::Salome_file_ptr Engines_Component_i::setInputFileToService	(	const char *	service_name,
		const char *	Salome_file_name
	)

virtualinherited

References Engines_Component_i::_Input_Service_file_map, Engines_Component_i::_Salome_file_map_it, Engines_Component_i::_Service_file_map_it, Engines_Component_i::GetContainerRef(), and Salome_file_i::setContainer().

void Engines_Component_i::SetOption	(	const char *	,
		const char *
	)

virtualinherited

CORBA method: This method is to set an option specific to a certain EngineComponent.

Engines::Salome_file_ptr Engines_Component_i::setOutputFileToService	(	const char *	service_name,
		const char *	Salome_file_name
	)

virtualinherited

References Engines_Component_i::_Output_Service_file_map, Engines_Component_i::_Salome_file_map_it, Engines_Component_i::_Service_file_map_it, Engines_Component_i::GetContainerRef(), and Salome_file_i::setContainer().

void Engines_Component_i::setProperties ( const Engines::FieldsDict & dico )

inherited

CORBA method: Gives a sequence of (key=string,value=any) to the component.

Base class component stores the sequence in a map. The map is cleared before. This map is for use by derived classes.

Parameters

dico	sequence of (key=string,value=any)

References Engines_Component_i::_fieldsDict.

CORBA::Boolean Engines_Component_i::setStudyId ( CORBA::Long studyId )

virtualinherited

C++ method: set study Id.

Parameters

studyId 0 if instance is not associated to a study, >0 otherwise (== study id)

Returns: true if the set of study Id is OK must be set once by Container, at instance creation, and cannot be changed after.

References Engines_Component_i::_studyId, and ASSERT.

Referenced by Engines_Parallel_Container_i::createCPPInstance(), Engines_Container_i::createInstance(), and Engines_MPIContainer_i::createMPIInstance().

bool Engines_Component_i::Stop_impl ( )

inherited

CORBA method: used in Supervision.

References Engines_Component_i::_id, Engines_Component_i::_instanceName, Engines_Component_i::_interfaceName, Engines_Component_i::_ThreadId, Kernel_Utils::GetHostname(), Engines_Component_i::Killer(), and MESSAGE.

bool Engines_Component_i::Suspend_impl ( )

inherited

CORBA method: used in Supervision.

References Engines_Component_i::_id, Engines_Component_i::_instanceName, Engines_Component_i::_interfaceName, _Sleeping, Engines_Component_i::_ThreadId, Kernel_Utils::GetHostname(), Engines_Component_i::Killer(), and MESSAGE.

Field Documentation

Engines::Container_var Engines_Component_i::_container

protectedinherited

Referenced by Engines_Component_i::Engines_Component_i(), Engines_Component_i::GetContainerPtr(), Engines_Component_i::GetContainerRef(), and Engines_Component_i::setContainerName().

std::string Engines_Component_i::_containerName

protectedinherited

Referenced by Engines_Component_i::getContainerName(), and Engines_Component_i::setContainerName().

PortableServer::ObjectId* Engines_Component_i::_contId

protectedinherited

Referenced by Engines_Component_i::Engines_Component_i().

std::map<std::string,CORBA::Any> Engines_Component_i::_fieldsDict

protectedinherited

Referenced by Engines_Component_i::beginService(), Engines_Component_i::getProperties(), Setenv(), and Engines_Component_i::setProperties().

std::string Engines_Component_i::_graphName

protectedinherited

Referenced by Engines_Component_i::graphName(), Engines_Component_i::Names(), and Engines_Component_i::sendMessage().

PortableServer::ObjectId* Engines_Component_i::_id

protectedinherited

Referenced by Engines_Component_i::destroy(), Engines_TestComponent_i(), Engines_Component_i::getId(), Engines_Component_i::Resume_impl(), Engines_Component_i::Stop_impl(), Engines_Component_i::Suspend_impl(), TestMPIComponentEngine::TestMPIComponentEngine(), and Engines_Component_i::~Engines_Component_i().

_t_Service_file_map Engines_Component_i::_Input_Service_file_map

protectedinherited

Referenced by Engines_Component_i::checkInputFilesToService(), Engines_Component_i::getInputFileToService(), and Engines_Component_i::setInputFileToService().

std::string Engines_Component_i::_instanceName

protectedinherited

Referenced by Engines_Component_i::beginService(), Engines_Component_i::endService(), Engines_Component_i::Engines_Component_i(), Engines_Component_i::instanceName(), Engines_Component_i::Resume_impl(), Engines_Component_i::Stop_impl(), and Engines_Component_i::Suspend_impl().

std::string Engines_Component_i::_interfaceName

protectedinherited

Referenced by Engines_Component_i::interfaceName(), Engines_Component_i::Resume_impl(), Engines_Component_i::Stop_impl(), Engines_Component_i::Suspend_impl(), and Engines_Component_i::~Engines_Component_i().

bool Engines_Component_i::_isMultiInstance = false

staticprotectedinherited

bool Engines_Component_i::_isMultiStudy = true

staticprotectedinherited

RegistryConnexion* Engines_Component_i::_myConnexionToRegistry

protectedinherited

Referenced by Engines_Component_i::Engines_Component_i(), and Engines_Component_i::~Engines_Component_i().

std::string Engines_Component_i::_nodeName

protectedinherited

Referenced by Engines_Component_i::Names(), Engines_Component_i::nodeName(), and Engines_Component_i::sendMessage().

NOTIFICATION_Supplier* Engines_Component_i::_notifSupplier

protectedinherited

Referenced by Engines_Component_i::Engines_Component_i(), Engines_Component_i::sendMessage(), and Engines_Component_i::~Engines_Component_i().

CORBA::ORB_var Engines_Component_i::_orb

protectedinherited

Referenced by Engines_Component_i::Engines_Component_i().

_t_Service_file_map Engines_Component_i::_Output_Service_file_map

protectedinherited

Referenced by Engines_Component_i::checkOutputFilesToService(), Engines_Component_i::getOutputFileToService(), and Engines_Component_i::setOutputFileToService().

PortableServer::POA_var Engines_Component_i::_poa

protectedinherited

Referenced by Engines_Component_i::destroy(), Engines_Component_i::Engines_Component_i(), Engines_TestComponent_i(), Engines_Component_i::GetContainerPtr(), and TestMPIComponentEngine::TestMPIComponentEngine().

_t_Salome_file_map::iterator Engines_Component_i::_Salome_file_map_it

protectedinherited

Referenced by Engines_Component_i::getInputFileToService(), Engines_Component_i::getOutputFileToService(), Engines_Component_i::setInputFileToService(), and Engines_Component_i::setOutputFileToService().

_t_Service_file_map::iterator Engines_Component_i::_Service_file_map_it

protectedinherited

Referenced by Engines_Component_i::checkInputFilesToService(), Engines_Component_i::checkOutputFilesToService(), Engines_Component_i::getInputFileToService(), Engines_Component_i::getOutputFileToService(), Engines_Component_i::setInputFileToService(), and Engines_Component_i::setOutputFileToService().

std::string Engines_Component_i::_serviceName

protectedinherited

Referenced by Engines_Component_i::beginService().

int Engines_Component_i::_studyId

protectedinherited

Referenced by Engines_Component_i::getStudyId(), and Engines_Component_i::setStudyId().

Engines_Component_i* Engines_Component_i::_thisObj

protectedinherited

Referenced by Engines_TestComponent_i(), and TestMPIComponentEngine::TestMPIComponentEngine().

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation