Version: 8.3.0
SALOMEDS_StudyManager_i Class Reference

#include <SALOMEDS_StudyManager_i.hxx>

Inheritance diagram for SALOMEDS_StudyManager_i:

Public Member Functions

 SALOMEDS_StudyManager_i (CORBA::ORB_ptr orb, PortableServer::POA_ptr thePOA)
 standard constructor More...
 
virtual ~SALOMEDS_StudyManager_i ()
 standard destructor More...
 
void register_name (const char *name)
 method to Register study Manager in the naming service More...
 
virtual SALOMEDS::Study_ptr NewStudy (const char *study_name) throw (SALOME::SALOME_Exception)
 method to Create a New Study of name study_name More...
 
virtual SALOMEDS::Study_ptr Open (const char *aStudyUrl) throw (SALOME::SALOME_Exception)
 method to Open a Study from it's persistent reference More...
 
virtual void Close (SALOMEDS::Study_ptr aStudy)
 method to close a Study More...
 
virtual CORBA::Boolean Save (SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile)
 method to save a Study More...
 
virtual CORBA::Boolean SaveASCII (SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile)
 
virtual CORBA::Boolean SaveAs (const char *aUrl, SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile)
 method to save a Study to the persistent reference aUrl More...
 
virtual CORBA::Boolean SaveAsASCII (const char *aUrl, SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile)
 
virtual
SALOMEDS::ListOfOpenStudies
GetOpenStudies ()
 method to Get name list of open studies in the session More...
 
virtual SALOMEDS::Study_ptr GetStudyByName (const char *aStudyName)
 method to get a Study from it's name More...
 
virtual SALOMEDS::Study_ptr GetStudyByID (CORBA::Short aStudyID)
 method to get a Study from it's ID More...
 
virtual CORBA::Boolean CanCopy (SALOMEDS::SObject_ptr theObject)
 Function : CanCopy Purpose : More...
 
virtual CORBA::Boolean Copy (SALOMEDS::SObject_ptr theObject)
 Function : Copy Purpose : More...
 
virtual CORBA::Boolean CanPaste (SALOMEDS::SObject_ptr theObject)
 Function : CanPaste Purpose : More...
 
virtual SALOMEDS::SObject_ptr Paste (SALOMEDS::SObject_ptr theObject) throw (SALOMEDS::StudyBuilder::LockProtection)
 Function : Paste Purpose : More...
 
virtual charConvertObjectToIOR (CORBA::Object_ptr theObject)
 
virtual CORBA::Object_ptr ConvertIORToObject (const char *theIOR)
 
void ping ()
 
CORBA::Long getPID ()
 
void ShutdownWithExit ()
 
virtual CORBA::LongLong GetLocalImpl (const char *theHostname, CORBA::Long thePID, CORBA::Boolean &isLocal)
 
void Shutdown ()
 

Static Public Member Functions

static PortableServer::POA_ptr GetPOA (const SALOMEDS::Study_ptr theStudy)
 

Private Attributes

CORBA::ORB_var _orb
 
PortableServer::POA_var _poa
 
SALOMEDSImpl_StudyManager_impl
 
SALOME_NamingService_name_service
 
SALOMEDS_DriverFactory_i_factory
 

Constructor & Destructor Documentation

SALOMEDS_StudyManager_i::SALOMEDS_StudyManager_i ( CORBA::ORB_ptr  orb,
PortableServer::POA_ptr  thePOA 
)

standard constructor

Function : SALOMEDS_StudyManager_i Purpose : SALOMEDS_StudyManager_i constructor.

References _factory, _impl, _name_service, _orb, _poa, and SALOME_NamingService::Create_Directory().

SALOMEDS_StudyManager_i::~SALOMEDS_StudyManager_i ( )
virtual

standard destructor

Function : ~SALOMEDS_StudyManager_i Purpose : SALOMEDS_StudyManager_i destructor.

References _factory, _impl, _name_service, and SALOME_NamingService::Destroy_Directory().

Member Function Documentation

CORBA::Boolean SALOMEDS_StudyManager_i::CanCopy ( SALOMEDS::SObject_ptr  theObject)
virtual
CORBA::Boolean SALOMEDS_StudyManager_i::CanPaste ( SALOMEDS::SObject_ptr  theObject)
virtual
void SALOMEDS_StudyManager_i::Close ( SALOMEDS::Study_ptr  aStudy)
virtual

method to close a Study

Function : Close Purpose : Close a study.

Parameters
Study_ptrarguments

If the study hasn't been saved, ask the user to confirm the close action without saving

References _name_service, SALOME_NamingService::Change_Directory(), SALOME_NamingService::Destroy_Name(), GetPOA(), SALOMEDS::lock(), and SALOMEDS::unlock().

virtual CORBA::Object_ptr SALOMEDS_StudyManager_i::ConvertIORToObject ( const char theIOR)
virtual
virtual char* SALOMEDS_StudyManager_i::ConvertObjectToIOR ( CORBA::Object_ptr  theObject)
virtual
CORBA::Boolean SALOMEDS_StudyManager_i::Copy ( SALOMEDS::SObject_ptr  theObject)
virtual
CORBA::LongLong SALOMEDS_StudyManager_i::GetLocalImpl ( const char theHostname,
CORBA::Long  thePID,
CORBA::Boolean &  isLocal 
)
virtual
SALOMEDS::ListOfOpenStudies * SALOMEDS_StudyManager_i::GetOpenStudies ( )
virtual

method to Get name list of open studies in the session

