Version: 9.15.0
SALOMEDS_Study_i Class Reference

#include <SALOMEDS_Study_i.hxx>

Inheritance diagram for SALOMEDS_Study_i:

Public Member Functions

 SALOMEDS_Study_i (CORBA::ORB_ptr, SALOME_NamingService_Abstract *=nullptr)
 standard constructor More...
 
 SALOMEDS_Study_i (CORBA::ORB_ptr, SALOME::Session_ptr session)
 standard constructor More...
 
virtual ~SALOMEDS_Study_i ()
 standard destructor More...
 
virtual PortableServer::POA_ptr _default_POA ()
 Get default POA for the servant object. More...
 
virtual void Init () override
 
virtual void Init (SALOME::Session_ptr session)
 Function : Init Purpose : Initialize study components. More...
 
virtual void Clear ()
 Function : Clear Purpose : Clear study components. More...
 
virtual bool Open (const wchar_t *aStudyUrl)
 method to open a Study More...
 
virtual bool CanOpen (const wchar_t *aStudyUrl)
 method to check that a Study can be opened More...
 
virtual CORBA::Boolean Save (CORBA::Boolean theMultiFile, CORBA::Boolean theASCII)
 method to save a Study More...
 
virtual CORBA::Boolean SaveAs (const wchar_t *aUrl, CORBA::Boolean theMultiFile, CORBA::Boolean theASCII)
 method to save a Study to the persistent reference aUrl More...
 
virtual CORBA::Boolean Copy (SALOMEDS::SObject_ptr theObject)
 method to copy the object More...
 
virtual CORBA::Boolean CanCopy (SALOMEDS::SObject_ptr theObject)
 Function : CanCopy Purpose : More...
 
virtual SALOMEDS::SObject_ptr Paste (SALOMEDS::SObject_ptr theObject)
 method to paste the object in study More...
 
virtual CORBA::Boolean CanPaste (SALOMEDS::SObject_ptr theObject)
 Function : CanPaste Purpose : More...
 
virtual char * GetPersistentReference ()
 method to Get persistent reference of study (idem URL()) More...
 
virtual CORBA::Boolean IsEmpty ()
 method to detect if a study is empty More...
 
virtual SALOMEDS::SComponent_ptr FindComponent (const char *aComponentName)
 method to Find a Component with ComponentDataType = aComponentName More...
 
virtual SALOMEDS::SComponent_ptr FindComponentID (const char *aComponentID)
 method to Find a Component Find a Component from it's ID More...
 
virtual SALOMEDS::SObject_ptr FindObject (const char *anObjectName)
 method to Find an Object with SALOMEDS::Name = anObjectName More...
 
virtual SALOMEDS::Study::ListOfSObjectFindObjectByName (const char *anObjectName, const char *aComponentName)
 method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName More...
 
virtual SALOMEDS::SObject_ptr FindObjectID (const char *anObjectID)
 method to Find an Object with ID = anObjectID More...
 
virtual SALOMEDS::SObject_ptr CreateObjectID (const char *anObjectID)
 method to Create an Object with ID = anObjectID More...
 
virtual SALOMEDS::SObject_ptr FindObjectIOR (const char *anObjectIOR)
 method to Find an Object with ID = anObjectIOR More...
 
virtual SALOMEDS::SObject_ptr FindObjectByPath (const char *thePath)
 method to Find an Object by its path More...
 
virtual char * GetObjectPath (CORBA::Object_ptr theObject)
 method to get a path of SObject More...
 
virtual SALOMEDS::ChildIterator_ptr NewChildIterator (SALOMEDS::SObject_ptr aSO)
 method to Create a ChildIterator from an SObject More...
 
virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator ()
 method to Create a SComponentIterator More...
 
SALOMEDS_SComponentIterator_iNewComponentIteratorImpl ()
 
virtual SALOMEDS::StudyBuilder_ptr NewBuilder ()
 method to Create a StudyBuilder More...
 
virtual wchar_t * Name ()
 method to get study name More...
 
virtual void Name (const wchar_t *name)
 method to set study name More...
 
virtual CORBA::Boolean IsSaved ()
 method to get if study has been saved More...
 
virtual void IsSaved (CORBA::Boolean save)
 method to set if study has been saved More...
 
virtual CORBA::Boolean IsModified ()
 method to Detect if a Study has been modified since it has been saved More...
 
