#include <SALOMEDSClient_Study.hxx>

Inheritance diagram for SALOMEDSClient_Study:

Public Member Functions
virtual	~SALOMEDSClient_Study ()

virtual void	Init ()=0

virtual void	Clear ()=0

virtual bool	Open (const std::string &theStudyUrl)=0

virtual bool	CanOpen (const std::string &theStudyUrl)=0

virtual std::string	GetPersistentReference ()=0

virtual bool	IsEmpty ()=0

virtual clt_shared_ptr< SALOMEDSClient_SComponent >	FindComponent (const std::string &aComponentName)=0

virtual clt_shared_ptr< SALOMEDSClient_SComponent >	FindComponentID (const std::string &aComponentID)=0

virtual clt_shared_ptr< SALOMEDSClient_SObject >	FindObject (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_SObject >	FindObjectID (const std::string &anObjectID)=0

virtual clt_shared_ptr< SALOMEDSClient_SObject >	CreateObjectID (const std::string &anObjectID)=0

virtual clt_shared_ptr< SALOMEDSClient_SObject >	FindObjectIOR (const std::string &anObjectIOR)=0

virtual clt_shared_ptr< SALOMEDSClient_SObject >	FindObjectByPath (const std::string &thePath)=0

virtual std::string	GetObjectPath (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0

virtual clt_shared_ptr< SALOMEDSClient_ChildIterator >	NewChildIterator (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0

virtual clt_shared_ptr< SALOMEDSClient_SComponentIterator >	NewComponentIterator ()=0

virtual clt_shared_ptr< SALOMEDSClient_StudyBuilder >	NewBuilder ()=0

virtual std::string	Name ()=0

virtual void	Name (const std::string &aName)=0

virtual bool	IsSaved ()=0

virtual void	IsSaved (bool save)=0

virtual bool	IsModified ()=0

virtual void	Modified ()=0

virtual std::string	URL ()=0

virtual void	URL (const std::string &url)=0

virtual std::vector< clt_shared_ptr< SALOMEDSClient_SObject > >	FindDependances (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0

virtual clt_shared_ptr< SALOMEDSClient_AttributeStudyProperties >	GetProperties ()=0

virtual std::string	GetLastModificationDate ()=0

virtual std::vector< std::string >	GetModificationsDate ()=0

virtual clt_shared_ptr< SALOMEDSClient_UseCaseBuilder >	GetUseCaseBuilder ()=0

virtual bool	Save (bool theMultiFile, bool theASCII)=0

virtual bool	SaveAs (const std::string &theUrl, bool theMultiFile, bool theASCII)=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_SObject >	Paste (const clt_shared_ptr< SALOMEDSClient_SObject > &theSO)=0

virtual void	EnableUseCaseAutoFilling (bool isEnabled)=0

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

virtual clt_shared_ptr< SALOMEDSClient_AttributeParameter >	GetCommonParameters (const std::string &theID, int theSavePoint)=0

virtual clt_shared_ptr< SALOMEDSClient_AttributeParameter >	GetModuleParameters (const std::string &theID, const std::string &theModuleName, int theSavePoint)=0

virtual void	SetStudyLock (const std::string &theLockerID)=0

virtual bool	IsStudyLocked ()=0

virtual void	UnLockStudy (const std::string &theLockerID)=0

virtual std::vector< std::string >	GetLockerID ()=0

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

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

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

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

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

virtual double	GetReal (const std::string &theVarName)=0

virtual int	GetInteger (const std::string &theVarName)=0

virtual bool	GetBoolean (const std::string &theVarName)=0

virtual std::string	GetString (const std::string &theVarName)=0

virtual bool	IsReal (const std::string &theVarName)=0

virtual bool	IsInteger (const std::string &theVarName)=0

virtual bool	IsBoolean (const std::string &theVarName)=0

virtual bool	IsString (const std::string &theVarName)=0

virtual bool	IsVariable (const std::string &theVarName)=0

virtual std::vector< std::string >	GetVariableNames ()=0

virtual bool	RemoveVariable (const std::string &theVarName)=0

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

virtual bool	IsVariableUsed (const std::string &theVarName)=0

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

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

virtual void	detach (SALOMEDS::Observer_ptr theObserver)=0

Constructor & Destructor Documentation

◆ ~SALOMEDSClient_Study()

virtual SALOMEDSClient_Study::~SALOMEDSClient_Study ( )

virtual

Member Function Documentation

◆ attach()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ CanCopy()

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

pure virtual

◆ CanOpen()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ CanPaste()

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

pure virtual

◆ Clear()

virtual void SALOMEDSClient_Study::Clear ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ Copy()

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

pure virtual

◆ CreateObjectID()

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

pure virtual

◆ detach()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ DumpStudy()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ EnableUseCaseAutoFilling()

virtual void SALOMEDSClient_Study::EnableUseCaseAutoFilling ( bool isEnabled )

pure virtual

Implemented in SALOMEDS_Study.

◆ FindComponent()

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

pure virtual

◆ FindComponentID()

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

pure virtual

◆ FindDependances()

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

pure virtual

◆ FindObject()

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

pure virtual

◆ FindObjectByName()

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

pure virtual

◆ FindObjectByPath()

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

pure virtual

◆ FindObjectID()

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

pure virtual

◆ FindObjectIOR()

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

pure virtual

◆ GetBoolean()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ GetCommonParameters()

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

pure virtual

◆ GetInteger()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ GetLastModificationDate()

virtual std::string SALOMEDSClient_Study::GetLastModificationDate ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ GetLockerID()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ GetModificationsDate()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ GetModuleParameters()

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

pure virtual

◆ GetObjectPath()

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

pure virtual

◆ GetPersistentReference()

virtual std::string SALOMEDSClient_Study::GetPersistentReference ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ GetProperties()

virtual clt_shared_ptr<SALOMEDSClient_AttributeStudyProperties > SALOMEDSClient_Study::GetProperties ( )

pure virtual

◆ GetReal()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ GetString()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ GetUseCaseBuilder()

virtual clt_shared_ptr<SALOMEDSClient_UseCaseBuilder > SALOMEDSClient_Study::GetUseCaseBuilder ( )

pure virtual

◆ GetVariableNames()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ Init()

virtual void SALOMEDSClient_Study::Init ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ IsBoolean()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ IsEmpty()

virtual bool SALOMEDSClient_Study::IsEmpty ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ IsInteger()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ IsModified()

virtual bool SALOMEDSClient_Study::IsModified ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ IsReal()

virtual bool SALOMEDSClient_Study::IsReal ( const std::string & theVarName )

pure virtual

Implemented in SALOMEDS_Study.

Referenced by KERNEL_PY.salome_notebook.PseudoStudyForNoteBook::IsString().

◆ IsSaved() [1/2]

virtual bool SALOMEDSClient_Study::IsSaved ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ IsSaved() [2/2]

virtual void SALOMEDSClient_Study::IsSaved ( bool save )

pure virtual

Implemented in SALOMEDS_Study.

◆ IsString()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ IsStudyLocked()

virtual bool SALOMEDSClient_Study::IsStudyLocked ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ IsVariable()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ IsVariableUsed()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ Modified()

virtual void SALOMEDSClient_Study::Modified ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ Name() [1/2]

virtual std::string SALOMEDSClient_Study::Name ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ Name() [2/2]

virtual void SALOMEDSClient_Study::Name ( const std::string & aName )

pure virtual

Implemented in SALOMEDS_Study.

◆ NewBuilder()

virtual clt_shared_ptr<SALOMEDSClient_StudyBuilder > SALOMEDSClient_Study::NewBuilder ( )

pure virtual

◆ NewChildIterator()

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

pure virtual

◆ NewComponentIterator()

virtual clt_shared_ptr<SALOMEDSClient_SComponentIterator > SALOMEDSClient_Study::NewComponentIterator ( )

pure virtual

◆ Open()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ ParseVariables()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ Paste()

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

pure virtual

◆ RemoveVariable()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ RenameVariable()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ Save()

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

pure virtual

Implemented in SALOMEDS_Study.

Referenced by SALOME_DriverPy.SALOME_DriverPy_i::SaveASCII().

◆ SaveAs()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ SetBoolean()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ SetInteger()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ SetReal()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ SetString()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ SetStringAsDouble()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ SetStudyLock()

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

pure virtual

◆ UnLockStudy()

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

pure virtual

Implemented in SALOMEDS_Study.

◆ URL() [1/2]

virtual std::string SALOMEDSClient_Study::URL ( )

pure virtual

Implemented in SALOMEDS_Study.

◆ URL() [2/2]

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

pure virtual

Implemented in SALOMEDS_Study.

Public Member Functions

Constructor & Destructor Documentation

◆ ~SALOMEDSClient_Study()

Member Function Documentation

◆ attach()

◆ CanCopy()

◆ CanOpen()

◆ CanPaste()

◆ Clear()

◆ Copy()

◆ CreateObjectID()

◆ detach()

◆ DumpStudy()

◆ EnableUseCaseAutoFilling()

◆ FindComponent()

◆ FindComponentID()

◆ FindDependances()

◆ FindObject()

◆ FindObjectByName()

◆ FindObjectByPath()

◆ FindObjectID()

◆ FindObjectIOR()

◆ GetBoolean()

◆ GetCommonParameters()

◆ GetInteger()

◆ GetLastModificationDate()

◆ GetLockerID()

◆ GetModificationsDate()

◆ GetModuleParameters()

◆ GetObjectPath()

◆ GetPersistentReference()

◆ GetProperties()

◆ GetReal()

◆ GetString()

◆ GetUseCaseBuilder()

◆ GetVariableNames()

◆ Init()

◆ IsBoolean()

◆ IsEmpty()

◆ IsInteger()

◆ IsModified()

◆ IsReal()

◆ IsSaved() [1/2]

◆ IsSaved() [2/2]

◆ IsString()

◆ IsStudyLocked()

◆ IsVariable()

◆ IsVariableUsed()

◆ Modified()

◆ Name() [1/2]

◆ Name() [2/2]

◆ NewBuilder()

◆ NewChildIterator()

◆ NewComponentIterator()

◆ Open()

◆ ParseVariables()

◆ Paste()

◆ RemoveVariable()

◆ RenameVariable()

◆ Save()

◆ SaveAs()

◆ SetBoolean()

◆ SetInteger()

◆ SetReal()

◆ SetString()

◆ SetStringAsDouble()

◆ SetStudyLock()

◆ UnLockStudy()

◆ URL() [1/2]

◆ URL() [2/2]