Version: 8.3.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
SALOME_ModuleCatalog::Acomponent Interface Reference

This interface provides the common functionality information of corresponding component. More...

Public Member Functions

ListOfInterfaces GetInterfaceList ()
 Get the list of interface names of the component. More...
 
DefinitionInterface GetInterface (in string interfacename) raises (NotFound)
 Get an interface of the component. More...
 
ListOfServices GetServiceList (in string interfacename) raises (NotFound)
 Get the list of service names of an interface belonging to the component. More...
 
Service GetService (in string interfacename, in string servicename) raises (NotFound)
 Get a service of an interface of the component. More...
 
Service GetDefaultService (in string interfacename) raises (NotFound)
 Get the default service of an interface of the component. More...
 
string GetPathPrefix (in string machinename) raises (NotFound)
 Get the prefix path of the computer containing the component. More...
 

Data Fields

readonly attribute string constraint
 Get the constraint affected to the component. More...
 
readonly attribute string componentname
 Get the component name. More...
 
readonly attribute string componentusername
 Get the user name of the component. More...
 
readonly attribute boolean multistudy
 Get whether the component is multistudy or not. More...
 
readonly attribute ComponentType component_type
 Get the type of the component. More...
 
readonly attribute string component_icone
 Get the icone of the component (for IAPP) More...
 
readonly attribute ImplType implementation_type
 Get the implementation type of the component. More...
 
readonly attribute string implementation_name
 Get the implementation name of the component. More...
 

Detailed Description

This interface provides the common functionality information of corresponding component.

Information is loaded from specific xml files.

Member Function Documentation

ListOfInterfaces SALOME_ModuleCatalog::Acomponent::GetInterfaceList ( )

Get the list of interface names of the component.

Returns
a list of interfaces of the component
DefinitionInterface SALOME_ModuleCatalog::Acomponent::GetInterface ( in string  interfacename) raises (NotFound)

Get an interface of the component.

Note

If the specified interface doesn't exist, Notfound exception is thrown
Parameters
interfacenameName of the interface
Returns
Required interface
ListOfServices SALOME_ModuleCatalog::Acomponent::GetServiceList ( in string  interfacename) raises (NotFound)

Get the list of service names of an interface belonging to the component.

Note

If the specified interface doesn't exist, Notfound exception is thrown.
Parameters
interfacenameName of the interface
Returns
List of services of the required interface
Service SALOME_ModuleCatalog::Acomponent::GetService ( in string  interfacename,
in string  servicename 
) raises (NotFound)

Get a service of an interface of the component.

Note

If the required service or the specified interface don't exist, Notfound exception is thrown.
Parameters
interfacenameName of the interface
servicenameName of the service
Returns
Required service
Service SALOME_ModuleCatalog::Acomponent::GetDefaultService ( in string  interfacename) raises (NotFound)

Get the default service of an interface of the component.

Note

If the required service or the specified interface don't exist, Notfound exception is thrown.
Parameters
interfacenameName of the interface
Returns
Required service
string SALOME_ModuleCatalog::Acomponent::GetPathPrefix ( in string  machinename) raises (NotFound)

Get the prefix path of the computer containing the component.

Note

If the required computer doesn't exist, Notfound exception is thrown
Parameters
machinenameName of the machine
Returns
Prefix path

Field Documentation

readonly attribute string SALOME_ModuleCatalog::Acomponent::constraint

Get the constraint affected to the component.

constraint to be resolved by LifeCycle for the computer choice

readonly attribute string SALOME_ModuleCatalog::Acomponent::componentname

Get the component name.

readonly attribute string SALOME_ModuleCatalog::Acomponent::componentusername

Get the user name of the component.

readonly attribute boolean SALOME_ModuleCatalog::Acomponent::multistudy

Get whether the component is multistudy or not.

readonly attribute ComponentType SALOME_ModuleCatalog::Acomponent::component_type

Get the type of the component.

readonly attribute string SALOME_ModuleCatalog::Acomponent::component_icone

Get the icone of the component (for IAPP)

readonly attribute ImplType SALOME_ModuleCatalog::Acomponent::implementation_type

Get the implementation type of the component.

C++ (dyn lib), Python (module) or executable

readonly attribute string SALOME_ModuleCatalog::Acomponent::implementation_name

Get the implementation name of the component.

It's the name of the dyn lib or the python module or the executable if the default naming scheme is not convenient.