Version: 9.12.0
SALOME_ModuleCatalog_AcomponentImpl Class Reference

#include <SALOME_ModuleCatalog_Acomponent_impl.hxx>

Inheritance diagram for SALOME_ModuleCatalog_AcomponentImpl:

Public Member Functions

 SALOME_ModuleCatalog_AcomponentImpl (SALOME_ModuleCatalog::ComponentDef &C)
 standard constructor More...
 
virtual ~SALOME_ModuleCatalog_AcomponentImpl ()
 standard destructor More...
 
virtual SALOME_ModuleCatalog::ListOfInterfacesGetInterfaceList ()
 method to get a list of the interfaces name of a component More...
 
virtual SALOME_ModuleCatalog::DefinitionInterfaceGetInterface (const char *interfacename)
 method to get one interface of a component More...
 
virtual SALOME_ModuleCatalog::ListOfServicesGetServiceList (const char *interfacename)
 method to get a list of the services name of an interface of a component More...
 
virtual SALOME_ModuleCatalog::ServiceGetService (const char *interfacename, const char *servicename)
 method to get one service of an interface of a component More...
 
virtual SALOME_ModuleCatalog::ServiceGetDefaultService (const char *interfacename)
 method to get the default service of an interface of a component More...
 
virtual char * GetPathPrefix (const char *machinename)
 method to get the PathPrefix of a computer More...
 
virtual char * constraint ()
 method to obtain the constraint affected to a component More...
 
virtual char * componentname ()
 method to obtain the componentname More...
 
virtual char * componentusername ()
 method to obtain the componentusername More...
 
virtual SALOME_ModuleCatalog::ComponentType component_type ()
 method to define the type of the component More...
 
virtual char * component_icone ()
 method to obtain the component icone (for IAPP) More...
 
virtual SALOME_ModuleCatalog::ImplType implementation_type ()
 method to define if a component is implemented in a dyn lib a python module or an executable More...
 
virtual char * implementation_name ()
 method to obtain the implementation name of the component if the default one is not convenient More...
 

Private Member Functions

void duplicate (SALOME_ModuleCatalog::DefinitionInterface &I_out, const SALOME_ModuleCatalog::DefinitionInterface &I_in)
 method to duplicate an interface More...
 
void duplicate (SALOME_ModuleCatalog::Service &S_out, const SALOME_ModuleCatalog::Service &S_in)
 method to duplicate a service More...
 
void duplicate (SALOME_ModuleCatalog::ServicesParameter &P_out, const SALOME_ModuleCatalog::ServicesParameter &P_in)
 method to duplicate a parameter More...
 
void duplicate (SALOME_ModuleCatalog::ServicesDataStreamParameter &P_out, const SALOME_ModuleCatalog::ServicesDataStreamParameter &P_in)
 method to duplicate a parameter More...
 

Private Attributes

SALOME_ModuleCatalog::ComponentDef _Component
 

Constructor & Destructor Documentation

◆ SALOME_ModuleCatalog_AcomponentImpl()

SALOME_ModuleCatalog_AcomponentImpl::SALOME_ModuleCatalog_AcomponentImpl ( SALOME_ModuleCatalog::ComponentDef C)

standard constructor

◆ ~SALOME_ModuleCatalog_AcomponentImpl()

SALOME_ModuleCatalog_AcomponentImpl::~SALOME_ModuleCatalog_AcomponentImpl ( )
virtual

standard destructor

References BEGIN_OF, and END_OF.

Member Function Documentation

◆ component_icone()

char * SALOME_ModuleCatalog_AcomponentImpl::component_icone ( )
virtual

method to obtain the component icone (for IAPP)

Returns
the component icon

References _Component, and SALOME_ModuleCatalog::ComponentDef::icon.

◆ component_type()

SALOME_ModuleCatalog::ComponentType SALOME_ModuleCatalog_AcomponentImpl::component_type ( )
virtual

method to define the type of the component

Returns
the component type

References _Component, and SALOME_ModuleCatalog::ComponentDef::type.

◆ componentname()

char * SALOME_ModuleCatalog_AcomponentImpl::componentname ( )
virtual

method to obtain the componentname

Returns
the component name

References _Component, and SALOME_ModuleCatalog::ComponentDef::name.

◆ componentusername()

char * SALOME_ModuleCatalog_AcomponentImpl::componentusername ( )
virtual

method to obtain the componentusername

Returns
the component user name

References _Component, and SALOME_ModuleCatalog::ComponentDef::username.

◆ constraint()

char * SALOME_ModuleCatalog_AcomponentImpl::constraint ( )
virtual

method to obtain the constraint affected to a component

to be resolved by LifeCycle for the computer choice

Returns
the constraint

References _Component, and SALOME_ModuleCatalog::ComponentDef::constraint.

◆ duplicate() [1/4]

void SALOME_ModuleCatalog_AcomponentImpl::duplicate ( SALOME_ModuleCatalog::DefinitionInterface I_out,
const SALOME_ModuleCatalog::DefinitionInterface I_in 
)
private

