Back to index

salome-kernel  6.5.0
Public Member Functions | Private Member Functions | Private Attributes
MODULECATALOG_EXPORT Protocol Reference

#include <SALOME_ModuleCatalog_Acomponent_impl.hxx>

Collaboration diagram for MODULECATALOG_EXPORT:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SALOME_ModuleCatalog_AcomponentImpl (SALOME_ModuleCatalog::ComponentDef &C)
 standard constructor
virtual ~SALOME_ModuleCatalog_AcomponentImpl ()
 standard destructor
virtual
SALOME_ModuleCatalog::ListOfInterfaces
GetInterfaceList ()
 method to get a list of the interfaces name of a component
virtual
SALOME_ModuleCatalog::DefinitionInterface
GetInterface (const char *interfacename) throw (SALOME_ModuleCatalog::NotFound)
 method to get one interface of a component
virtual
SALOME_ModuleCatalog::ListOfServices
GetServiceList (const char *interfacename) throw (SALOME_ModuleCatalog::NotFound)
 method to get a list of the services name of an interface of a component
virtual
SALOME_ModuleCatalog::Service
GetService (const char *interfacename, const char *servicename) throw (SALOME_ModuleCatalog::NotFound)
 method to get one service of an interface of a component
virtual
SALOME_ModuleCatalog::Service
GetDefaultService (const char *interfacename) throw (SALOME_ModuleCatalog::NotFound)
 method to get the default service of an interface of a component
virtual char * GetPathPrefix (const char *machinename) throw (SALOME_ModuleCatalog::NotFound)
 method to get the PathPrefix of a computer
virtual char * constraint ()
 method to obtain the constraint affected to a component
virtual char * componentname ()
 method to obtain the componentname
virtual char * componentusername ()
 method to obtain the componentusername
virtual CORBA::Boolean multistudy ()
 method to define if a component can be multistudy or not
virtual
SALOME_ModuleCatalog::ComponentType 
component_type ()
 method to define the type of the component
virtual char * component_icone ()
 method to obtain the component icone (for IAPP)
virtual
SALOME_ModuleCatalog::ImplType 
implementation_type ()
 method to define if a component is implemented in a dyn lib a python module or an executable
virtual char * implementation_name ()
 method to obtain the implementation name of the component if the default one is not convenient
 SALOME_ModuleCatalog_Handler (ParserPathPrefixes &pathList, ParserComponents &moduleList, ParserTypes &typeMap, TypeList &typeList)
 standard constructor
virtual ~SALOME_ModuleCatalog_Handler ()
 standard destructor
void ProcessXmlDocument (xmlDocPtr theDoc)
 SALOME_ModuleCatalogImpl (int artgc, char **argv, CORBA::ORB_ptr orb=NULL)
 standard constructor
virtual ~SALOME_ModuleCatalogImpl ()
 standard destructor
virtual
SALOME_ModuleCatalog::ListOfComputers
GetComputerList ()
 method to get a component list
virtual
SALOME_ModuleCatalog::ListOfTypeDefinition
GetTypes ()
 method to get the list of all types of the catalog
virtual char * GetPathPrefix (const char *machinename)
 method to get the PathPrefix of a computer
virtual void ImportXmlCatalogFile (const char *xmlFileName)
 method to read a XML file and import new components into the component list
virtual
SALOME_ModuleCatalog::ListOfComponents
GetComponentList ()
 method to get a component list
virtual
SALOME_ModuleCatalog::ListOfIAPP_Affich
GetComponentIconeList ()
 method to get a component list of component name and component icone
virtual
SALOME_ModuleCatalog::ListOfComponents
GetTypedComponentList (SALOME_ModuleCatalog::ComponentType component_type)
 method to get a component list of a wanted type
virtual
SALOME_ModuleCatalog::Acomponent_ptr 
GetComponent (const char *componentname)
 method to get a component
virtual
SALOME_ModuleCatalog::ComponentDef
GetComponentInfo (const char *name)
 method to get a component description
void ping ()
CORBA::Long getPID ()
void ShutdownWithExit ()
void shutdown ()

Private Member Functions

void duplicate (SALOME_ModuleCatalog::DefinitionInterface &I_out, const SALOME_ModuleCatalog::DefinitionInterface &I_in)
 method to duplicate an interface
void duplicate (SALOME_ModuleCatalog::Service &S_out, const SALOME_ModuleCatalog::Service &S_in)
 method to duplicate a service