virtual void Modified ()
 method to set Modified flag of a Study to True More...
 
virtual wchar_t * URL ()
 method to get URL of the study (idem GetPersistentReference) More...
 
virtual void URL (const wchar_t *url)
 method to set URL of the study More...
 
virtual void UpdateIORLabelMap (const char *anIOR, const char *aLabel)
 
virtual SALOMEDS::Study::ListOfSObjectFindDependances (SALOMEDS::SObject_ptr anObject)
 
virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties ()
 
virtual char * GetLastModificationDate ()
 
virtual SALOMEDS::ListOfDatesGetModificationsDate ()
 
virtual char * ConvertObjectToIOR (CORBA::Object_ptr theObject)
 
virtual CORBA::Object_ptr ConvertIORToObject (const char *theIOR)
 
virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder ()
 Function : GetUseCaseBuilder Purpose : Returns a UseCase builder. More...
 
void EnableUseCaseAutoFilling (CORBA::Boolean isEnabled)
 Function : EnableUseCaseAutoFilling Purpose : More...
 
virtual void AddPostponed (const char *theIOR)
 Function : AddPostponed Purpose : More...
 
virtual void AddCreatedPostponed (const char *theIOR)
 
virtual void RemovePostponed (CORBA::Long theUndoLimit)
 Function : RemovePostponed Purpose : More...
 
virtual void UndoPostponed (CORBA::Long theWay)
 Function : UndoPostponed Purpose : More...
 
virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters (const char *theID, CORBA::Long theSavePoint)
 Function : GetCommonParameters Purpose : More...
 
virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters (const char *theID, const char *theModuleName, CORBA::Long theSavePoint)
 Function : GetCommonModuleParameters Purpose : More...
 
virtual void SetStudyLock (const char *theLockerID)
 Function : SetStudyLock Purpose : More...
 
virtual bool IsStudyLocked ()
 Function : IsStudyLocked Purpose : More...
 
virtual void UnLockStudy (const char *theLockerID)
 Function : UnLockStudy Purpose : More...
 
virtual SALOMEDS::ListOfStringsGetLockerID ()
 Function : GetLockerID Purpose : More...
 
virtual void SetReal (const char *theVarName, CORBA::Double theValue)
 Function : SetReal Purpose : More...
 
virtual void SetInteger (const char *theVarName, CORBA::Long theValue)
 Function : SetInteger Purpose : More...
 
virtual void SetBoolean (const char *theVarName, CORBA::Boolean theValue)
 Function : SetBoolean Purpose : More...
 
virtual void SetString (const char *theVarName, const char *theValue)
 Function : SetString Purpose : More...
 
virtual void SetStringAsDouble (const char *theVarName, CORBA::Double theValue)
 Function : SetStringAsDouble Purpose : More...
 
virtual CORBA::Double GetReal (const char *theVarName)
 Function : GetReal Purpose : More...
 
virtual CORBA::Long GetInteger (const char *theVarName)
 Function : GetInteger Purpose : More...
 
virtual CORBA::Boolean GetBoolean (const char *theVarName)
 Function : GetBoolean Purpose : More...
 
virtual char * GetString (const char *theVarName)
 Function : GetString Purpose : More...
 
virtual CORBA::Boolean IsReal (const char *theVarName)
 Function : IsReal Purpose : More...
 
virtual CORBA::Boolean IsInteger (const char *theVarName)
 Function : IsInteger Purpose : More...
 
virtual CORBA::Boolean IsBoolean (const char *theVarName)
 Function : IsBoolean Purpose : More...
 
virtual CORBA::Boolean IsString (const char *theVarName)
 Function : IsString Purpose : More...
 
virtual CORBA::Boolean IsVariable (const char *theVarName)
 Function : IsVariable Purpose : More...
 
virtual SALOMEDS::ListOfStringsGetVariableNames ()
 Function : GetVariableNames Purpose : More...
 
virtual CORBA::Boolean RemoveVariable (const char *theVarName)
 Function : RemoveVariable Purpose : More...
 
virtual CORBA::Boolean RenameVariable (const char *theVarName, const char *theNewVarName)
 Function : RenameVariable Purpose : More...
 
virtual CORBA::Boolean IsVariableUsed (const char *theVarName)
 Function : IsVariableUsed Purpose : More...
 