◆ duplicate() [2/4]

◆ duplicate() [3/4]

◆ duplicate() [4/4]

void SALOME_ModuleCatalog_AcomponentImpl::duplicate ( SALOME_ModuleCatalog::ServicesParameter P_out,
const SALOME_ModuleCatalog::ServicesParameter P_in 
)
private

method to duplicate a parameter

Parameters
parameterSALOME_ModuleCatalog::ServicesParameter arguments
Returns
the parameter

References SALOME_ModuleCatalog::ServicesParameter::Parametername, and SALOME_ModuleCatalog::ServicesParameter::Parametertype.

◆ GetDefaultService()

SALOME_ModuleCatalog::Service * SALOME_ModuleCatalog_AcomponentImpl::GetDefaultService ( const char *  interfacename)
virtual

method to get the default service of an interface of a component

If the specified interface doesn't exist, the Notfound exception is thrown

Parameters
interfacenameconst char* arguments
Returns
the default service of the interface

References _Component, BEGIN_OF, duplicate(), END_OF, SALOME_ModuleCatalog::ComponentDef::interfaces, MESSAGE, SALOME_ModuleCatalog::ComponentDef::name, and SCRUTE.

◆ GetInterface()

SALOME_ModuleCatalog::DefinitionInterface * SALOME_ModuleCatalog_AcomponentImpl::GetInterface ( const char *  interfacename)
virtual

method to get one interface of a component

If the specified interface doesn't exist, the Notfound exception is thrown

Parameters
interfacename const car* arguments
Returns
the wanted interface

References _Component, BEGIN_OF, duplicate(), END_OF, TestModuleCatalog::I, SALOME_ModuleCatalog::ComponentDef::interfaces, MESSAGE, SALOME_ModuleCatalog::ComponentDef::name, and SCRUTE.

◆ GetInterfaceList()

SALOME_ModuleCatalog::ListOfInterfaces * SALOME_ModuleCatalog_AcomponentImpl::GetInterfaceList ( )
virtual

method to get a list of the interfaces name of a component

Returns
a list of the interfaces of a component

References _Component, BEGIN_OF, END_OF, SALOME_ModuleCatalog::ComponentDef::interfaces, MESSAGE, and SALOME_ModuleCatalog::ComponentDef::name.

◆ GetPathPrefix()

char * SALOME_ModuleCatalog_AcomponentImpl::GetPathPrefix ( const char *  machinename)
virtual

method to get the PathPrefix of a computer

If the wanted computer doesn't exist, the Notfound exception is thrown

Parameters
machinenameconst char* arguments
Returns
the prefix path

References _Component, BEGIN_OF, END_OF, MESSAGE, SALOME_ModuleCatalog::ComponentDef::name, SALOME_ModuleCatalog::ComponentDef::paths, and SCRUTE.

◆ GetService()

SALOME_ModuleCatalog::Service * SALOME_ModuleCatalog_AcomponentImpl::GetService ( const char *  interfacename,
const char *  servicename 
)
virtual

method to get one service of an interface of a component

If the wanted service or the specified interface don't exist, the Notfound exception is thrown

Parameters
interfacenameconst char* arguments
servicenameconst char* arguments
Returns
the wanted service

References _Component, BEGIN_OF, duplicate(), END_OF, TestModuleCatalog::I, SALOME_ModuleCatalog::ComponentDef::interfaces, MESSAGE, SALOME_ModuleCatalog::ComponentDef::name, SCRUTE, and SALOME_ModuleCatalog::Service::ServiceName.

◆ GetServiceList()

SALOME_ModuleCatalog::ListOfServices * SALOME_ModuleCatalog_AcomponentImpl::GetServiceList ( const char *  interfacename)
virtual

method to get a list of the services name of an interface of a component

If the specified interface doesn't exist, the Notfound exception is thrown

Parameters
interfacenameconst char* arguments
Returns
a list of the services of the wanted interface

References _Component, BEGIN_OF, END_OF, TestModuleCatalog::I, SALOME_ModuleCatalog::ComponentDef::interfaces, MESSAGE, SALOME_ModuleCatalog::ComponentDef::name, and SCRUTE.

◆ implementation_name()

char * SALOME_ModuleCatalog_AcomponentImpl::implementation_name ( )
virtual

method to obtain the implementation name of the component if the default one is not convenient

Returns
the implementation name to exec

References _Component, and SALOME_ModuleCatalog::ComponentDef::implname.

◆ implementation_type()

SALOME_ModuleCatalog::ImplType SALOME_ModuleCatalog_AcomponentImpl::implementation_type ( )
virtual

method to define if a component is implemented in a dyn lib a python module or an executable

Returns
an enum SO or PY or EXE or CEXE

References _Component, and SALOME_ModuleCatalog::ComponentDef::implementationType.

Field Documentation

◆ _Component