Back to index

salome-kernel  6.5.0
Public Member Functions | Public Attributes
SALOME_ModuleCatalog::Acomponent Interface Reference

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

import "SALOME_ModuleCatalog.idl";

Collaboration diagram for SALOME_ModuleCatalog::Acomponent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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

Detailed Description

This interface provides the common functionality information of corresponding component.

Information is loaded from specific xml files.

Definition at line 207 of file SALOME_ModuleCatalog.idl.


Member Function Documentation

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

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

Get the list of interface names of the component.

Returns:
a list of interfaces of the component
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
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

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

Member Data Documentation

Get the icone of the component (for IAPP)

Definition at line 282 of file SALOME_ModuleCatalog.idl.

Get the type of the component.

Definition at line 278 of file SALOME_ModuleCatalog.idl.

Get the component name.

Definition at line 266 of file SALOME_ModuleCatalog.idl.

Get the user name of the component.

Definition at line 270 of file SALOME_ModuleCatalog.idl.

Get the constraint affected to the component.

constraint to be resolved by LifeCycle for the computer choice

Definition at line 262 of file SALOME_ModuleCatalog.idl.

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.

Definition at line 294 of file SALOME_ModuleCatalog.idl.

Get the implementation type of the component.

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

Definition at line 288 of file SALOME_ModuleCatalog.idl.

Get whether the component is multistudy or not.

Definition at line 274 of file SALOME_ModuleCatalog.idl.


The documentation for this interface was generated from the following file: