Version: 7.8.0
Superv_Component_i Class Reference

This class implements DSC_User component. More...

#include <Superv_Component_i.hxx>

Inheritance diagram for Superv_Component_i:

Data Structures

struct  BadCast
 
struct  BadFabType
 
struct  BadProperty
 
struct  BadType
 
struct  NilPort
 
struct  PortAlreadyDefined
 
struct  PortNotConnected
 
struct  PortNotDefined
 
struct  superv_port_t
 
struct  UnexpectedState
 

Public Member Functions

 Superv_Component_i (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa, PortableServer::ObjectId *contId, const char *instanceName, const char *interfaceName, bool notif=false)
 
 Superv_Component_i (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa, Engines::Container_ptr container, const char *instanceName, const char *interfaceName, bool notif=false, bool regist=true)
 
virtual ~Superv_Component_i ()
 
virtual provides_portcreate_provides_control_port ()
 
virtual provides_portcreate_provides_data_and_control_port (const char *port_type)
 
virtual uses_portcreate_uses_control_port ()
 
virtual uses_portcreate_uses_data_and_control_port (const char *port_type)
 
virtual provides_portcreate_provides_data_port (const std::string &port_fab_type) throw (BadFabType)
 This method permits to create a provides port provided by the platform. More...
 
virtual uses_portcreate_uses_data_port (const std::string &port_fab_type) throw (BadFabType)
 This method permits to create a uses port provided by the platform. More...
 
virtual void add_port (const char *port_fab_type, const char *port_type, const char *port_name) throw (PortAlreadyDefined, BadFabType, BadType, BadProperty)
 Adds a port to the component. More...
 
template<typename SpecificPortType >
SpecificPortType * add_port (const char *port_fab_type, const char *port_type, const char *port_name) throw (PortAlreadyDefined, BadFabType, BadType, BadCast, BadProperty)
 Adds a port to the component. More...
 
virtual void add_port (provides_port *port, const char *provides_port_name) throw (PortAlreadyDefined, NilPort, BadProperty)
 Adds a created provides port to the component. More...
 
virtual void add_port (uses_port *port, const char *uses_port_name) throw (PortAlreadyDefined, NilPort, BadProperty)
 Adds a created uses port to the component. More...
 
virtual void get_port (provides_port *&port, const char *provides_port_name) throw (PortNotDefined, PortNotConnected)
 Gets the provides port already added in the component. More...
 
virtual void get_port (uses_port *&port, const char *uses_port_name) throw (PortNotDefined, PortNotConnected)
 Gets the uses port already added in the component. More...
 
virtual void get_uses_port_names (std::vector< std::string > &port_names, const std::string servicename="") const
 Gets the list of the ports of a service. More...
 
template<typename SpecificPortType >
SpecificPortType * get_port (const char *port_name) throw (PortNotDefined, PortNotConnected, BadCast, UnexpectedState)
 Gets a port already added in the component. More...
 
virtual void provides_port_changed (const char *provides_port_name, int connection_nbr, const Engines::DSC::Message message)
 
virtual void uses_port_changed (const char *uses_port_name, Engines::DSC::uses_port *new_uses_port, const Engines::DSC::Message message)
 
virtual port_factoryget_factory (const std::string &factory_name)
 Get a factory from the component. More...
 
void beginService (const char *serviceName)
 
virtual CORBA::Boolean init_service_with_multiple (const char *service_name, const Engines::Superv_Component::seq_multiple_param &params)
 
virtual void add_provides_port (Ports::Port_ptr ref, const char *provides_port_name, Ports::PortProperties_ptr port_prop) throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::NilPort, Engines::DSC::BadProperty)
 
virtual void add_uses_port (const char *repository_id, const char *uses_port_name, Ports::PortProperties_ptr port_prop) throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::BadProperty)
 
virtual Ports::Port_ptr get_provides_port (const char *provides_port_name, const CORBA::Boolean connection_error) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
 
virtual Engines::DSC::uses_portget_uses_port (const char *uses_port_name) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
 
virtual void connect_provides_port (const char *provides_port_name) throw (Engines::DSC::PortNotDefined)
 
virtual void connect_uses_port (const char *uses_port_name, Ports::Port_ptr provides_port_ref) throw (Engines::DSC::PortNotDefined, Engines::DSC::BadPortType, Engines::DSC::NilPort)
 
virtual CORBA::Boolean is_connected (const char *port_name) throw (Engines::DSC::PortNotDefined)
 
virtual void disconnect_provides_port (const char *provides_port_name, const Engines::DSC::Message message) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
 
