Back to index

salome-kernel  6.5.0
Classes | Typedefs | Enumerations
SALOME_ModuleCatalog Namespace Reference

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

Classes

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.
typedef sequence
< ServicesDataStreamParameter
ListOfServicesDataStreamParameter
 The list of datastream parameters of service.
typedef sequence< string > ListOfString
 a string list
typedef sequence
< MemberDefinition
ListOfMemberDefinition
 List of member definitions in a structure.
typedef sequence< TypeDefinitionListOfTypeDefinition
 list of type definitions
typedef sequence< ServiceListOfInterfaceService
 List of services of the interface.
typedef sequence< string > ListOfServices
 List of services.
typedef sequence
< DefinitionInterface
ListOfDefInterface
 List of interface definitions.
typedef sequence< string > ListOfInterfaces
 List of interface names.
typedef sequence< PathPrefixPathPrefixes
 List of path prefixes.
typedef sequence< string > ListOfComponents
 List of component names.
typedef sequence< string > ListOfComputers
 List of computer names.
typedef sequence< IAPP_AffichListOfIAPP_Affich
 List of pair GUI elements (component name, component icone)

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.


Class Documentation

struct SALOME_ModuleCatalog::ServicesParameter

This struct contains fields defining the parameter of the service.

Definition at line 52 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::ServicesParameter:
Class Members
string Parametername Parameter name.
string Parametertype Parameter type name.
struct SALOME_ModuleCatalog::ServicesDataStreamParameter

struct to define datastream ports

Definition at line 66 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::ServicesDataStreamParameter:
Class Members
DataStreamDependency Parameterdependency Temporal or iterative dependency.
string Parametername Parameter name.
string Parametertype Parameter type name.
struct SALOME_ModuleCatalog::MemberDefinition

struct to define members of a Struc TypeKind

Definition at line 96 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::MemberDefinition:
Class Members
string name Member name.
string type Member type name.
struct SALOME_ModuleCatalog::TypeDefinition

Struct to get the definition of types used in Salome catalogs.

Definition at line 105 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::TypeDefinition:
Class Members
ListOfString bases base types (if needed)
string content Content type (if needed)
string id id (if needed)
TypeKind kind Type kind.
ListOfMemberDefinition members Member types (if needed)
string name Type name.
struct SALOME_ModuleCatalog::Service

This struct contains fields defining each service.

Definition at line 119 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::Service:
Class Members
boolean Servicebydefault True if the service is taken with its default fields.
ListOfServicesDataStreamParameter ServiceinDataStreamParameter List of input parameters of the services.
ListOfServicesParameter ServiceinParameter List of input parameters of the services.
string ServiceName Name of the service.
ListOfServicesDataStreamParameter ServiceoutDataStreamParameter List of output parameters of the services.
ListOfServicesParameter ServiceoutParameter List of output parameters of the services.
boolean TypeOfNode True is the service is a factory node. Otherwise, it's a compute node.
struct SALOME_ModuleCatalog::DefinitionInterface

This struct contains fields defining each interface.

Definition at line 134 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::DefinitionInterface:
Class Members
string interfacename Name of the interface.
ListOfInterfaceService interfaceservicelist List of services of the interface.
struct SALOME_ModuleCatalog::PathPrefix

PathPrefix : association of a machine name and a path to a component.

Definition at line 147 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::PathPrefix:
Class Members
string machine
string path
struct SALOME_ModuleCatalog::ComponentDef

Description of a component.

Definition at line 164 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::ComponentDef:
Class Members
string constraint
string icon
ImplType implementationType
string implname
ListOfDefInterface interfaces
boolean multistudy
string name
PathPrefixes paths
ComponentType type
string username
struct SALOME_ModuleCatalog::IAPP_Affich

This struct contains GUI elements used for representation of the module in IAPP component.

Definition at line 183 of file SALOME_ModuleCatalog.idl.

Collaboration diagram for SALOME_ModuleCatalog::IAPP_Affich:
Class Members
string modulecomment Comment to the module.
string moduleicone Icone representing the module.
string modulename Name of the module.
string moduleusername UserName of the module.
string moduleversion Version of the module.

Typedef Documentation

typedef sequence<string> SALOME_ModuleCatalog::ListOfComponents

List of component names.

Definition at line 179 of file SALOME_ModuleCatalog.idl.

typedef sequence<string> SALOME_ModuleCatalog::ListOfComputers

List of computer names.

Definition at line 181 of file SALOME_ModuleCatalog.idl.

List of interface definitions.

Definition at line 140 of file SALOME_ModuleCatalog.idl.

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

used for representation of the module in IAPP component.

Definition at line 195 of file SALOME_ModuleCatalog.idl.

typedef sequence<string> SALOME_ModuleCatalog::ListOfInterfaces

List of interface names.

Definition at line 142 of file SALOME_ModuleCatalog.idl.

List of services of the interface.

Definition at line 130 of file SALOME_ModuleCatalog.idl.

List of member definitions in a structure.

Definition at line 102 of file SALOME_ModuleCatalog.idl.

typedef sequence<string> SALOME_ModuleCatalog::ListOfServices

List of services.

Definition at line 132 of file SALOME_ModuleCatalog.idl.

The list of datastream parameters of service.

Definition at line 76 of file SALOME_ModuleCatalog.idl.

The list of the parameters of service.

Definition at line 74 of file SALOME_ModuleCatalog.idl.

typedef sequence<string> SALOME_ModuleCatalog::ListOfString

a string list

Definition at line 79 of file SALOME_ModuleCatalog.idl.

list of type definitions

Definition at line 116 of file SALOME_ModuleCatalog.idl.

List of path prefixes.

Definition at line 153 of file SALOME_ModuleCatalog.idl.


Enumeration Type Documentation

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.

Definition at line 42 of file SALOME_ModuleCatalog.idl.

enumeration to define datastream ports dependency

Enumerator:
DATASTREAM_UNDEFINED 

dependency not defined

DATASTREAM_TEMPORAL 

time dependency

DATASTREAM_ITERATIVE 

iterative dependency

Definition at line 59 of file SALOME_ModuleCatalog.idl.

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

Definition at line 156 of file SALOME_ModuleCatalog.idl.

                {
    SO,                       
    PY,                       
    EXE,                      
    CEXE                      
  } ;

enumeration to define data types used by services

Enumerator:
NONE 
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

Definition at line 82 of file SALOME_ModuleCatalog.idl.

  {
    NONE     ,
    Dble   , 
    Int      , 
    Str   , 
    Bool     , 
    Objref   , 
    Seq , 
    Array    , 
    Struc  
  };