Version: 9.12.0
SALOMEDS_Study Class Referenceabstract

#include <SALOMEDS_Study.hxx>

Inheritance diagram for SALOMEDS_Study:

Public Member Functions

 SALOMEDS_Study (SALOMEDSImpl_Study *theStudy)
 
 SALOMEDS_Study (SALOMEDS::Study_ptr theStudy)
 
 ~SALOMEDS_Study ()
 
virtual void Clear ()
 
virtual void Init ()
 
virtual bool Open (const std::string &theStudyUrl)
 
virtual bool CanOpen (const std::string &theStudyUrl)
 
virtual bool Save (bool theMultiFile, bool theASCII)
 
virtual bool SaveAs (const std::string &theUrl, bool theMultiFile, bool theASCII)
 
virtual bool CanCopy (const _PTR(SObject)&theSO)
 
virtual bool Copy (const _PTR(SObject)&theSO)
 
virtual bool CanPaste (const _PTR(SObject)&theSO)
 
virtual _PTR (SObject) Paste(const _PTR(SObject) &theSO)
 
virtual std::string GetPersistentReference ()
 
virtual bool IsEmpty ()
 
virtual _PTR (ChildIterator) NewChildIterator(const _PTR(SObject) &theSO)
 
virtual _PTR (SComponentIterator) NewComponentIterator()
 
virtual _PTR (StudyBuilder) NewBuilder()
 
virtual std::string Name ()
 
virtual void Name (const std::string &name)
 
virtual bool IsSaved ()
 
virtual void IsSaved (bool save)
 
virtual bool IsModified ()
 
virtual void Modified ()
 
virtual std::string URL ()
 
virtual void URL (const std::string &url)
 
virtual std::vector< _PTR(SObject)> FindDependances (const _PTR(SObject)&theSO)
 
virtual _PTR (AttributeStudyProperties) GetProperties()
 
virtual std::string GetLastModificationDate ()
 
virtual std::vector< std::string > GetModificationsDate ()
 
virtual _PTR (UseCaseBuilder) GetUseCaseBuilder()
 
virtual void EnableUseCaseAutoFilling (bool isEnabled)
 
virtual bool DumpStudy (const std::string &thePath, const std::string &theBaseName, bool isPublished, bool isMultiFile)
 
virtual bool IsStudyLocked ()
 
virtual void UnLockStudy (const std::string &theLockerID)
 
virtual std::vector< std::string > GetLockerID ()
 
virtual void SetReal (const std::string &theVarName, const double theValue)
 
virtual void SetInteger (const std::string &theVarName, const int theValue)
 
virtual void SetBoolean (const std::string &theVarName, const bool theValue)
 
virtual void SetString (const std::string &theVarName, const std::string &theValue)
 
virtual void SetStringAsDouble (const std::string &theVarName, const double theValue)
 
virtual double GetReal (const std::string &theVarName)
 
virtual int GetInteger (const std::string &theVarName)
 
virtual bool GetBoolean (const std::string &theVarName)
 
virtual std::string GetString (const std::string &theVarName)
 
virtual bool IsReal (const std::string &theVarName)
 
virtual bool IsInteger (const std::string &theVarName)
 
virtual bool IsBoolean (const std::string &theVarName)
 
virtual bool IsString (const std::string &theVarName)
 
virtual bool IsVariable (const std::string &theVarName)
 
virtual std::vector< std::string > GetVariableNames ()
 
virtual bool RemoveVariable (const std::string &theVarName)
 
virtual bool RenameVariable (const std::string &theVarName, const std::string &theNewVarName)
 
virtual bool IsVariableUsed (const std::string &theVarName)
 
virtual std::vector< std::vector< std::string > > ParseVariables (const std::string &theVars)
 
virtual void attach (SALOMEDS::Observer_ptr theObserver, bool modify)
 
virtual void detach (SALOMEDS::Observer_ptr theObserver)
 
std::string ConvertObjectToIOR (CORBA::Object_ptr theObject)
 
CORBA::Object_ptr ConvertIORToObject (const std::string &theIOR)
 
SALOMEDSImpl_StudyGetLocalImpl ()
 
virtual clt_shared_ptr< SALOMEDSClient_SComponentFindComponent (const std::string &aComponentName)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SComponentFindComponentID (const std::string &aComponentID)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SObjectFindObject (const std::string &anObjectName)=0
 