Function : GetOpenStudies Purpose : Get name list of open studies in the session.

Returns
ListOfOpenStudies* arguments

References _impl, SALOMEDSImpl_StudyManager::GetOpenStudies(), SALOMEDS::lock(), MESSAGE, and SCRUTE.

CORBA::Long SALOMEDS_StudyManager_i::getPID ( )
PortableServer::POA_ptr SALOMEDS_StudyManager_i::GetPOA ( const SALOMEDS::Study_ptr  theStudy)
static

Referenced by Close().

SALOMEDS::Study_ptr SALOMEDS_StudyManager_i::GetStudyByID ( CORBA::Short  aStudyID)
virtual

method to get a Study from it's ID

Function : GetStudyByID Purpose : Get a study from its ID.

Parameters
char*arguments, the study ID
Returns
Study_ptr arguments

References _impl, _orb, SALOMEDSImpl_StudyManager::GetErrorCode(), SALOMEDSImpl_StudyManager::GetStudyByID(), SALOMEDS_Study_i::GetStudyServant(), SALOMEDS::lock(), and MESSAGE.

SALOMEDS::Study_ptr SALOMEDS_StudyManager_i::GetStudyByName ( const char aStudyName)
virtual

method to get a Study from it's name

Function : GetStudyByName Purpose : Get a study from its name.

Parameters
char*arguments, the study name
Returns
Study_ptr arguments

References _impl, _orb, SALOMEDSImpl_StudyManager::GetErrorCode(), SALOMEDSImpl_StudyManager::GetStudyByName(), SALOMEDS_Study_i::GetStudyServant(), SALOMEDS::lock(), and MESSAGE.

SALOMEDS::Study_ptr SALOMEDS_StudyManager_i::NewStudy ( const char study_name) throw (SALOME::SALOME_Exception)
virtual

method to Create a New Study of name study_name

Function : NewStudy Purpose : Create a New Study of name study_name.

Parameters
char*arguments, the new study name
Returns
Study_ptr arguments

References SALOME::BAD_PARAM, SALOMEDS_Study_i::GetStudyServant(), SALOMEDS::lock(), MESSAGE, SALOMEDSImpl_Study::SetTransientReference(), and THROW_SALOME_CORBA_EXCEPTION.

SALOMEDS::Study_ptr SALOMEDS_StudyManager_i::Open ( const char aStudyUrl) throw (SALOME::SALOME_Exception)
virtual

method to Open a Study from it's persistent reference

Function : Open Purpose : Open a Study from it's persistent reference.

Parameters
char*arguments, the study URL
Returns
Study_ptr arguments

References SALOME::BAD_PARAM, SALOMEDS_Study_i::GetStudyServant(), SALOMEDS::lock(), MESSAGE, SALOMEDSImpl_Study::Name(), SalomeException(), SALOMEDSImpl_Study::SetTransientReference(), and THROW_SALOME_CORBA_EXCEPTION.

SALOMEDS::SObject_ptr SALOMEDS_StudyManager_i::Paste ( SALOMEDS::SObject_ptr  theObject) throw (SALOMEDS::StudyBuilder::LockProtection)
virtual
void SALOMEDS_StudyManager_i::ping ( )
void SALOMEDS_StudyManager_i::register_name ( const char name)

method to Register study Manager in the naming service

Function : register_name Purpose : Register the study Manager in the naming service under the context name.

Parameters
char*arguments, the context to register the study manager in the NS

References _name_service, and SALOME_NamingService::Register().

Referenced by CreateStudyManager(), and main().

CORBA::Boolean SALOMEDS_StudyManager_i::Save ( SALOMEDS::Study_ptr  aStudy,
CORBA::Boolean  theMultiFile 
)
virtual

method to save a Study

Function : Save Purpose : Save a Study to it's persistent reference.

Parameters
Study_ptrarguments

References _factory, _impl, SALOMEDSImpl_StudyManager::GetStudyByID(), SALOMEDS::lock(), MESSAGE, and SALOMEDSImpl_StudyManager::Save().

CORBA::Boolean SALOMEDS_StudyManager_i::SaveAs ( const char aUrl,
SALOMEDS::Study_ptr  aStudy,
CORBA::Boolean  theMultiFile 
)
virtual

method to save a Study to the persistent reference aUrl

Function : SaveAs Purpose : Save a study to the persistent reference aUrl.

Parameters
char*arguments, the new URL of the study
Study_ptrarguments

References _factory, _impl, SALOMEDSImpl_StudyManager::GetStudyByID(), SALOMEDS::lock(), MESSAGE, and SALOMEDSImpl_StudyManager::SaveAs().

CORBA::Boolean SALOMEDS_StudyManager_i::SaveAsASCII ( const char aUrl,
SALOMEDS::Study_ptr  aStudy,
CORBA::Boolean  theMultiFile 
)
virtual
CORBA::Boolean SALOMEDS_StudyManager_i::SaveASCII ( SALOMEDS::Study_ptr  aStudy,
CORBA::Boolean  theMultiFile 
)
virtual
void SALOMEDS_StudyManager_i::Shutdown ( )
void SALOMEDS_StudyManager_i::ShutdownWithExit ( )

Field Documentation

SALOME_NamingService* SALOMEDS_StudyManager_i::_name_service
private
CORBA::ORB_var SALOMEDS_StudyManager_i::_orb
private
PortableServer::POA_var SALOMEDS_StudyManager_i::_poa
private

Referenced by SALOMEDS_StudyManager_i().