Version: 9.12.0
Engines_TestComponent_i Class Reference

#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 ()
 
CORBA::Boolean isSSLMode () override
 
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...
 
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::FieldsDictgetProperties ()
 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::TMPFileDumpPython (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 ()
 Return true if component can provide creation information. More...
 
virtual char * getObjectInfo (const char *entry)
 Get creation information for object addressed by given entry. More...
 
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_iGetContainerPtr ()
 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...
 
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 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 Member Functions

SALOME_NamingService_AbstractgetNS ()
 

Protected Attributes

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 _isMultiInstance = false
 

Private Attributes

pthread_t _ThreadId
 
long _StartUsed
 
long _ThreadCpuUsed
 
bool _Executed
 
bool _CanceledThread
 

Member Typedef Documentation

◆ _t_Salome_file_map

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

◆ _t_Service_file_map

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() [1/2]

Engines_TestComponent_i::Engines_TestComponent_i ( )

◆ Engines_TestComponent_i() [2/2]

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

◆ ~Engines_TestComponent_i()

Engines_TestComponent_i::~Engines_TestComponent_i ( )
virtual

References MESSAGE.

Member Function Documentation

◆ beginService()

◆ CancelThread()

void Engines_Component_i::CancelThread ( )
inherited

C++ method:

References Engines_Component_i::_CanceledThread.

Referenced by CallCancelThread().

◆ checkInputFilesToService()

void Engines_Component_i::checkInputFilesToService ( const char *  service_name)
virtualinherited

◆ checkOutputFilesToService()

void Engines_Component_i::checkOutputFilesToService ( const char *  service_name)
virtualinherited

◆ configureSalome_file()

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_namename of the service that use this Salome_file
file_port_namename of the Salome_file
fileSalome_file C++ object

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

◆ Coucou()

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

◆ CpuUsed()

◆ CpuUsed_impl()

◆ destroy()

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.

◆ DumpPython()

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

C++ method: DumpPython default implementation.

◆ endService()

void Engines_Component_i::endService ( const char *  serviceName)
inherited

◆ getContainerName()

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().

◆ GetContainerPtr()

Engines_Container_i * Engines_Component_i::GetContainerPtr ( )
inherited

C++ method: return Container Servant.

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

◆ GetContainerRef()

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().

◆ GetDynLibraryName()

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

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

References waitContainers::cname, and TestKernelHelpers::ret.

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

◆ getId()

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().

◆ getInputFileToService()

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

◆ getNS()

◆ getObjectInfo()

char * Engines_Component_i::getObjectInfo ( const char *  entry)
virtualinherited

Get creation information for object addressed by given entry.

◆ GetOption()

char * Engines_Component_i::GetOption ( const char *  )
virtualinherited

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

◆ getOutputFileToService()

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

◆ getProperties()

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.

◆ getVersion()

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"

Referenced by SALOME_DriverPy.SALOME_DriverPy_i::Version().

◆ graphName()

char * Engines_Component_i::graphName ( )
inherited

◆ hasObjectInfo()

bool Engines_Component_i::hasObjectInfo ( )
virtualinherited

Return true if component can provide creation information.

◆ instanceName()

◆ interfaceName()

char * Engines_Component_i::interfaceName ( )
inherited

CORBA method: return name of the component class.

References Engines_Component_i::_interfaceName.

◆ isMultiInstance()

static bool Engines_Component_i::isMultiInstance ( )
staticinherited

◆ isSSLMode()

◆ Kill_impl()

bool Engines_Component_i::Kill_impl ( )
inherited

CORBA method: used in Supervision.

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

◆ Killer()

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

◆ Names()

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().

◆ nodeName()

◆ ping()

void Engines_Component_i::ping ( )
inherited

CORBA method: Test if instance is alive and responds.

References MESSAGE.

◆ Resume_impl()

◆ sendMessage()

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

◆ setContainerName()

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, Engines_Component_i::_containerName, SALOME_ContainerPy::containerName, and pythfilter::name.

Referenced by Engines_Component_i::Engines_Component_i().

◆ SetCurCpu()

void Engines_Component_i::SetCurCpu ( )
inherited

◆ Setenv()

void Engines_TestComponent_i::Setenv ( )

◆ setInputFileToService()

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

◆ SetOption()

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

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

◆ setOutputFileToService()

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

◆ setProperties()

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
dicosequence of (key=string,value=any)

References Engines_Component_i::_fieldsDict.

◆ Stop_impl()

◆ Suspend_impl()

Field Documentation

◆ _CanceledThread

bool Engines_Component_i::_CanceledThread
privateinherited

◆ _container

◆ _containerName

◆ _contId

◆ _Executed

◆ _fieldsDict

◆ _graphName

◆ _id

◆ _Input_Service_file_map

◆ _instanceName

◆ _interfaceName

◆ _isMultiInstance

bool Engines_Component_i::_isMultiInstance = false
staticprotectedinherited

◆ _myConnexionToRegistry

RegistryConnexion* Engines_Component_i::_myConnexionToRegistry
protectedinherited

◆ _nodeName

◆ _notifSupplier

◆ _orb

◆ _Output_Service_file_map

◆ _poa

◆ _Salome_file_map_it

◆ _Service_file_map_it

◆ _serviceName

◆ _StartUsed

◆ _thisObj

Engines_Component_i* Engines_Component_i::_thisObj
protectedinherited

◆ _ThreadCpuUsed

◆ _ThreadId