Back to index

salome-kernel  6.5.0
Classes | Namespaces | Typedefs | Enumerations
SALOME_ModuleCatalog.idl File Reference

interfaces used for getting information from module catalog in SALOME application More...

Go to the source code of this file.

Classes

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

Namespaces

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

Typedefs

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< PathPrefixSALOME_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)

Enumerations

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

Detailed Description

interfaces used for getting information from module catalog in SALOME application

Definition in file SALOME_ModuleCatalog.idl.


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.