virtual std::vector< clt_shared_ptr< SALOMEDSClient_SObject > > FindObjectByName (const std::string &anObjectName, const std::string &aComponentName)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SObjectFindObjectID (const std::string &anObjectID)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SObjectCreateObjectID (const std::string &anObjectID)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SObjectFindObjectIOR (const std::string &anObjectIOR)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SObjectFindObjectByPath (const std::string &thePath)=0
 
virtual std::string GetObjectPath (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0
 
virtual clt_shared_ptr< SALOMEDSClient_ChildIteratorNewChildIterator (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SComponentIteratorNewComponentIterator ()=0
 
virtual clt_shared_ptr< SALOMEDSClient_StudyBuilderNewBuilder ()=0
 
virtual std::vector< clt_shared_ptr< SALOMEDSClient_SObject > > FindDependances (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0
 
virtual clt_shared_ptr< SALOMEDSClient_AttributeStudyPropertiesGetProperties ()=0
 
virtual clt_shared_ptr< SALOMEDSClient_UseCaseBuilderGetUseCaseBuilder ()=0
 
virtual bool CanCopy (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0
 
virtual bool Copy (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0
 
virtual bool CanPaste (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0
 
virtual clt_shared_ptr< SALOMEDSClient_SObjectPaste (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0
 
virtual clt_shared_ptr< SALOMEDSClient_AttributeParameterGetCommonParameters (const std::string &theID, int theSavePoint)=0
 
virtual clt_shared_ptr< SALOMEDSClient_AttributeParameterGetModuleParameters (const std::string &theID, const std::string &theModuleName, int theSavePoint)=0
 
virtual void SetStudyLock (const std::string &theLockerID)=0
 

Private Member Functions

void InitORB ()
 

Private Attributes

bool _isLocal
 
SALOMEDSImpl_Study_local_impl
 
SALOMEDS::Study_var _corba_impl
 
CORBA::ORB_var _orb
 

Constructor & Destructor Documentation

◆ SALOMEDS_Study() [1/2]

SALOMEDS_Study::SALOMEDS_Study ( SALOMEDSImpl_Study theStudy)

◆ SALOMEDS_Study() [2/2]

SALOMEDS_Study::SALOMEDS_Study ( SALOMEDS::Study_ptr  theStudy)

◆ ~SALOMEDS_Study()

SALOMEDS_Study::~SALOMEDS_Study ( )

Member Function Documentation

◆ _PTR() [1/6]

virtual SALOMEDS_Study::_PTR ( AttributeStudyProperties  )
virtual

◆ _PTR() [2/6]

virtual SALOMEDS_Study::_PTR ( ChildIterator  ) const &
virtual

◆ _PTR() [3/6]

virtual SALOMEDS_Study::_PTR ( SComponentIterator  )
virtual

◆ _PTR() [4/6]

virtual SALOMEDS_Study::_PTR ( SObject  ) const &
virtual

Referenced by _PTR(), and FindDependances().

◆ _PTR() [5/6]

virtual SALOMEDS_Study::_PTR ( StudyBuilder  )
virtual

◆ _PTR() [6/6]

virtual SALOMEDS_Study::_PTR ( UseCaseBuilder  )
virtual

◆ attach()

void SALOMEDS_Study::attach ( SALOMEDS::Observer_ptr  theObserver,
bool  modify 
)
virtual

Implements SALOMEDSClient_Study.

References _corba_impl.

◆ CanCopy() [1/2]

◆ CanCopy() [2/2]

virtual bool SALOMEDSClient_Study::CanCopy ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtualinherited

◆ CanOpen()

bool SALOMEDS_Study::CanOpen ( const std::string &  theStudyUrl)
virtual

◆ CanPaste() [1/2]

◆ CanPaste() [2/2]

virtual bool SALOMEDSClient_Study::CanPaste ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtualinherited

◆ Clear()

void SALOMEDS_Study::Clear ( )
virtual

Implements SALOMEDSClient_Study.

References _corba_impl.

◆ ConvertIORToObject()

CORBA::Object_ptr SALOMEDS_Study::ConvertIORToObject ( const std::string &  theIOR)

References _orb.

◆ ConvertObjectToIOR()

std::string SALOMEDS_Study::ConvertObjectToIOR ( CORBA::Object_ptr  theObject)

References _orb.

◆ Copy() [1/2]

◆ Copy() [2/2]

virtual bool SALOMEDSClient_Study::Copy ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtualinherited

◆ CreateObjectID()

virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::CreateObjectID ( const std::string &  anObjectID)
pure virtualinherited

◆ detach()

void SALOMEDS_Study::detach ( SALOMEDS::Observer_ptr  theObserver)
virtual

Implements SALOMEDSClient_Study.

References _corba_impl.

◆ DumpStudy()

bool SALOMEDS_Study::DumpStudy ( const std::string &  thePath,
const std::string &  theBaseName,
bool  isPublished,
bool  isMultiFile 
)
virtual

Implements SALOMEDSClient_Study.

References _corba_impl.

◆ EnableUseCaseAutoFilling()

void SALOMEDS_Study::EnableUseCaseAutoFilling ( bool  isEnabled)
virtual

◆ FindComponent()

virtual clt_shared_ptr<SALOMEDSClient_SComponent > SALOMEDSClient_Study::FindComponent ( const std::string &  aComponentName)
pure virtualinherited

◆ FindComponentID()

virtual clt_shared_ptr<SALOMEDSClient_SComponent > SALOMEDSClient_Study::FindComponentID ( const std::string &  aComponentID)
pure virtualinherited

◆ FindDependances() [1/2]

std::vector< _PTR(SObject)> SALOMEDS_Study::FindDependances ( const _PTR(SObject)&  theSO)
virtual

◆ FindDependances() [2/2]

virtual std::vector<clt_shared_ptr<SALOMEDSClient_SObject > > SALOMEDSClient_Study::FindDependances ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtualinherited

◆ FindObject()

virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObject ( const std::string &  anObjectName)
pure virtualinherited

◆ FindObjectByName()

virtual std::vector<clt_shared_ptr<SALOMEDSClient_SObject > > SALOMEDSClient_Study::FindObjectByName ( const std::string &  anObjectName,
const std::string &  aComponentName 
)
pure virtualinherited

◆ FindObjectByPath()

virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObjectByPath ( const std::string &  thePath)
pure virtualinherited

◆ FindObjectID()

virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObjectID ( const std::string &  anObjectID)
pure virtualinherited

◆ FindObjectIOR()

virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObjectIOR ( const std::string &  anObjectIOR)
pure virtualinherited

◆ GetBoolean()

bool SALOMEDS_Study::GetBoolean ( const std::string &  theVarName)
virtual

◆ GetCommonParameters()

virtual clt_shared_ptr<SALOMEDSClient_AttributeParameter > SALOMEDSClient_Study::GetCommonParameters ( const std::string &  theID,
int  theSavePoint 
)
pure virtualinherited

◆ GetInteger()

int SALOMEDS_Study::GetInteger ( const std::string &  theVarName)
virtual

◆ GetLastModificationDate()

std::string SALOMEDS_Study::GetLastModificationDate ( )
virtual

◆ GetLocalImpl()

SALOMEDSImpl_Study* SALOMEDS_Study::GetLocalImpl ( )

◆ GetLockerID()

std::vector< std::string > SALOMEDS_Study::GetLockerID ( )
virtual

◆ GetModificationsDate()

std::vector< std::string > SALOMEDS_Study::GetModificationsDate ( )
virtual

◆ GetModuleParameters()

virtual clt_shared_ptr<SALOMEDSClient_AttributeParameter > SALOMEDSClient_Study::GetModuleParameters ( const std::string &  theID,
const std::string &  theModuleName,
int  theSavePoint 
)
pure virtualinherited

◆ GetObjectPath()

virtual std::string SALOMEDSClient_Study::GetObjectPath ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtualinherited

◆ GetPersistentReference()

std::string SALOMEDS_Study::GetPersistentReference ( )
virtual

◆ GetProperties()

virtual clt_shared_ptr<SALOMEDSClient_AttributeStudyProperties > SALOMEDSClient_Study::GetProperties ( )
pure virtualinherited

◆ GetReal()

double SALOMEDS_Study::GetReal ( const std::string &  theVarName)
virtual

◆ GetString()

std::string SALOMEDS_Study::GetString ( const std::string &  theVarName)
virtual

◆ GetUseCaseBuilder()

virtual clt_shared_ptr<SALOMEDSClient_UseCaseBuilder > SALOMEDSClient_Study::GetUseCaseBuilder ( )
pure virtualinherited

◆ GetVariableNames()

std::vector< std::string > SALOMEDS_Study::GetVariableNames ( )
virtual

◆ Init()

void SALOMEDS_Study::Init ( )
virtual

Implements SALOMEDSClient_Study.

References _corba_impl.

◆ InitORB()

void SALOMEDS_Study::InitORB ( )
private

References _orb, and KERNEL::GetRefToORB().

Referenced by SALOMEDS_Study().

◆ IsBoolean()

bool SALOMEDS_Study::IsBoolean ( const std::string &  theVarName)
virtual

◆ IsEmpty()

◆ IsInteger()

bool SALOMEDS_Study::IsInteger ( const std::string &  theVarName)
virtual

◆ IsModified()

bool SALOMEDS_Study::IsModified ( )
virtual

◆ IsReal()

◆ IsSaved() [1/2]

bool SALOMEDS_Study::IsSaved ( )
virtual

◆ IsSaved() [2/2]

void SALOMEDS_Study::IsSaved ( bool  save)
virtual

◆ IsString()

bool SALOMEDS_Study::IsString ( const std::string &  theVarName)
virtual

◆ IsStudyLocked()

bool SALOMEDS_Study::IsStudyLocked ( )
virtual

◆ IsVariable()

bool SALOMEDS_Study::IsVariable ( const std::string &  theVarName)
virtual

◆ IsVariableUsed()

bool SALOMEDS_Study::IsVariableUsed ( const std::string &  theVarName)
virtual

◆ Modified()

void SALOMEDS_Study::Modified ( )
virtual

◆ Name() [1/2]

std::string SALOMEDS_Study::Name ( )
virtual

◆ Name() [2/2]

void SALOMEDS_Study::Name ( const std::string &  name)
virtual

◆ NewBuilder()

virtual clt_shared_ptr<SALOMEDSClient_StudyBuilder > SALOMEDSClient_Study::NewBuilder ( )
pure virtualinherited

◆ NewChildIterator()

virtual clt_shared_ptr<SALOMEDSClient_ChildIterator > SALOMEDSClient_Study::NewChildIterator ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtualinherited

◆ NewComponentIterator()

virtual clt_shared_ptr<SALOMEDSClient_SComponentIterator > SALOMEDSClient_Study::NewComponentIterator ( )
pure virtualinherited

◆ Open()

bool SALOMEDS_Study::Open ( const std::string &  theStudyUrl)
virtual

◆ ParseVariables()

std::vector< std::vector< std::string > > SALOMEDS_Study::ParseVariables ( const std::string &  theVars)
virtual

◆ Paste()

virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::Paste ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtualinherited

◆ RemoveVariable()

bool SALOMEDS_Study::RemoveVariable ( const std::string &  theVarName)
virtual

◆ RenameVariable()

bool SALOMEDS_Study::RenameVariable ( const std::string &  theVarName,
const std::string &  theNewVarName 
)
virtual

◆ Save()

bool SALOMEDS_Study::Save ( bool  theMultiFile,
bool  theASCII 
)
virtual

◆ SaveAs()

bool SALOMEDS_Study::SaveAs ( const std::string &  theUrl,
bool  theMultiFile,
bool  theASCII 
)
virtual

◆ SetBoolean()

void SALOMEDS_Study::SetBoolean ( const std::string &  theVarName,
const bool  theValue 
)
virtual

◆ SetInteger()

void SALOMEDS_Study::SetInteger ( const std::string &  theVarName,
const int  theValue 
)
virtual

◆ SetReal()

void SALOMEDS_Study::SetReal ( const std::string &  theVarName,
const double  theValue 
)
virtual

◆ SetString()

void SALOMEDS_Study::SetString ( const std::string &  theVarName,
const std::string &  theValue 
)
virtual

◆ SetStringAsDouble()

void SALOMEDS_Study::SetStringAsDouble ( const std::string &  theVarName,
const double  theValue 
)
virtual

◆ SetStudyLock()

virtual void SALOMEDSClient_Study::SetStudyLock ( const std::string &  theLockerID)
pure virtualinherited

◆ UnLockStudy()

void SALOMEDS_Study::UnLockStudy ( const std::string &  theLockerID)
virtual

◆ URL() [1/2]

std::string SALOMEDS_Study::URL ( )
virtual

◆ URL() [2/2]

void SALOMEDS_Study::URL ( const std::string &  url)
virtual

Field Documentation

◆ _corba_impl

◆ _isLocal

◆ _local_impl

◆ _orb