void duplicate (SALOME_ModuleCatalog::ServicesParameter &P_out, const SALOME_ModuleCatalog::ServicesParameter &P_in)
 method to duplicate a parameter
void duplicate (SALOME_ModuleCatalog::ServicesDataStreamParameter &P_out, const SALOME_ModuleCatalog::ServicesDataStreamParameter &P_in)
 method to duplicate a parameter
virtual void _parse_xml_file (const char *file, ParserComponents &modulelist, ParserPathPrefixes &pathlist, ParserTypes &typeMap, TypeList &typeList)
 method to parse one module catalog
ParserComponentfindComponent (const std::string &name)
 method to find component in the parser list
void duplicate (SALOME_ModuleCatalog::ComponentDef &C_corba, const ParserComponent &C_parser)
 method to create a CORBA component description from parser
void duplicate (SALOME_ModuleCatalog::DefinitionInterface &I_corba, const ParserInterface &I_parser)
 method to create a CORBA interface description from parser
void duplicate (SALOME_ModuleCatalog::Service &S_corba, const ParserService &service)
 method to create a CORBA service description from parser
void duplicate (SALOME_ModuleCatalog::ServicesParameter &P_corba, const ParserParameter &P_parser)
 method to create a CORBA parameter description from parser
void duplicate (SALOME_ModuleCatalog::ServicesDataStreamParameter &P_corba, const ParserDataStreamParameter &P_parser)
 method to create a CORBA datastream parameter description from parser
void duplicate (ParserPathPrefixes &p_out, const ParserPathPrefixes &P_in)
 method to create the path prefix structures from the catalog parsing
virtual bool _verify_path_prefix (ParserPathPrefixes &pathlist)
 method to verify path prefix content
virtual bool _parseArguments (int argc, char **argv, char **_general, char **_personal)
 method to parse arguments to get general and personal catalog files

Private Attributes

SALOME_ModuleCatalog::ComponentDef _Component
const char * test_path_prefix_name
const char * test_computer_name
const char * test_computer_list
const char * test_path_prefix
const char * test_path_prefix_list
const char * test_component_name
const char * test_component_username
const char * test_component_type
const char * test_component_multistudy
const char * test_component_icon
const char * test_component_impltype
const char * test_component_implname
const char * test_component_version
const char * test_component_comment
const char * test_interface_name
const char * test_service_name
const char * test_defaultservice
const char * test_typeofnode
const char * test_inParameter_type
const char * test_inParameter_name
const char * test_inParameter
const char * test_inParameter_list
const char * test_outParameter_type
const char * test_outParameter_name
const char * test_outParameter
const char * test_outParameter_list
const char * test_inDataStreamParameter_type
const char * test_inDataStreamParameter_name
const char * test_inDataStreamParameter_dependency
const char * test_inDataStreamParameter
const char * test_inDataStreamParameter_list
const char * test_outDataStreamParameter_type
const char * test_outDataStreamParameter_name
const char * test_outDataStreamParameter_dependency
const char * test_outDataStreamParameter
const char * test_outDataStreamParameter_list
const char * test_service
const char * test_service_list
const char * test_interface_list
const char * test_constraint
const char * test_component_list
const char * test_component
ParserPathPrefix _pathPrefix
ParserComponent _aModule
ParserPathPrefixes_pathList
ParserComponents_moduleList
ParserInterfaces _interfaceList
ParserInterface _aInterface
ParserServices _serviceList
ParserService _aService
ParserParameters _inParamList
ParserParameter _inParam
ParserParameters _outParamList
ParserParameter _outParam
ParserDataStreamParameters _inDataStreamParamList
ParserDataStreamParameter _inDataStreamParam
ParserDataStreamParameters _outDataStreamParamList
ParserDataStreamParameter _outDataStreamParam
ParserTypes_typeMap
TypeList_typeList
ParserSequences _sequenceMap
ParserObjrefs _objrefMap
ParserStructs _structMap
char * _general_path
char * _personal_path
ParserComponents _general_module_list
ParserPathPrefixes _general_path_list
ParserTypes _typeMap
TypeList _typeList
ParserComponents _personal_module_list
ParserPathPrefixes _personal_path_list
std::map< std::string,
SALOME_ModuleCatalog::DataStreamDependency
DataStreamDepConvert
std::map< ParserComponentType,
SALOME_ModuleCatalog::ComponentType
ComponentTypeConvert
CORBA::ORB_ptr _orb

