General KERNEL Documentation     End User KERNEL Services  

SALOME_ModuleCatalog::Acomponent

SALOME_ModuleCatalog::Acomponent Interface Reference

import "SALOME_ModuleCatalog.idl";

Collaboration diagram for SALOME_ModuleCatalog::Acomponent:

Collaboration graph

Public Member Functions

ListOfInterfaces GetInterfaceList ()
DefinitionInterface GetInterface (in string interfacename) raises (NotFound)
ListOfServices GetServiceList (in string interfacename) raises (NotFound)
Service GetService (in string interfacename, in string servicename) raises (NotFound)
Service GetDefaultService (in string interfacename) raises (NotFound)
string GetPathPrefix (in string machinename) raises (NotFound)

Data Fields

readonly attribute string constraint
readonly attribute string componentname
readonly attribute string componentusername
readonly attribute boolean multistudy
readonly attribute ComponentType component_type
readonly attribute string component_icone
readonly attribute boolean implementation_type

Detailed Description

This interface provides the common funcionality information of corresponding component. Information is loaded from specific xml files.

Member Function Documentation

ListOfInterfaces SALOME_ModuleCatalog::Acomponent::GetInterfaceList (   ) 
 

Gets the list of names of interfaces of the component

Returns:
a list of interfaces of the component

DefinitionInterface SALOME_ModuleCatalog::Acomponent::GetInterface (  in string  interfacename  )  raises (NotFound)
 

Gets a definite interface of the component

Note:

If the specified interface doesn't exist, Notfound exception is thrown
Parameters:
interfacename Name of the interface
Returns:
Required interface

ListOfServices SALOME_ModuleCatalog::Acomponent::GetServiceList (  in string  interfacename  )  raises (NotFound)
 

Gets the list of names of services of a definite interface belonging to the component.

Note:

If the specified interface doesn't exist, Notfound exception is thrown.
Parameters:
interfacename Name of the interface
Returns:
List of services of the required interface

Service SALOME_ModuleCatalog::Acomponent::GetService (  in string  interfacename,
in string  servicename
)  raises (NotFound)
 

Gets a definite service of an interface of the component.

Note:

If the required service or the specified interface don't exist, Notfound exception is thrown.
Parameters:
interfacename Name of the interface
servicename Name of the service
Returns:
Required service

Service SALOME_ModuleCatalog::Acomponent::GetDefaultService (  in string  interfacename  )  raises (NotFound)
 

Gets 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:
interfacename Name of the interface
Returns:
Required service

string SALOME_ModuleCatalog::Acomponent::GetPathPrefix (  in string  machinename  )  raises (NotFound)
 

Gets the prefix path of the computer containing the component.

Note:

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

Field Documentation

readonly attribute string SALOME_ModuleCatalog::Acomponent::constraint
 

Get the constraint affected to the component (to be resolved by LifeCycle for the computer choice)

readonly attribute string SALOME_ModuleCatalog::Acomponent::componentname
 

Get the name of the component

readonly attribute string SALOME_ModuleCatalog::Acomponent::componentusername
 

Get the user name of the component

readonly attribute boolean SALOME_ModuleCatalog::Acomponent::multistudy
 

Ask whether the component is multistudy or not

readonly attribute ComponentType SALOME_ModuleCatalog::Acomponent::component_type
 

Ask the type of the component

readonly attribute string SALOME_ModuleCatalog::Acomponent::component_icone
 

Gets the icone of the component (for IAPP)

readonly attribute boolean SALOME_ModuleCatalog::Acomponent::implementation_type
 

Gets the implementation type of the component : C++ or Python (for IAPP)

  General KERNEL Documentation     End User KERNEL Services  

Generated on Thu Apr 26 18:15:22 2007 for SALOME v.3.2.6 by doxygen 1.4.6