SALOME_ModuleCatalog Namespace Reference

The main package of interfaces used for the module catalog in SALOME application. More...

Data Structures
struct	ServicesParameter
	This struct contains fields defining the parameter of the service. More...
struct	ServicesDataStreamParameter
	struct to define datastream ports More...
struct	MemberDefinition
	struct to define members of a Struc TypeKind More...
struct	TypeDefinition
	Struct to get the definition of types used in Salome catalogs. More...
struct	Service
	This struct contains fields defining each service. More...
struct	DefinitionInterface
	This struct contains fields defining each interface. More...
struct	PathPrefix
	PathPrefix : association of a machine name and a path to a component. More...
struct	ComponentDef
	Description of a component. More...
struct	IAPP_Affich
	This struct contains GUI elements used for representation of the module in IAPP component. More...
exception	NotFound
	This exception is raised when a component, a service or a pathPrefix is not found. More...
interface	Acomponent
	This interface provides the common functionality information of corresponding component. More...
interface	ModuleCatalog
	Module catalog interface More...

Typedefs
typedef sequence < ServicesParameter >	ListOfServicesParameter
	The list of the parameters of service. More...
typedef sequence < ServicesDataStreamParameter >	ListOfServicesDataStreamParameter
	The list of datastream parameters of service. More...
typedef sequence< string >	ListOfString
	a string list More...
typedef sequence < MemberDefinition >	ListOfMemberDefinition
	List of member definitions in a structure. More...
typedef sequence< TypeDefinition >	ListOfTypeDefinition
	list of type definitions More...
typedef sequence< Service >	ListOfInterfaceService
	List of services of the interface. More...
typedef sequence< string >	ListOfServices
	List of services. More...
typedef sequence < DefinitionInterface >	ListOfDefInterface
	List of interface definitions. More...
typedef sequence< string >	ListOfInterfaces
	List of interface names. More...
typedef sequence< PathPrefix >	PathPrefixes
	List of path prefixes. More...
typedef sequence< string >	ListOfComponents
	List of component names. More...
typedef sequence< string >	ListOfComputers
	List of computer names. More...
typedef sequence< IAPP_Affich >	ListOfIAPP_Affich
	List of pair GUI elements (component name, component icone) More...

Enumerations
enum	ComponentType {   GEOM, MESH, Med, SOLVER,   DATA, VISU, SUPERV, OTHER }
	This enumeration contains a current set of definitions of the components integrated into SALOME application. More...
enum	DataStreamDependency { DATASTREAM_UNDEFINED, DATASTREAM_TEMPORAL, DATASTREAM_ITERATIVE }
	enumeration to define datastream ports dependency More...
enum	TypeKind {   NONE, Dble, Int, Str,   Bool, Objref, Seq, Array,   Struc }
	enumeration to define data types used by services More...
enum	ImplType { SO, PY, EXE, CEXE }
	Component implementation type. More...

Detailed Description

The main package of interfaces used for the module catalog in SALOME application.

Module catalog allows to manage components of SALOME application, to call specified in the xml files interfaces with the help of AComponent interface.

Typedef Documentation

typedef sequence<ServicesParameter> SALOME_ModuleCatalog::ListOfServicesParameter

The list of the parameters of service.

typedef sequence<ServicesDataStreamParameter> SALOME_ModuleCatalog::ListOfServicesDataStreamParameter

The list of datastream parameters of service.

typedef sequence<string> SALOME_ModuleCatalog::ListOfString

a string list

typedef sequence<MemberDefinition> SALOME_ModuleCatalog::ListOfMemberDefinition

List of member definitions in a structure.

typedef sequence<TypeDefinition> SALOME_ModuleCatalog::ListOfTypeDefinition

list of type definitions

typedef sequence<Service> SALOME_ModuleCatalog::ListOfInterfaceService

List of services of the interface.

typedef sequence<string> SALOME_ModuleCatalog::ListOfServices

List of services.

typedef sequence<DefinitionInterface> SALOME_ModuleCatalog::ListOfDefInterface

List of interface definitions.

typedef sequence<string> SALOME_ModuleCatalog::ListOfInterfaces

List of interface names.

typedef sequence<PathPrefix> SALOME_ModuleCatalog::PathPrefixes

List of path prefixes.

typedef sequence<string> SALOME_ModuleCatalog::ListOfComponents

List of component names.

typedef sequence<string> SALOME_ModuleCatalog::ListOfComputers

List of computer names.

typedef sequence<IAPP_Affich> SALOME_ModuleCatalog::ListOfIAPP_Affich

List of pair GUI elements (component name, component icone)

used for representation of the module in IAPP component.

Enumeration Type Documentation

enum SALOME_ModuleCatalog::ComponentType

This enumeration contains a current set of definitions of the components integrated into SALOME application.

Enumerator
GEOM	Module GEOM
MESH	Module MESH
Med	Module Med
SOLVER	Module of SOLVER type
DATA	Module DATA
VISU	Module VISU
SUPERV	Module SUPERVISION
OTHER	Any other type of module

enum SALOME_ModuleCatalog::DataStreamDependency

enumeration to define datastream ports dependency

Enumerator
DATASTREAM_UNDEFINED	dependency not defined
DATASTREAM_TEMPORAL	time dependency
DATASTREAM_ITERATIVE	iterative dependency

enum SALOME_ModuleCatalog::TypeKind

enumeration to define data types used by services

Enumerator
Dble	a double
Int	an integer
Str	a string
Bool	a boolean
Objref	an object reference
Seq	a sequence of a content type
Array	an array
Struc	a structure with named members

enum SALOME_ModuleCatalog::ImplType

Component implementation type.

Enumerator
SO	component implemented as a dynamic library loadable with dlopen
PY	component implemented as a python module loadable with import
EXE	component implemented as an executable
CEXE	component to be loaded by a container which executable is given in the catalog