virtual SALOMEDS::ListOfListOfStringsParseVariables (const char *theVars)
 Function : ParseVariables Purpose : More...
 
virtual char * GetDefaultScript (const char *theModuleName, const char *theShift)
 Function : GetDefaultScript Purpose : More...
 
virtual CORBA::Boolean DumpStudy (const char *thePath, const char *theBaseName, CORBA::Boolean isPublished, CORBA::Boolean isMultiFile)
 Function : DumpStudy Purpose : More...
 
virtual char * GetDumpPath ()
 Function : GetDumpPath Purpose : More...
 
virtual SALOMEDSImpl_StudyGetImpl ()
 
virtual CORBA::LongLong GetLocalImpl (const char *theHostname, CORBA::Long thePID, CORBA::Boolean &isLocal)
 
void ping ()
 
CORBA::Long getPID ()
 
void ShutdownWithExit ()
 
void Shutdown ()
 
virtual void attach (SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify)
 Function : attach Purpose : This function attach an observer to the study. More...
 
virtual void detach (SALOMEDS::Observer_ptr theObs)
 Function : detach Purpose : This function detaches an observer from the study. More...
 

Static Public Member Functions

static void IORUpdated (SALOMEDSImpl_AttributeIOR *theAttribute)
 
static void SetThePOA (PortableServer::POA_ptr)
 
static PortableServer::POA_ptr GetThePOA ()
 

Private Member Functions

void NameChanged (SALOME::Session_ptr session)
 

Private Attributes

CORBA::ORB_var _orb
 
SALOMEDSImpl_Study_impl
 
SALOMEDS_StudyBuilder_i_builder
 
SALOMEDSImpl_AbstractCallback_notifier
 
SALOMEDSImpl_AbstractCallback_genObjRegister
 
SALOMEDS_DriverFactory_i_factory
 
bool _closed
 
SALOME_NamingService_Abstract_ns = nullptr
 naming service object to retrieve session. _ns is owned by SALOMEDS_Study_i only if IsTrueNS() returns false More...
 

Constructor & Destructor Documentation

◆ SALOMEDS_Study_i() [1/2]

SALOMEDS_Study_i::SALOMEDS_Study_i ( CORBA::ORB_ptr  orb,
SALOME_NamingService_Abstract ns = nullptr 
)

◆ SALOMEDS_Study_i() [2/2]

SALOMEDS_Study_i::SALOMEDS_Study_i ( CORBA::ORB_ptr  orb,
SALOME::Session_ptr  session 
)

standard constructor

Function : SALOMEDS_Study_i Purpose : SALOMEDS_Study_i constructor.

References _closed, _factory, _impl, _ns, _orb, KERNEL::getNamingService(), Init(), salome::orb, and runSalomeOld::session.

◆ ~SALOMEDS_Study_i()

SALOMEDS_Study_i::~SALOMEDS_Study_i ( )
virtual

standard destructor

Function : ~SALOMEDS_Study_i Purpose : SALOMEDS_Study_i destructor.

References _factory, _impl, _ns, Clear(), and SALOME_NamingService_Container_Abstract::IsTrueNS().

Member Function Documentation

◆ _default_POA()

PortableServer::POA_ptr SALOMEDS_Study_i::_default_POA ( )
virtual

Get default POA for the servant object.

This function is implicitly called from "_this()" function. Default POA can be set via the constructor.

Returns
reference to the default POA for the servant

References GetThePOA(), and SALOME_ContainerPy::poa.

Referenced by Clear().

◆ AddCreatedPostponed()

void SALOMEDS_Study_i::AddCreatedPostponed ( const char *  theIOR)
virtual

References SALOMEDS::lock().

◆ AddPostponed()

void SALOMEDS_Study_i::AddPostponed ( const char *  theIOR)
virtual

Function : AddPostponed Purpose :

References SALOMEDS::lock().

◆ attach()

void SALOMEDS_Study_i::attach ( SALOMEDS::Observer_ptr  theObs,
CORBA::Boolean  modify 
)
virtual

Function : attach Purpose : This function attach an observer to the study.

References _notifier.

◆ CanCopy()

CORBA::Boolean SALOMEDS_Study_i::CanCopy ( SALOMEDS::SObject_ptr  theObject)
virtual

◆ CanOpen()