Detailed Description

Definition at line 44 of file SALOME_ModuleCatalog_Acomponent_impl.hxx.


Constructor & Destructor Documentation

standard destructor

standard destructor

standard destructor


Member Function Documentation

virtual void MODULECATALOG_EXPORT::_parse_xml_file ( const char *  file,
ParserComponents modulelist,
ParserPathPrefixes pathlist,
ParserTypes typeMap,
TypeList typeList 
) [private, virtual]

method to parse one module catalog

Parameters:
fileconst char* arguments
modulelistParserComponents arguments
pathlistParserPathPrefixes arguments
typeMapParserTypes arguments
virtual bool MODULECATALOG_EXPORT::_parseArguments ( int  argc,
char **  argv,
char **  _general,
char **  _personal 
) [private, virtual]

method to parse arguments to get general and personal catalog files

Parameters:
argcint arguments
argvchar** arguments
_generalchar** arguments
Returns:
true if parsing is OK
virtual bool MODULECATALOG_EXPORT::_verify_path_prefix ( ParserPathPrefixes pathlist) [private, virtual]

method to verify path prefix content

Parameters:
pathlistListOfParserPathPrefix arguments
Returns:
true if verfication is OK
virtual char* MODULECATALOG_EXPORT::component_icone ( ) [virtual]

method to obtain the component icone (for IAPP)

Returns:
the component icon

method to define the type of the component

Returns:
the component type
virtual char* MODULECATALOG_EXPORT::componentname ( ) [virtual]

method to obtain the componentname

Returns:
the component name
virtual char* MODULECATALOG_EXPORT::componentusername ( ) [virtual]

method to obtain the componentusername

Returns:
the component user name
virtual char* MODULECATALOG_EXPORT::constraint ( ) [virtual]

method to obtain the constraint affected to a component

to be resolved by LifeCycle for the computer choice

Returns:
the constraint
void MODULECATALOG_EXPORT::duplicate ( SALOME_ModuleCatalog::ComponentDef C_corba,
const ParserComponent C_parser 
) [private]

method to create a CORBA component description from parser

Parameters:
C_corbaComponent argument
C_parserconst ParserComponent argument

method to create a CORBA interface description from parser

Parameters:
I_corbaDefinitionInterface argument
I_parserconst ParserInterface argument

method to duplicate an interface

Parameters:
serviceSALOME_ModuleCatalog::DefinitionInterface arguments
Returns:
the interface
void MODULECATALOG_EXPORT::duplicate ( SALOME_ModuleCatalog::Service S_corba,
const ParserService service 
) [private]

method to create a CORBA service description from parser

Parameters:
S_corbaService argument
S_parserconst ParserService argument

method to duplicate a service

Parameters:
serviceSALOME_ModuleCatalog::Service arguments
Returns:
the service
void MODULECATALOG_EXPORT::duplicate ( SALOME_ModuleCatalog::ServicesParameter P_corba,
const ParserParameter P_parser 
) [private]

method to create a CORBA parameter description from parser

Parameters:
P_corbaServicesParameter argument
P_parserconst ParserParameter argument

method to duplicate a parameter

Parameters:
parameterSALOME_ModuleCatalog::ServicesParameter arguments
Returns:
the parameter

method to create a CORBA datastream parameter description from parser

Parameters:
P_corbaServicesDataStreamParameter argument
P_parserconst ParserDataStreamParameter argument
void MODULECATALOG_EXPORT::duplicate ( ParserPathPrefixes p_out,
const ParserPathPrefixes P_in 
) [private]

method to create the path prefix structures from the catalog parsing

Parameters:
pathesParserPathPrefixes arguments
Returns:
the pathes

method to duplicate a parameter

Parameters:
parameterSALOME_ModuleCatalog::ServicesDataStreamParameter arguments
Returns:
the parameter
ParserComponent* MODULECATALOG_EXPORT::findComponent ( const std::string &  name) [private]

method to find component in the parser list

Parameters:
namestring argument
Returns:
pointer on a component, NULL if not found
virtual SALOME_ModuleCatalog::Acomponent_ptr MODULECATALOG_EXPORT::GetComponent ( const char *  componentname) [virtual]

method to get a component

Parameters:
componentnameconst char* arguments
Returns:
the wanted component

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

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

