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

Module catalog interface More...

Public Member Functions

void ping ()
 ping the ModuleCatalog server More...
 
long getPID ()
 Returns the PID of the ModuleCatalog server. More...
 
oneway void ShutdownWithExit ()
 Shutdown the ModuleCatalog server. More...
 
ListOfTypeDefinition GetTypes ()
 Get the types of the catalog. More...
 
ListOfComputers GetComputerList ()
 Get a list of computer names of the catalog. More...
 
string GetPathPrefix (in string machinename) raises (NotFound)
 Get the PathPrefix of a computer. More...
 
ListOfComponents GetComponentList ()
 Get a list of component names of the catalog. More...
 
ListOfIAPP_Affich GetComponentIconeList ()
 Get a list of pair GUI elements (component name, component icone) used for representation of the module in IAPP component. More...
 
ListOfComponents GetTypedComponentList (in ComponentType _component_type)
 Get a list of component names of a particular type, which belong to this catalog. More...
 
Acomponent GetComponent (in string componentname) raises (NotFound)
 Get one component of the catalog. More...
 
ComponentDef GetComponentInfo (in string componentName) raises (NotFound)
 Get the description of a component of the catalog. More...
 
void ImportXmlCatalogFile (in string filename) raises (NotFound)
 Read a xml file and import new components from this file. More...
 
void shutdown ()
 Shutdown the module catalog server. More...
 

Detailed Description

Module catalog interface

Interface to get information about components from the module catalog in SALOME application.

Member Function Documentation

void SALOME_ModuleCatalog::ModuleCatalog::ping ( )

ping the ModuleCatalog server

long SALOME_ModuleCatalog::ModuleCatalog::getPID ( )

Returns the PID of the ModuleCatalog server.

oneway void SALOME_ModuleCatalog::ModuleCatalog::ShutdownWithExit ( )

Shutdown the ModuleCatalog server.

ListOfTypeDefinition SALOME_ModuleCatalog::ModuleCatalog::GetTypes ( )

Get the types of the catalog.

ListOfComputers SALOME_ModuleCatalog::ModuleCatalog::GetComputerList ( )

Get a list of computer names of the catalog.

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

Get the PathPrefix of a computer.

ListOfComponents SALOME_ModuleCatalog::ModuleCatalog::GetComponentList ( )

Get a list of component names of the catalog.

ListOfIAPP_Affich SALOME_ModuleCatalog::ModuleCatalog::GetComponentIconeList ( )

Get a list of pair GUI elements (component name, component icone) used for representation of the module in IAPP component.

ListOfComponents SALOME_ModuleCatalog::ModuleCatalog::GetTypedComponentList ( in ComponentType  _component_type)

Get a list of component names of a particular type, which belong to this catalog.

Acomponent SALOME_ModuleCatalog::ModuleCatalog::GetComponent ( in string  componentname) raises (NotFound)

Get one component of the catalog.

ComponentDef SALOME_ModuleCatalog::ModuleCatalog::GetComponentInfo ( in string  componentName) raises (NotFound)

Get the description of a component of the catalog.

void SALOME_ModuleCatalog::ModuleCatalog::ImportXmlCatalogFile ( in string  filename) raises (NotFound)

Read a xml file and import new components from this file.

New components replace existing components with the same name.

void SALOME_ModuleCatalog::ModuleCatalog::shutdown ( )

Shutdown the module catalog server.