virtual void disconnect_uses_port (const char *uses_port_name, Ports::Port_ptr provides_port_ref, const Engines::DSC::Message message) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected, Engines::DSC::BadPortReference)
 
virtual Ports::PortProperties_ptr get_port_properties (const char *port_name) throw (Engines::DSC::PortNotDefined)
 
charinstanceName ()
 CORBA method: return name of the instance, unique in this Container. More...
 
charinterfaceName ()
 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::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 charGetOption (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::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 chargetObjectInfo (CORBA::Long studyId, const char *entry)
 
virtual chargetVersion ()
 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...
 
virtual bool setStudyId (CORBA::Long studyId)
 C++ method: set study Id. 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...
 
chargraphName ()
 C++ method: – CHECK IF USED –. More...
 
charnodeName ()
 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 void register_factory (const std::string &factory_name, port_factory *factory_ptr)
 Add a factory the component. More...
 
static void setTimeOut ()
 
static bool isMultiStudy ()
 
static bool isMultiInstance ()
 
static std::string GetDynLibraryName (const char *componentName)
 C++ method: return standard library name built on component name. More...
 
static void writeEvent (const char *request, const std::string &containerName, const char *instance_name, const char *port_name, const char *error, const char *message)
 Write a record in the trace file. More...
 

Static Public Attributes

static long dscTimeOut =0
 

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
 
enum  port_type { uses, provides, none }
 
typedef std::map< std::string,
port_t * > 
ports
 

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
 
ports my_ports
 
ports::iterator my_ports_it
 

Static Protected Attributes

static bool _isMultiStudy = true
 
static bool _isMultiInstance = false
 

Private Types

typedef std::map< std::string,
port_factory * > 
factory_map_t
 
typedef std::map< std::string,
superv_port_t * > 
superv_ports
 

Private Attributes

superv_ports my_superv_ports
 
superv_ports::iterator my_superv_ports_it
 

Static Private Attributes

static factory_map_t _factory_map
 

Detailed Description

This class implements DSC_User component.

This class allows a higher programming level than DSC_Basic. It enables a programming level for service's developpers who want to use DSC ports.

This class has two level for using and declare ports. The higher level proposes operations to add ports that are provided by default by SALOME like Calcium ports. It provides too some methods to add their own DSC_User ports.

Note
This class doesn't implement the init_service CORBA operation.

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
typedef std::map<std::string, port_factory*> Superv_Component_i::factory_map_t
private
typedef std::map<std::string, port_t *> Engines_DSC_interface::ports
protectedinherited
typedef std::map<std::string, superv_port_t *> Superv_Component_i::superv_ports
private

Member Enumeration Documentation

enum Engines_DSC_interface::port_type
protectedinherited
Enumerator
uses 
provides 
none 

Constructor & Destructor Documentation

Superv_Component_i::Superv_Component_i ( CORBA::ORB_ptr  orb,
PortableServer::POA_ptr  poa,
PortableServer::ObjectId *  contId,
const char instanceName,
const char interfaceName,
bool  notif = false 
)

References setTimeOut().

Superv_Component_i::Superv_Component_i ( CORBA::ORB_ptr  orb,
PortableServer::POA_ptr  poa,
Engines::Container_ptr  container,
const char instanceName,
const char interfaceName,
bool  notif = false,
bool  regist = true 
)

References setTimeOut().

Superv_Component_i::~Superv_Component_i ( )
virtual

Member Function Documentation

SpecificPortType * Superv_Component_i::add_port ( const char port_fab_type,
const char port_type,
const char port_name 
) throw (PortAlreadyDefined, BadFabType, BadType, BadProperty)
virtual

Adds a port to the component.

With this method only Salomé's provided DSC ports can be added.

Parameters
port_fab_typetype of the port.
port_typeuses or provides.
port_namethe name of the port in the component.

References LOC.

Referenced by create_calcium_port().

template<typename SpecificPortType >
SpecificPortType* Superv_Component_i::add_port ( const char port_fab_type,
const char port_type,
const char port_name 
) throw (PortAlreadyDefined, BadFabType, BadType, BadCast, BadProperty)

Adds a port to the component.

With this method only Salomé's provided DSC ports can be added.

Parameters
port_fab_typetype of the port.
port_typeuses or provides.
port_namethe name of the port in the component.
Returns
the created port.
void Superv_Component_i::add_port ( provides_port port,
const char provides_port_name 
) throw (PortAlreadyDefined, NilPort, BadProperty)
virtual

Adds a created provides port to the component.

Parameters
portthe provides port.
provides_port_namethe name of the port in the component.

References Engines_DSC_interface::add_provides_port(), LOC, and Superv_Component_i::superv_port_t::p_ref.

void Superv_Component_i::add_port ( uses_port port,
const char uses_port_name 
) throw (PortAlreadyDefined, NilPort, BadProperty)
virtual

Adds a created uses port to the component.

Parameters
portthe uses port.
uses_port_namethe name of the port in the component.

References Engines_DSC_interface::add_uses_port(), and LOC.

virtual void Engines_DSC_i::add_provides_port ( Ports::Port_ptr  ref,
const char provides_port_name,
Ports::PortProperties_ptr  port_prop 
) throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::NilPort, Engines::DSC::BadProperty)
virtualinherited
virtual void Engines_DSC_i::add_uses_port ( const char repository_id,
const char uses_port_name,
Ports::PortProperties_ptr  port_prop 
) throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::BadProperty)
virtualinherited
void Superv_Component_i::beginService ( const char serviceName)
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
void Engines_Component_i::checkOutputFilesToService ( const char service_name)
virtualinherited
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().

virtual void Engines_DSC_i::connect_provides_port ( const char provides_port_name) throw (Engines::DSC::PortNotDefined)
virtualinherited
virtual void Engines_DSC_i::connect_uses_port ( const char uses_port_name,
Ports::Port_ptr  provides_port_ref 
) throw (Engines::DSC::PortNotDefined, Engines::DSC::BadPortType, Engines::DSC::NilPort)
virtualinherited
virtual provides_port* Superv_Component_i::create_provides_control_port ( )
virtual
Warning
currently disabled.
virtual provides_port* Superv_Component_i::create_provides_data_and_control_port ( const char port_type)
virtual
Warning
currently disabled.
provides_port * Superv_Component_i::create_provides_data_port ( const std::string &  port_fab_type) throw (BadFabType)
virtual

This method permits to create a provides port provided by the platform.

(See documentation of DSC for knoing these ports).

Parameters
port_fab_typetype provides port.
Returns
the provides port.
Note
It's user repsonsability to destroy the provides port.

References port_factory::create_data_servant(), and LOC.

Referenced by create_calcium_port().

virtual uses_port* Superv_Component_i::create_uses_control_port ( )
virtual
Warning
currently disabled.
virtual uses_port* Superv_Component_i::create_uses_data_and_control_port ( const char port_type)
virtual
Warning
currently disabled.
uses_port * Superv_Component_i::create_uses_data_port ( const std::string &  port_fab_type) throw (BadFabType)
virtual

This method permits to create a uses port provided by the platform.

(See documentation of DSC for knoing these ports).

Parameters
port_fab_typetype uses port.
Returns
the uses port.
Note
It's user repsonsability to destroy the uses port.

References port_factory::create_data_proxy(), and LOC.

Referenced by create_calcium_port().

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.

virtual void Engines_DSC_i::disconnect_provides_port ( const char provides_port_name,
const Engines::DSC::Message  message 
) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
virtualinherited
virtual void Engines_DSC_i::disconnect_uses_port ( const char uses_port_name,
Ports::Port_ptr  provides_port_ref,
const Engines::DSC::Message  message 
) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected, Engines::DSC::BadPortReference)
virtualinherited
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
port_factory * Superv_Component_i::get_factory ( const std::string &  factory_name)
virtual

Get a factory from the component.

Parameters
factory_namename of the factory.
Returns
factory pointer, NULL if the factory doesn't exist.

References _factory_map.

void Superv_Component_i::get_port ( provides_port *&  port,
const char provides_port_name 
) throw (PortNotDefined, PortNotConnected)
virtual

Gets the provides port already added in the component.

Parameters
portthe provides port pointer.
provides_port_namethe name of the port.

References Engines_DSC_interface::get_provides_port(), and LOC.

void Superv_Component_i::get_port ( uses_port *&  port,
const char uses_port_name 
) throw (PortNotDefined, PortNotConnected)
virtual

Gets the uses port already added in the component.

Parameters
portthe uses port pointer.
uses_port_namethe name of the port.

References Engines_DSC_i::get_uses_port(), and LOC.

template<typename SpecificPortType >
SpecificPortType * Superv_Component_i::get_port ( const char port_name) throw (PortNotDefined, PortNotConnected, BadCast, UnexpectedState)

Gets a port already added in the component.

Parameters
port_namethe name of the port.
Returns
a port's pointer.

References Engines_DSC_interface::get_provides_port(), Engines_DSC_i::get_uses_port(), LOC, Superv_Component_i::superv_port_t::p_ref, and Superv_Component_i::superv_port_t::u_ref.