method to get a component description

Parameters:
componentnameconst char* arguments
Returns:
the wanted component description

method to get a component list

Returns:
a component list

method to get a component list

Returns:
a component list

method to get the default service of an interface of a component

If the specified interface doesn't exist, the Notfound exception is thrown

Parameters:
interfacenameconst char* arguments
Returns:
the default service of the interface

method to get one interface of a component

If the specified interface doesn't exist, the Notfound exception is thrown

Parameters:
interfacename const car* arguments
Returns:
the wanted interface

method to get a list of the interfaces name of a component

Returns:
a list of the interfaces of a component
virtual char* MODULECATALOG_EXPORT::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
virtual char* MODULECATALOG_EXPORT::GetPathPrefix ( const char *  machinename) throw (SALOME_ModuleCatalog::NotFound) [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
virtual SALOME_ModuleCatalog::Service* MODULECATALOG_EXPORT::GetService ( const char *  interfacename,
const char *  servicename 
) throw (SALOME_ModuleCatalog::NotFound) [virtual]

method to get one service of an interface of a component

If the wanted service or the specified interface don't exist, the Notfound exception is thrown

Parameters:
interfacenameconst char* arguments
servicenameconst char* arguments
Returns:
the wanted service

method to get a list of the services name of an interface of a component

If the specified interface doesn't exist, the Notfound exception is thrown

Parameters:
interfacenameconst char* arguments
Returns:
a list of the services of the wanted interface

method to get a component list of a wanted type

Returns:
a component list

method to get the list of all types of the catalog

Returns:
the types list
virtual char* MODULECATALOG_EXPORT::implementation_name ( ) [virtual]

method to obtain the implementation name of the component if the default one is not convenient

Returns:
the implementation name to exec

method to define if a component is implemented in a dyn lib a python module or an executable

Returns:
an enum SO or PY or EXE or CEXE
virtual void MODULECATALOG_EXPORT::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
virtual CORBA::Boolean MODULECATALOG_EXPORT::multistudy ( ) [virtual]

method to define if a component can be multistudy or not

Returns:
true if the component supports multistudy
void MODULECATALOG_EXPORT::ping ( ) [inline]

Definition at line 116 of file SALOME_ModuleCatalog_impl.hxx.

{};
void MODULECATALOG_EXPORT::ProcessXmlDocument ( xmlDocPtr  theDoc)

standard constructor

standard constructor

MODULECATALOG_EXPORT::SALOME_ModuleCatalogImpl ( int  artgc,
char **  argv,
CORBA::ORB_ptr  orb = NULL 
)

standard constructor

void MODULECATALOG_EXPORT::shutdown ( ) [inline]

Definition at line 120 of file SALOME_ModuleCatalog_impl.hxx.

{ if(!CORBA::is_nil(_orb)) _orb->shutdown(0); };

Member Data Documentation

Definition at line 119 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 113 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 122 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 157 of file SALOME_ModuleCatalog_Acomponent_impl.hxx.

Definition at line 215 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 210 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 216 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 131 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 130 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 125 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 124 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 118 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 116 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 140 of file SALOME_ModuleCatalog_Handler.hxx.

CORBA::ORB_ptr MODULECATALOG_EXPORT::_orb [private]

Definition at line 230 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 134 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 133 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 128 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 127 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 115 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 111 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 221 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 211 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 222 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 139 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 121 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 141 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 137 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 218 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 136 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 217 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 228 of file SALOME_ModuleCatalog_impl.hxx.

Definition at line 225 of file SALOME_ModuleCatalog_impl.hxx.

const char* MODULECATALOG_EXPORT::test_component [private]

Definition at line 109 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 73 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 69 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 71 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 70 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 108 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 68 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 65 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 67 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 66 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 72 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 61 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 60 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 106 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 78 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 94 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 93 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 95 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 92 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 91 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 83 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 84 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 82 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 81 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 105 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 75 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 100 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 99 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 101 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 98 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 97 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 88 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 89 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 87 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 86 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 62 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 63 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 59 of file SALOME_ModuleCatalog_Handler.hxx.

const char* MODULECATALOG_EXPORT::test_service [private]

Definition at line 103 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 104 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 77 of file SALOME_ModuleCatalog_Handler.hxx.

Definition at line 79 of file SALOME_ModuleCatalog_Handler.hxx.


The documentation for this protocol was generated from the following files: