Version: 9.12.0
SalomeApp_Engine_i Class Reference

#include <SalomeApp_Engine_i.h>

Inheritance diagram for SalomeApp_Engine_i:
Inheritance graph

Public Types

typedef std::vector< std::string > ListOfFiles
 
typedef std::map< int, ListOfFilesMapOfFiles
 

Public Member Functions

 SalomeApp_Engine_i (const char *theComponentName)
 
 ~SalomeApp_Engine_i ()
 
SALOMEDS::TMPFile * Save (SALOMEDS::SComponent_ptr theComponent, const char *theURL, bool isMultiFile)
 
CORBA::Boolean Load (SALOMEDS::SComponent_ptr theComponent, const SALOMEDS::TMPFile &theFile, const char *theURL, bool isMultiFile)
 
virtual Engines::TMPFile * DumpPython (CORBA::Boolean isPublished, CORBA::Boolean isMultiFile, CORBA::Boolean &isValidScript)
 
ListOfFiles GetListOfFiles (int)
 
void SetListOfFiles (int, const ListOfFiles &theListOfFiles)
 
SALOMEDS::TMPFile * SaveASCII (SALOMEDS::SComponent_ptr, const char *, bool)
 
CORBA::Boolean LoadASCII (SALOMEDS::SComponent_ptr, const SALOMEDS::TMPFile &, const char *, bool)
 
void Close (SALOMEDS::SComponent_ptr)
 
char * ComponentDataType ()
 
char * IORToLocalPersistentID (SALOMEDS::SObject_ptr, const char *, CORBA::Boolean, CORBA::Boolean)
 
char * LocalPersistentIDToIOR (SALOMEDS::SObject_ptr, const char *, CORBA::Boolean, CORBA::Boolean)
 
bool CanPublishInStudy (CORBA::Object_ptr)
 
SALOMEDS::SObject_ptr PublishInStudy (SALOMEDS::SObject_ptr, CORBA::Object_ptr, const char *)
 
CORBA::Boolean CanCopy (SALOMEDS::SObject_ptr)
 
SALOMEDS::TMPFile * CopyFrom (SALOMEDS::SObject_ptr, CORBA::Long &)
 
CORBA::Boolean CanPaste (const char *, CORBA::Long)
 
SALOMEDS::SObject_ptr PasteInto (const SALOMEDS::TMPFile &, CORBA::Long, SALOMEDS::SObject_ptr)
 
bool keepFiles () const
 
void keepFiles (bool keep)
 
char * getVersion ()
 

Static Public Member Functions

static std::string EngineIORForComponent (const char *theComponentName, bool toCreate)
 
static SalomeApp_Engine_iGetInstance (const char *theComponentName, bool toCreate)
 
static CORBA::Object_ptr EngineForComponent (const char *theComponentName, bool toCreate)
 

Static Private Member Functions

static CORBA::ORB_var orb ()
 
static PortableServer::POA_var poa ()
 
static SALOME_NamingService_Abstract * namingService ()
 

Private Attributes

MapOfFiles myListOfFiles
 
bool myKeepFiles
 
QString myComponentName
 

Member Typedef Documentation

◆ ListOfFiles

typedef std::vector<std::string> SalomeApp_Engine_i::ListOfFiles

◆ MapOfFiles

Constructor & Destructor Documentation

◆ SalomeApp_Engine_i()

SalomeApp_Engine_i::SalomeApp_Engine_i ( const char *  theComponentName)

Constructor

References myComponentName.

◆ ~SalomeApp_Engine_i()

SalomeApp_Engine_i::~SalomeApp_Engine_i ( )

Destructor

References myComponentName.

Member Function Documentation

◆ CanCopy()

CORBA::Boolean SalomeApp_Engine_i::CanCopy ( SALOMEDS::SObject_ptr  )
inline

◆ CanPaste()

CORBA::Boolean SalomeApp_Engine_i::CanPaste ( const char *  ,
CORBA::Long   
)
inline

◆ CanPublishInStudy()

bool SalomeApp_Engine_i::CanPublishInStudy ( CORBA::Object_ptr  )
inline

◆ Close()

void SalomeApp_Engine_i::Close ( SALOMEDS::SComponent_ptr  )
inline

◆ ComponentDataType()

char * SalomeApp_Engine_i::ComponentDataType ( )
Returns
Component data type string for this instance of the engine

References myComponentName.

◆ CopyFrom()

SALOMEDS::TMPFile* SalomeApp_Engine_i::CopyFrom ( SALOMEDS::SObject_ptr  ,
CORBA::Long &   
)
inline

◆ DumpPython()

Engines::TMPFile * SalomeApp_Engine_i::DumpPython ( CORBA::Boolean  isPublished,
CORBA::Boolean  isMultiFile,
CORBA::Boolean &  isValidScript 
)
virtual

DumpPython implementation for light modules

References GetListOfFiles(), and myComponentName.

◆ EngineForComponent()

CORBA::Object_ptr SalomeApp_Engine_i::EngineForComponent ( const char *  theComponentName,
bool  toCreate 
)
static

Internal method, creates a CORBA engine for a light SALOME module with the given "component data type" string, activates it and registers in SALOME naming service with /SalomeAppEngine/comp_data_type path. If the engine is already in the naming service, simply returns and object reference to it.

Parameters
theComponentName- synthetic "component data type" used to identify a given light module
Returns
Object reference to the CORBA engine

References CAM_Application::moduleTitle(), namingService(), poa(), and SalomeApp_Engine_i().

◆ EngineIORForComponent()

std::string SalomeApp_Engine_i::EngineIORForComponent ( const char *  theComponentName,
bool  toCreate 
)
static
Parameters
theComponentName- synthetic "component data type" used to identify a given light module
Returns
IOR string for the CORBA engine for a light SALOME module with the given "component data type" string
See also
GetInstance( const char* theComponentName )

References EngineForComponent(), and orb().

◆ GetInstance()

SalomeApp_Engine_i * SalomeApp_Engine_i::GetInstance ( const char *  theComponentName,
bool  toCreate 
)
static
Parameters
theComponentName- synthetic "component data type" used to identify a given light module
Returns
A pointer to corresponding C++ engine instance, null means some internal problems.
See also
EngineIORForComponent( const char* theComponentName )

References EngineForComponent(), and poa().

◆ GetListOfFiles()

SalomeApp_Engine_i::ListOfFiles SalomeApp_Engine_i::GetListOfFiles ( int  type)

References myListOfFiles.

◆ getVersion()

◆ IORToLocalPersistentID()

char* SalomeApp_Engine_i::IORToLocalPersistentID ( SALOMEDS::SObject_ptr  ,
const char *  ,
CORBA::Boolean  ,
CORBA::Boolean   
)
inline

◆ keepFiles() [1/2]

bool SalomeApp_Engine_i::keepFiles ( ) const
inline

◆ keepFiles() [2/2]

void SalomeApp_Engine_i::keepFiles ( bool  keep)
inline

◆ Load()

CORBA::Boolean SalomeApp_Engine_i::Load ( SALOMEDS::SComponent_ptr  theComponent,
const SALOMEDS::TMPFile &  theFile,
const char *  theURL,
bool  isMultiFile 
)

< TODO: conversion from size_t to int

References keepFiles(), myComponentName, and SetListOfFiles().

◆ LoadASCII()

CORBA::Boolean SalomeApp_Engine_i::LoadASCII ( SALOMEDS::SComponent_ptr  ,
const SALOMEDS::TMPFile &  ,
const char *  ,
bool   
)
inline

◆ LocalPersistentIDToIOR()

char* SalomeApp_Engine_i::LocalPersistentIDToIOR ( SALOMEDS::SObject_ptr  ,
const char *  ,
CORBA::Boolean  ,
CORBA::Boolean   
)
inline

◆ namingService()

SALOME_NamingService_Abstract * SalomeApp_Engine_i::namingService ( )
staticprivate

◆ orb()

CORBA::ORB_var SalomeApp_Engine_i::orb ( )
staticprivate

◆ PasteInto()

SALOMEDS::SObject_ptr SalomeApp_Engine_i::PasteInto ( const SALOMEDS::TMPFile &  ,
CORBA::Long  ,
SALOMEDS::SObject_ptr   
)
inline

◆ poa()

PortableServer::POA_var SalomeApp_Engine_i::poa ( )
staticprivate
Returns

References orb().

◆ PublishInStudy()

SALOMEDS::SObject_ptr SalomeApp_Engine_i::PublishInStudy ( SALOMEDS::SObject_ptr  ,
CORBA::Object_ptr  ,
const char *   
)
inline

◆ Save()

SALOMEDS::TMPFile * SalomeApp_Engine_i::Save ( SALOMEDS::SComponent_ptr  theComponent,
const char *  theURL,
bool  isMultiFile 
)

◆ SaveASCII()

SALOMEDS::TMPFile* SalomeApp_Engine_i::SaveASCII ( SALOMEDS::SComponent_ptr  ,
const char *  ,
bool   
)
inline

◆ SetListOfFiles()

void SalomeApp_Engine_i::SetListOfFiles ( int  type,
const ListOfFiles theListOfFiles 
)

References myListOfFiles.

Member Data Documentation

◆ myComponentName

QString SalomeApp_Engine_i::myComponentName
private

◆ myKeepFiles

bool SalomeApp_Engine_i::myKeepFiles
private

◆ myListOfFiles

MapOfFiles SalomeApp_Engine_i::myListOfFiles
private

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