bool SALOMEDS_Study_i::CanOpen ( const wchar_t *  aStudyUrl)
virtual

method to check that a Study can be opened

Function : CanOpen Purpose : Check that a Study can be opened.

Parameters
char*arguments, the study URL
Returns
bool arguments

References SALOMEDS::lock(), SALOMEDSImpl_Study::Open(), and SalomeException().

◆ CanPaste()

CORBA::Boolean SALOMEDS_Study_i::CanPaste ( SALOMEDS::SObject_ptr  theObject)
virtual

◆ Clear()

◆ ConvertIORToObject()

virtual CORBA::Object_ptr SALOMEDS_Study_i::ConvertIORToObject ( const char *  theIOR)
virtual

◆ ConvertObjectToIOR()

virtual char* SALOMEDS_Study_i::ConvertObjectToIOR ( CORBA::Object_ptr  theObject)
virtual

◆ Copy()

CORBA::Boolean SALOMEDS_Study_i::Copy ( SALOMEDS::SObject_ptr  theObject)
virtual

method to copy the object

Function : Copy Purpose :

Parameters
theObjectobject to copy

References _closed, _impl, _orb, SALOMEDSImpl_Study::Copy(), GetDriver(), SALOMEDSImpl_Study::GetSObject(), SALOMEDS::lock(), and TestKernelHelpers::ret.

◆ CreateObjectID()

SALOMEDS::SObject_ptr SALOMEDS_Study_i::CreateObjectID ( const char *  anObjectID)
virtual

method to Create an Object with ID = anObjectID

Function : CreateObjectID Purpose : Creates an Object with ID = anObjectID.

Parameters
anObjectIDchar* arguments
Returns
SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::CreateObjectID(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

◆ detach()

void SALOMEDS_Study_i::detach ( SALOMEDS::Observer_ptr  theObs)
virtual

Function : detach Purpose : This function detaches an observer from the study.

References _notifier.

◆ DumpStudy()

CORBA::Boolean SALOMEDS_Study_i::DumpStudy ( const char *  thePath,
const char *  theBaseName,
CORBA::Boolean  isPublished,
CORBA::Boolean  isMultiFile 
)
virtual

◆ EnableUseCaseAutoFilling()

void SALOMEDS_Study_i::EnableUseCaseAutoFilling ( CORBA::Boolean  isEnabled)

◆ FindComponent()

SALOMEDS::SComponent_ptr SALOMEDS_Study_i::FindComponent ( const char *  aComponentName)
virtual

method to Find a Component with ComponentDataType = aComponentName

Function : FindComponent Purpose : Find a Component with ComponentDataType = aComponentName.

Parameters
aComponentNamechar* arguments
Returns
SComponent_ptr arguments, the component found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindComponent(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SComponent_i::New().

◆ FindComponentID()

SALOMEDS::SComponent_ptr SALOMEDS_Study_i::FindComponentID ( const char *  aComponentID)
virtual

method to Find a Component Find a Component from it's ID

Function : FindComponentID Purpose : Find a Component from it's ID.

Parameters
aComponentIDchar* arguments
Returns
SComponent_ptr arguments, the component found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindComponentID(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SComponent_i::New().

◆ FindDependances()

SALOMEDS::Study::ListOfSObject * SALOMEDS_Study_i::FindDependances ( SALOMEDS::SObject_ptr  anObject)
virtual

References _closed, and SALOMEDS::lock().

◆ FindObject()

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObject ( const char *  anObjectName)
virtual

method to Find an Object with SALOMEDS::Name = anObjectName

Function : FindObject Purpose : Find an Object with SALOMEDS::Name = anObjectName.

Parameters
anObjectNamechar* arguments
Returns
SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObject(), SALOMEDSImpl_SObject::IsComponent(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), SALOMEDS_SComponent_i::New(), and SALOMEDS_SObject_i::New().

◆ FindObjectByName()

SALOMEDS::Study::ListOfSObject * SALOMEDS_Study_i::FindObjectByName ( const char *  anObjectName,
const char *  aComponentName 
)
virtual

method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName

Function : FindObjectByName Purpose : Find Objects with SALOMEDS::Name = anObjectName in a Component : with ComponentDataType = aComponentName.

Parameters
anObjectNamechar* arguments
aComponentNamechar* arguments
Returns
ListOfSObject_ptr arguments, a list of objects found

< TODO: conversion from size_t to int

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectByName(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

◆ FindObjectByPath()

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObjectByPath ( const char *  thePath)
virtual

method to Find an Object by its path

Function : FindObjectByPath Purpose : Find an Object by its path = thePath.

Parameters
thePathchar* arguments
Returns
SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectByPath(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

◆ FindObjectID()

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObjectID ( const char *  anObjectID)
virtual

method to Find an Object with ID = anObjectID

Function : FindObjectID Purpose : Find an Object with ID = anObjectID.

Parameters
anObjectIDchar* arguments
Returns
SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectID(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

◆ FindObjectIOR()

SALOMEDS::SObject_ptr SALOMEDS_Study_i::FindObjectIOR ( const char *  anObjectIOR)
virtual

method to Find an Object with ID = anObjectIOR

Function : FindObjectIOR Purpose : Find an Object with IOR = anObjectIOR.

Parameters
anObjectIORchar* arguments
Returns
SObject_ptr arguments, the object found

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectIOR(), SALOMEDSImpl_SObject::IsNull(), SALOMEDS::lock(), and SALOMEDS_SObject_i::New().

◆ GetBoolean()

CORBA::Boolean SALOMEDS_Study_i::GetBoolean ( const char *  theVarName)
virtual

Function : GetBoolean Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableValue().

◆ GetCommonParameters()

SALOMEDS::AttributeParameter_ptr SALOMEDS_Study_i::GetCommonParameters ( const char *  theID,
CORBA::Long  theSavePoint 
)
virtual

Function : GetCommonParameters Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetCommonParameters(), and SALOMEDS::lock().

◆ GetDefaultScript()

char * SALOMEDS_Study_i::GetDefaultScript ( const char *  theModuleName,
const char *  theShift 
)
virtual

Function : GetDefaultScript Purpose :

References _closed, _impl, SALOMEDSImpl_IParameters::getDefaultScript(), and SALOMEDS::lock().

◆ GetDumpPath()

char * SALOMEDS_Study_i::GetDumpPath ( )
virtual

Function : GetDumpPath Purpose :

References _impl, and SALOMEDSImpl_Study::GetDumpPath().

◆ GetImpl()

virtual SALOMEDSImpl_Study* SALOMEDS_Study_i::GetImpl ( )
virtual

Referenced by CreateStudyNSAbstract().

◆ GetInteger()

CORBA::Long SALOMEDS_Study_i::GetInteger ( const char *  theVarName)
virtual

Function : GetInteger Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableValue().

◆ GetLastModificationDate()

char * SALOMEDS_Study_i::GetLastModificationDate ( )
virtual

◆ GetLocalImpl()

CORBA::LongLong SALOMEDS_Study_i::GetLocalImpl ( const char *  theHostname,
CORBA::Long  thePID,
CORBA::Boolean &  isLocal 
)
virtual

References _impl.

◆ GetLockerID()

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetLockerID ( )
virtual

Function : GetLockerID Purpose :

< TODO: conversion from size_t to int

References _closed, _impl, SALOMEDSImpl_Study::GetLockerID(), and SALOMEDS::lock().

◆ GetModificationsDate()

SALOMEDS::ListOfDates * SALOMEDS_Study_i::GetModificationsDate ( )
virtual

< TODO: conversion from size_t to int

References _closed, _impl, SALOMEDSImpl_Study::GetModificationsDate(), and SALOMEDS::lock().

◆ GetModuleParameters()

SALOMEDS::AttributeParameter_ptr SALOMEDS_Study_i::GetModuleParameters ( const char *  theID,
const char *  theModuleName,
CORBA::Long  theSavePoint 
)
virtual

Function : GetCommonModuleParameters Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetModuleParameters(), and SALOMEDS::lock().

◆ GetObjectPath()

char * SALOMEDS_Study_i::GetObjectPath ( CORBA::Object_ptr  theObject)
virtual

method to get a path of SObject

Function : GetObjectPath Purpose :

Parameters
aSOSObject_ptr arguments
Returns
char* arguments, the path of the SObject

References _closed, _impl, _orb, SALOMEDSImpl_Study::FindObjectID(), SALOMEDSImpl_Study::FindObjectIOR(), SALOMEDSImpl_Study::GetObjectPath(), SALOMEDSImpl_SObject::IsNull(), and SALOMEDS::lock().

◆ GetPersistentReference()

char * SALOMEDS_Study_i::GetPersistentReference ( )
virtual

method to Get persistent reference of study (idem URL())

Function : GetPersistentReference Purpose : Get persistent reference of study (idem URL())

See also
URL()
Returns
char* arguments, the persistent reference of the study

References _closed, _impl, SALOMEDSImpl_Study::GetPersistentReference(), and SALOMEDS::lock().

◆ getPID()

CORBA::Long SALOMEDS_Study_i::getPID ( )

◆ GetProperties()

SALOMEDS::AttributeStudyProperties_ptr SALOMEDS_Study_i::GetProperties ( )
virtual

◆ GetReal()

CORBA::Double SALOMEDS_Study_i::GetReal ( const char *  theVarName)
virtual

Function : GetReal Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableValue().

◆ GetString()

char * SALOMEDS_Study_i::GetString ( const char *  theVarName)
virtual

Function : GetString Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::GetStringVariableValue().

◆ GetThePOA()

◆ GetUseCaseBuilder()

SALOMEDS::UseCaseBuilder_ptr SALOMEDS_Study_i::GetUseCaseBuilder ( )
virtual

Function : GetUseCaseBuilder Purpose : Returns a UseCase builder.

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetUseCaseBuilder(), and SALOMEDS::lock().

◆ GetVariableNames()

SALOMEDS::ListOfStrings * SALOMEDS_Study_i::GetVariableNames ( )
virtual

Function : GetVariableNames Purpose :

< TODO: conversion from size_t to int

References _closed, _impl, and SALOMEDSImpl_Study::GetVariableNames().

◆ Init() [1/2]

void SALOMEDS_Study_i::Init ( )
overridevirtual

◆ Init() [2/2]

◆ IORUpdated()

void SALOMEDS_Study_i::IORUpdated ( SALOMEDSImpl_AttributeIOR theAttribute)
static

◆ IsBoolean()

CORBA::Boolean SALOMEDS_Study_i::IsBoolean ( const char *  theVarName)
virtual

◆ IsEmpty()

CORBA::Boolean SALOMEDS_Study_i::IsEmpty ( )
virtual

method to detect if a study is empty

Function : IsEmpty Purpose : Detect if study is empty.

Returns
bool arguments, true if study is empty

References _closed, _impl, SALOMEDSImpl_Study::IsEmpty(), and SALOMEDS::lock().

◆ IsInteger()

CORBA::Boolean SALOMEDS_Study_i::IsInteger ( const char *  theVarName)
virtual

◆ IsModified()

CORBA::Boolean SALOMEDS_Study_i::IsModified ( )
virtual

method to Detect if a Study has been modified since it has been saved

Function : IsModified Purpose : Detect if a Study has been modified since it has been saved.

Returns
bool arguments

References _closed, _impl, SALOMEDSImpl_Study::IsModified(), and SALOMEDS::lock().

◆ IsReal()

CORBA::Boolean SALOMEDS_Study_i::IsReal ( const char *  theVarName)
virtual

◆ IsSaved() [1/2]

CORBA::Boolean SALOMEDS_Study_i::IsSaved ( )
virtual

method to get if study has been saved

Function : IsSaved Purpose : get if study has been saved.

Returns
bool arguments

References _closed, _impl, SALOMEDSImpl_Study::IsSaved(), and SALOMEDS::lock().

◆ IsSaved() [2/2]

void SALOMEDS_Study_i::IsSaved ( CORBA::Boolean  save)
virtual

method to set if study has been saved

Function : IsSaved Purpose : set if study has been saved.

Parameters
savebool arguments

References _closed, _impl, SALOMEDSImpl_Study::IsSaved(), and SALOMEDS::lock().

◆ IsString()

CORBA::Boolean SALOMEDS_Study_i::IsString ( const char *  theVarName)
virtual

◆ IsStudyLocked()

bool SALOMEDS_Study_i::IsStudyLocked ( )
virtual

Function : IsStudyLocked Purpose :

References _closed, _impl, SALOMEDSImpl_Study::IsStudyLocked(), and SALOMEDS::lock().

◆ IsVariable()

CORBA::Boolean SALOMEDS_Study_i::IsVariable ( const char *  theVarName)
virtual

Function : IsVariable Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::IsVariable().

◆ IsVariableUsed()

CORBA::Boolean SALOMEDS_Study_i::IsVariableUsed ( const char *  theVarName)
virtual

Function : IsVariableUsed Purpose :

References _closed, _impl, and SALOMEDSImpl_Study::IsVariableUsed().

◆ Modified()

void SALOMEDS_Study_i::Modified ( )
virtual

method to set Modified flag of a Study to True

Function : Modified Purpose : Sets a Modified flag of a Study to True.

References _closed, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::Modify().

◆ Name() [1/2]

wchar_t * SALOMEDS_Study_i::Name ( )
virtual

method to get study name

Function : Name Purpose : get study name.

Returns
char* arguments, the study name

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::Name().

◆ Name() [2/2]

void SALOMEDS_Study_i::Name ( const wchar_t *  name)
virtual

method to set study name

Function : Name Purpose : set study name.

Parameters
namechar* arguments, the study name

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::Name().

◆ NameChanged()

void SALOMEDS_Study_i::NameChanged ( SALOME::Session_ptr  session)
private

◆ NewBuilder()

SALOMEDS::StudyBuilder_ptr SALOMEDS_Study_i::NewBuilder ( )
virtual

method to Create a StudyBuilder

Function : NewBuilder Purpose : Create a StudyBuilder.

Returns
StudyBuilder_ptr arguments, the created StudyBuilder

References _builder, _closed, and SALOMEDS::lock().

◆ NewChildIterator()

SALOMEDS::ChildIterator_ptr SALOMEDS_Study_i::NewChildIterator ( SALOMEDS::SObject_ptr  aSO)
virtual

method to Create a ChildIterator from an SObject

Function : NewChildIterator Purpose : Create a ChildIterator from an SObject.

Parameters
aSOSObject_ptr arguments
Returns
ChildIterator_ptr arguments, the created ChildIterator

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetSObject(), and SALOMEDS::lock().

◆ NewComponentIterator()

SALOMEDS::SComponentIterator_ptr SALOMEDS_Study_i::NewComponentIterator ( )
virtual

method to Create a SComponentIterator

Function : NewComponentIterator Purpose : Create a SComponentIterator.

Returns
SComponentIterator_ptr arguments, the created SComponentIterator

References NewComponentIteratorImpl().

◆ NewComponentIteratorImpl()

◆ Open()

bool SALOMEDS_Study_i::Open ( const wchar_t *  aStudyUrl)
virtual

method to open a Study

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

Parameters
char*arguments, the study URL
Returns
bool arguments

References _closed, _impl, _ns, SALOME::BAD_PARAM, Clear(), Init(), SALOMEDS::lock(), MESSAGE, SALOMEDSImpl_Study::Open(), test::res, SalomeException(), SALOMEDS::sendMessageToGUI(), and THROW_SALOME_CORBA_EXCEPTION.

◆ ParseVariables()

SALOMEDS::ListOfListOfStrings * SALOMEDS_Study_i::ParseVariables ( const char *  theVars)
virtual

Function : ParseVariables Purpose :

< TODO: conversion from size_t to int

< TODO: conversion from size_t to int

References _closed, _impl, and SALOMEDSImpl_Study::ParseVariables().

◆ Paste()

SALOMEDS::SObject_ptr SALOMEDS_Study_i::Paste ( SALOMEDS::SObject_ptr  theObject)
virtual

method to paste the object in study

Function : Paste Purpose :

Parameters
theObjectobject to paste

References _impl, _orb, GetDriver(), SALOMEDSImpl_Study::GetSObject(), SALOMEDS::lock(), SALOMEDS_SObject_i::New(), and SALOMEDSImpl_Study::Paste().

◆ ping()

void SALOMEDS_Study_i::ping ( )

◆ RemovePostponed()

void SALOMEDS_Study_i::RemovePostponed ( CORBA::Long  theUndoLimit)
virtual

Function : RemovePostponed Purpose :

References _closed, _impl, _orb, SALOMEDSImpl_Study::GetIORs(), SALOMEDS::lock(), and KERNEL_PY.batchmode_salome::obj.

Referenced by Clear().

◆ RemoveVariable()

CORBA::Boolean SALOMEDS_Study_i::RemoveVariable ( const char *  theVarName)
virtual

◆ RenameVariable()

CORBA::Boolean SALOMEDS_Study_i::RenameVariable ( const char *  theVarName,
const char *  theNewVarName 
)
virtual

◆ Save()

CORBA::Boolean SALOMEDS_Study_i::Save ( CORBA::Boolean  theMultiFile,
CORBA::Boolean  theASCII 
)
virtual

method to save a Study

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

References _closed, _factory, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::Save().

Referenced by SALOME_DriverPy.SALOME_DriverPy_i::SaveASCII().

◆ SaveAs()

CORBA::Boolean SALOMEDS_Study_i::SaveAs ( const wchar_t *  aUrl,
CORBA::Boolean  theMultiFile,
CORBA::Boolean  theASCII 
)
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

References _closed, _factory, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::SaveAs().

◆ SetBoolean()

void SALOMEDS_Study_i::SetBoolean ( const char *  theVarName,
CORBA::Boolean  theValue 
)
virtual

◆ SetInteger()

void SALOMEDS_Study_i::SetInteger ( const char *  theVarName,
CORBA::Long  theValue 
)
virtual

◆ SetReal()

void SALOMEDS_Study_i::SetReal ( const char *  theVarName,
CORBA::Double  theValue 
)
virtual

◆ SetString()

void SALOMEDS_Study_i::SetString ( const char *  theVarName,
const char *  theValue 
)
virtual

◆ SetStringAsDouble()

void SALOMEDS_Study_i::SetStringAsDouble ( const char *  theVarName,
CORBA::Double  theValue 
)
virtual

◆ SetStudyLock()

void SALOMEDS_Study_i::SetStudyLock ( const char *  theLockerID)
virtual

Function : SetStudyLock Purpose :

References _closed, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::SetStudyLock().

◆ SetThePOA()

void SALOMEDS_Study_i::SetThePOA ( PortableServer::POA_ptr  thePOA)
static

References _poa.

Referenced by CreateStudyNSAbstract(), and main().

◆ Shutdown()

void SALOMEDS_Study_i::Shutdown ( )

References _closed, and _orb.

◆ ShutdownWithExit()

void SALOMEDS_Study_i::ShutdownWithExit ( )

◆ UndoPostponed()

void SALOMEDS_Study_i::UndoPostponed ( CORBA::Long  theWay)
virtual

Function : UndoPostponed Purpose :

References SALOMEDS::lock().

◆ UnLockStudy()

void SALOMEDS_Study_i::UnLockStudy ( const char *  theLockerID)
virtual

Function : UnLockStudy Purpose :

References _closed, _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::UnLockStudy().

◆ UpdateIORLabelMap()

void SALOMEDS_Study_i::UpdateIORLabelMap ( const char *  anIOR,
const char *  aLabel 
)
virtual

◆ URL() [1/2]

wchar_t * SALOMEDS_Study_i::URL ( )
virtual

method to get URL of the study (idem GetPersistentReference)

Function : URL Purpose : get URL of the study (persistent reference of the study)

Returns
char* arguments, the study URL

References _impl, SALOMEDS::lock(), and SALOMEDSImpl_Study::URL().

◆ URL() [2/2]

void SALOMEDS_Study_i::URL ( const wchar_t *  url)
virtual

method to set URL of the study

Function : URL Purpose : set URL of the study (persistent reference of the study)

Parameters
urlchar* arguments, the study URL

References _impl, _ns, SALOMEDS::lock(), NameChanged(), KERNEL_PY.batchmode_salome::obj, SALOME_NamingService_Container_Abstract::Resolve(), and SALOMEDSImpl_Study::URL().

Field Documentation

◆ _builder

SALOMEDS_StudyBuilder_i* SALOMEDS_Study_i::_builder
private

◆ _closed

◆ _factory

SALOMEDS_DriverFactory_i* SALOMEDS_Study_i::_factory
private

◆ _genObjRegister

SALOMEDSImpl_AbstractCallback* SALOMEDS_Study_i::_genObjRegister
private

Referenced by Clear(), and Init().

◆ _impl

◆ _notifier

◆ _ns

SALOME_NamingService_Abstract* SALOMEDS_Study_i::_ns = nullptr
private

naming service object to retrieve session. _ns is owned by SALOMEDS_Study_i only if IsTrueNS() returns false

Referenced by Clear(), Init(), Open(), SALOMEDS_Study_i(), URL(), and ~SALOMEDS_Study_i().

◆ _orb