Version: 9.15.0
SALOME_ModuleCatalogImpl Class Reference

#include <SALOME_ModuleCatalog_impl.hxx>

Inheritance diagram for SALOME_ModuleCatalogImpl:

Data Structures

class  Private
 

Public Member Functions

 SALOME_ModuleCatalogImpl (int artgc, char **argv, CORBA::ORB_ptr orb=NULL)
 standard constructor More...
 
virtual ~SALOME_ModuleCatalogImpl ()
 standard destructor More...
 
virtual SALOME_ModuleCatalog::ListOfComputersGetComputerList ()
 method to get a component list More...
 
virtual SALOME_ModuleCatalog::ListOfTypeDefinitionGetTypes ()
 method to get the list of all types of the catalog More...
 
virtual char * GetPathPrefix (const char *machinename)
 method to get the PathPrefix of a computer More...
 
virtual void ImportXmlCatalogFile (const char *xmlFileName)
 method to read a XML file and import new components into the component list More...
 
virtual SALOME_ModuleCatalog::ListOfComponentsGetComponentList ()
 method to get a component list More...
 
virtual SALOME_ModuleCatalog::ListOfIAPP_AffichGetComponentIconeList ()
 method to get a component list of component name and component icone More...
 
virtual SALOME_ModuleCatalog::ListOfComponentsGetTypedComponentList (SALOME_ModuleCatalog::ComponentType component_type)
 method to get a component list of a wanted type More...
 
virtual SALOME_ModuleCatalog::Acomponent_ptr GetComponent (const char *componentname)
 method to get a component More...
 
virtual SALOME_ModuleCatalog::ComponentDefGetComponentInfo (const char *name)
 method to get a component description More...
 
void ping ()
 method to check the server is alive More...
 
CORBA::Long getPID ()
 get PID of the server More...
 
void ShutdownWithExit ()
 shutdown server and exit More...
 
void shutdown ()
 shutdown server More...
 

Static Public Attributes

static const char ENTRY_IN_NS [] = "/Kernel/ModulCatalog"
 

Private Member Functions

virtual bool _parseArguments (int argc, char **argv, char **_general, char **_personal)
 method to parse arguments to get general and personal catalog files More...
 

Private Attributes

CORBA::ORB_ptr _orb
 
PrivatemyPrivate
 

Constructor & Destructor Documentation

◆ SALOME_ModuleCatalogImpl()

◆ ~SALOME_ModuleCatalogImpl()

SALOME_ModuleCatalogImpl::~SALOME_ModuleCatalogImpl ( )
virtual

standard destructor

References MESSAGE, and myPrivate.

Member Function Documentation

◆ _parseArguments()

bool SALOME_ModuleCatalogImpl::_parseArguments ( int  argc,
char **  argv,
char **  _general,
char **  _personal 
)
privatevirtual

method to parse arguments to get general and personal catalog files

Parameters
argcint arguments
argvchar** arguments
_generalchar** arguments
Returns
true if parsing is OK

References envSalome::argv.

Referenced by SALOME_ModuleCatalogImpl().

◆ GetComponent()

SALOME_ModuleCatalog::Acomponent_ptr SALOME_ModuleCatalogImpl::GetComponent ( const char *  componentname)
virtual

method to get a component

Parameters
componentnameconst char* arguments
Returns
the wanted component

References SALOME_ModuleCatalogImpl::Private::duplicate(), SALOME_ModuleCatalogImpl::Private::findComponent(), MESSAGE, myPrivate, and pythfilter::name.

◆ GetComponentIconeList()

SALOME_ModuleCatalog::ListOfIAPP_Affich * SALOME_ModuleCatalogImpl::GetComponentIconeList ( )
virtual

method to get a component list of component name and component icone

Returns
a list of couple (component name, component icone)

References SALOME_ModuleCatalogImpl::Private::_general_module_list, SALOME_ModuleCatalogImpl::Private::_personal_module_list, MESSAGE, and myPrivate.

◆ GetComponentInfo()

SALOME_ModuleCatalog::ComponentDef * SALOME_ModuleCatalogImpl::GetComponentInfo ( const char *  name)
virtual

method to get a component description

Parameters
componentnameconst char* arguments
Returns
the wanted component description

References SALOME_ModuleCatalogImpl::Private::duplicate(), SALOME_ModuleCatalogImpl::Private::findComponent(), myPrivate, and pythfilter::name.

◆ GetComponentList()

SALOME_ModuleCatalog::ListOfComponents * SALOME_ModuleCatalogImpl::GetComponentList ( )
virtual

◆ GetComputerList()

SALOME_ModuleCatalog::ListOfComputers * SALOME_ModuleCatalogImpl::GetComputerList ( )
virtual

method to get a component list

Returns
a component list

◆ GetPathPrefix()

char * SALOME_ModuleCatalogImpl::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 SALOME_ModuleCatalogImpl::Private::_general_path_list, SALOME_ModuleCatalogImpl::Private::_personal_path_list, MESSAGE, and myPrivate.

◆ getPID()

CORBA::Long SALOME_ModuleCatalogImpl::getPID ( )

get PID of the server

◆ GetTypedComponentList()

◆ GetTypes()

SALOME_ModuleCatalog::ListOfTypeDefinition * SALOME_ModuleCatalogImpl::GetTypes ( )
virtual

◆ ImportXmlCatalogFile()

void SALOME_ModuleCatalogImpl::ImportXmlCatalogFile ( const char *  xmlFileName)
virtual

method to read a XML file and import new components into the component list

If the XML file doesn't exist or is not readable, the Notfound exception is thrown

Parameters
constchar* xmlFileName

References SALOME_ModuleCatalogImpl::Private::_parse_xml_file(), SALOME_ModuleCatalogImpl::Private::_personal_module_list, SALOME_ModuleCatalogImpl::Private::_personal_path_list, SALOME_ModuleCatalogImpl::Private::_typeList, SALOME_ModuleCatalogImpl::Private::_typeMap, and myPrivate.

◆ ping()

void SALOME_ModuleCatalogImpl::ping ( )

method to check the server is alive

◆ shutdown()

void SALOME_ModuleCatalogImpl::shutdown ( )

shutdown server

References _orb.

◆ ShutdownWithExit()

void SALOME_ModuleCatalogImpl::ShutdownWithExit ( )

shutdown server and exit

Field Documentation

◆ _orb

◆ ENTRY_IN_NS

const char SALOME_ModuleCatalogImpl::ENTRY_IN_NS = "/Kernel/ModulCatalog"
static

◆ myPrivate