Version: 8.3.0
Public Member Functions
SALOMEDSClient_Study Class Referenceabstract

#include <SALOMEDSClient_Study.hxx>

Inheritance diagram for SALOMEDSClient_Study:
Inheritance graph
[legend]

Public Member Functions

virtual ~SALOMEDSClient_Study ()
 
virtual std::string GetPersistentReference ()=0
 
virtual std::string GetTransientReference ()=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 void SetContext (const std::string &thePath)=0
 
virtual std::string GetContext ()=0
 
virtual std::vector< std::string > GetObjectNames (const std::string &theContext)=0
 
virtual std::vector< std::string > GetDirectoryNames (const std::string &theContext)=0
 
virtual std::vector< std::string > GetFileNames (const std::string &theContext)=0
 
virtual std::vector< std::string > GetComponentNames (const std::string &theContext)=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 &name)=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 int StudyId ()=0
 
virtual void StudyId (int id)=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 void Close ()=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

virtual SALOMEDSClient_Study::~SALOMEDSClient_Study ( )
virtual

Member Function Documentation

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

Implemented in SALOMEDS_Study.

virtual void SALOMEDSClient_Study::Close ( )
pure virtual

Implemented in SALOMEDS_Study.

virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::CreateObjectID ( const std::string &  anObjectID)
pure virtual
virtual void SALOMEDSClient_Study::detach ( SALOMEDS::Observer_ptr  theObserver)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual void SALOMEDSClient_Study::EnableUseCaseAutoFilling ( bool  isEnabled)
pure virtual

Implemented in SALOMEDS_Study.

virtual clt_shared_ptr<SALOMEDSClient_SComponent > SALOMEDSClient_Study::FindComponent ( const std::string &  aComponentName)
pure virtual
virtual clt_shared_ptr<SALOMEDSClient_SComponent > SALOMEDSClient_Study::FindComponentID ( const std::string &  aComponentID)
pure virtual
virtual std::vector<clt_shared_ptr<SALOMEDSClient_SObject > > SALOMEDSClient_Study::FindDependances ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtual
virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObject ( const std::string &  anObjectName)
pure virtual
virtual std::vector<clt_shared_ptr<SALOMEDSClient_SObject > > SALOMEDSClient_Study::FindObjectByName ( const std::string &  anObjectName,
const std::string &  aComponentName 
)
pure virtual
virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObjectByPath ( const std::string &  thePath)
pure virtual
virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObjectID ( const std::string &  anObjectID)
pure virtual
virtual clt_shared_ptr<SALOMEDSClient_SObject > SALOMEDSClient_Study::FindObjectIOR ( const std::string &  anObjectIOR)
pure virtual
virtual bool SALOMEDSClient_Study::GetBoolean ( const std::string &  theVarName)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual std::string SALOMEDSClient_Study::GetContext ( )
pure virtual

Implemented in SALOMEDS_Study.

virtual std::vector<std::string> SALOMEDSClient_Study::GetDirectoryNames ( const std::string &  theContext)
pure virtual

Implemented in SALOMEDS_Study.

virtual std::vector<std::string> SALOMEDSClient_Study::GetFileNames ( const std::string &  theContext)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual std::string SALOMEDSClient_Study::GetLastModificationDate ( )
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual clt_shared_ptr<SALOMEDSClient_AttributeStudyProperties > SALOMEDSClient_Study::GetProperties ( )
pure virtual
virtual double SALOMEDSClient_Study::GetReal ( const std::string &  theVarName)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual std::string SALOMEDSClient_Study::GetTransientReference ( )
pure virtual

Implemented in SALOMEDS_Study.

virtual clt_shared_ptr<SALOMEDSClient_UseCaseBuilder > SALOMEDSClient_Study::GetUseCaseBuilder ( )
pure virtual
virtual std::vector<std::string> SALOMEDSClient_Study::GetVariableNames ( )
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual bool SALOMEDSClient_Study::IsEmpty ( )
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual bool SALOMEDSClient_Study::IsModified ( )
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual bool SALOMEDSClient_Study::IsSaved ( )
pure virtual

Implemented in SALOMEDS_Study.

virtual void SALOMEDSClient_Study::IsSaved ( bool  save)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual bool SALOMEDSClient_Study::IsStudyLocked ( )
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual void SALOMEDSClient_Study::Modified ( )
pure virtual

Implemented in SALOMEDS_Study.

virtual std::string SALOMEDSClient_Study::Name ( )
pure virtual

Implemented in SALOMEDS_Study.

virtual void SALOMEDSClient_Study::Name ( const std::string &  name)
pure virtual

Implemented in SALOMEDS_Study.

virtual clt_shared_ptr<SALOMEDSClient_StudyBuilder > SALOMEDSClient_Study::NewBuilder ( )
pure virtual
virtual clt_shared_ptr<SALOMEDSClient_ChildIterator > SALOMEDSClient_Study::NewChildIterator ( const clt_shared_ptr< SALOMEDSClient_SObject > &  theSO)
pure virtual
virtual clt_shared_ptr<SALOMEDSClient_SComponentIterator > SALOMEDSClient_Study::NewComponentIterator ( )
pure virtual
virtual std::vector< std::vector<std::string> > SALOMEDSClient_Study::ParseVariables ( const std::string &  theVars)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual void SALOMEDSClient_Study::SetContext ( const std::string &  thePath)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual void SALOMEDSClient_Study::StudyId ( int  id)
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.

virtual std::string SALOMEDSClient_Study::URL ( )
pure virtual

Implemented in SALOMEDS_Study.

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

Implemented in SALOMEDS_Study.