virtual Ports::PortProperties_ptr Engines_DSC_i::get_port_properties ( const char port_name) throw (Engines::DSC::PortNotDefined)
virtualinherited
virtual Ports::Port_ptr Engines_DSC_i::get_provides_port ( const char provides_port_name,
const CORBA::Boolean  connection_error 
) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
virtualinherited
virtual Engines::DSC::uses_port* Engines_DSC_i::get_uses_port ( const char uses_port_name) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
virtualinherited
void Superv_Component_i::get_uses_port_names ( std::vector< std::string > &  port_names,
const std::string  servicename = "" 
) const
virtual

Gets the list of the ports of a service.

If servicename is not set, all the ports of the component are returned.

Parameters
port_namesthe ports's list.
servicenameservice's name.

References my_superv_ports.

Referenced by CalciumInterface::ecp_fin().

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
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
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
virtual CORBA::Boolean Superv_Component_i::init_service_with_multiple ( const char service_name,
const Engines::Superv_Component::seq_multiple_param params 
)
virtual

Reimplemented in PySupervCompo.

char * Engines_Component_i::interfaceName ( )
inherited

CORBA method: return name of the component class.

References Engines_Component_i::_interfaceName.

virtual CORBA::Boolean Engines_DSC_i::is_connected ( const char port_name) throw (Engines::DSC::PortNotDefined)
virtualinherited
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
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.

void Superv_Component_i::provides_port_changed ( const char provides_port_name,
int  connection_nbr,
const Engines::DSC::Message  message 
)
virtual
void Superv_Component_i::register_factory ( const std::string &  factory_name,
port_factory factory_ptr 
)
static

Add a factory the component.

If the factory_name is already used, the new library is not added.

Parameters
factory_namename of the factory (used by Superv_Component_i::create_provides_data_port and Superv_Component_i::create_uses_data_port)
factory_ptrfactory pointer (destroyed by the component)

References _factory_map.

Referenced by basic_port_factory::basic_port_factory(), calcium_port_factory::calcium_port_factory(), and palm_port_factory::palm_port_factory().

void Engines_Component_i::sendMessage ( const char event_type,
const char message 
)
inherited
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
Engines::Salome_file_ptr Engines_Component_i::setInputFileToService ( const char service_name,
const char Salome_file_name 
)
virtualinherited
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
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.

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

C++ method: set study Id.

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

void Superv_Component_i::setTimeOut ( )
static

References dscTimeOut.

Referenced by beginService(), and Superv_Component_i().

void Superv_Component_i::uses_port_changed ( const char uses_port_name,
Engines::DSC::uses_port new_uses_port,
const Engines::DSC::Message  message 
)
virtual
void Engines_DSC_interface::writeEvent ( const char request,
const std::string &  containerName,
const char instance_name,
const char port_name,
const char error,
const char message 
)
staticinherited

Write a record in the trace file.

Parameters
requestthe name of the request executed
containerNamethe name of the container where the request is executed
instance_namethe name of the component where the request is executed
port_namethe name of the port that is concerned
errorif an error has occured, a string that identifies the error
messageinformations about error or about the request

References initTrace().

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(), CalciumInterface::ecp_lecture(), GenericPort< DataManipulator, COUPLING_POLICY >::get(), and GenericPort< DataManipulator, COUPLING_POLICY >::next().

Field Documentation

std::string Engines_Component_i::_containerName
protectedinherited
PortableServer::ObjectId* Engines_Component_i::_contId
protectedinherited
std::map< std::string, port_factory * > Superv_Component_i::_factory_map
staticprivate

Referenced by get_factory(), and register_factory().

std::map<std::string,CORBA::Any> Engines_Component_i::_fieldsDict
protectedinherited
std::string Engines_Component_i::_graphName
protectedinherited
bool Engines_Component_i::_isMultiInstance = false
staticprotectedinherited
bool Engines_Component_i::_isMultiStudy = true
staticprotectedinherited
RegistryConnexion* Engines_Component_i::_myConnexionToRegistry
protectedinherited
std::string Engines_Component_i::_nodeName
protectedinherited
CORBA::ORB_var Engines_Component_i::_orb
protectedinherited
std::string Engines_Component_i::_serviceName
protectedinherited
int Engines_Component_i::_studyId
protectedinherited
ports Engines_DSC_interface::my_ports
protectedinherited
ports::iterator Engines_DSC_interface::my_ports_it
protectedinherited
superv_ports Superv_Component_i::my_superv_ports
private
superv_ports::iterator Superv_Component_i::my_superv_ports_it
private