General KERNEL Documentation     End User KERNEL Services  

SALOMEDSImpl_StudyManager Class Reference

#include <SALOMEDSImpl_StudyManager.hxx>

Inheritance diagram for SALOMEDSImpl_StudyManager:

Inheritance graph
Collaboration diagram for SALOMEDSImpl_StudyManager:

Collaboration graph

Public Member Functions

Standard_EXPORT SALOMEDSImpl_StudyManager ()
 standard constructor
virtual Standard_EXPORT ~SALOMEDSImpl_StudyManager ()
 standard destructor
virtual Standard_EXPORT Handle (SALOMEDSImpl_Study) NewStudy(const TCollection_AsciiString &study_name)
 method to Create a New Study of name study_name
virtual Standard_EXPORT Handle (SALOMEDSImpl_Study) Open(const TCollection_AsciiString &aStudyUrl)
 method to Open a Study from it's persistent reference
virtual Standard_EXPORT void Close (const Handle(SALOMEDSImpl_Study)&aStudy)
 method to close a Study
virtual Standard_EXPORT bool Save (const Handle(SALOMEDSImpl_Study)&aStudy, SALOMEDSImpl_DriverFactory *aFactory, bool theMultiFile)
 method to save a Study
virtual Standard_EXPORT bool SaveASCII (const Handle(SALOMEDSImpl_Study)&aStudy, SALOMEDSImpl_DriverFactory *aFactory, bool theMultiFile)
virtual Standard_EXPORT bool SaveAs (const TCollection_AsciiString &aUrl, const Handle(SALOMEDSImpl_Study)&aStudy, SALOMEDSImpl_DriverFactory *aFactory, bool theMultiFile)
 method to save a Study to the persistent reference aUrl
virtual Standard_EXPORT bool SaveAsASCII (const TCollection_AsciiString &aUrl, const Handle(SALOMEDSImpl_Study)&aStudy, SALOMEDSImpl_DriverFactory *aFactory, bool theMultiFile)
virtual Standard_EXPORT Handle (TColStd_HSequenceOfTransient) GetOpenStudies()
 method to Get name list of open studies in the session
virtual Standard_EXPORT Handle (SALOMEDSImpl_Study) GetStudyByName(const TCollection_AsciiString &aStudyName)
 method to get a Study from it's name
virtual Standard_EXPORT Handle (SALOMEDSImpl_Study) GetStudyByID(int aStudyID)
 method to get a Study from it's ID
Standard_EXPORT Handle (TDocStd_Document) GetDocumentOfStudy(const Handle(SALOMEDSImpl_Study)&theStudy)
Standard_EXPORT Handle (TDocStd_Document) GetClipboard()
Standard_EXPORT bool CopyLabel (const Handle(SALOMEDSImpl_Study)&theSourceStudy, SALOMEDSImpl_Driver *theEngine, const int theSourceStartDepth, const TDF_Label &theSource, const TDF_Label &theDestinationMain)
Standard_EXPORT TDF_Label PasteLabel (const Handle(SALOMEDSImpl_Study)&theDestinationStudy, SALOMEDSImpl_Driver *theEngine, const TDF_Label &theSource, const TDF_Label &theDestinationStart, const int theCopiedStudyID, const bool isFirstElement)
virtual Standard_EXPORT bool CanCopy (const Handle(SALOMEDSImpl_SObject)&theObject, SALOMEDSImpl_Driver *Engine)
virtual Standard_EXPORT bool Copy (const Handle(SALOMEDSImpl_SObject)&theObject, SALOMEDSImpl_Driver *Engine)
virtual Standard_EXPORT bool CanPaste (const Handle(SALOMEDSImpl_SObject)&theObject, SALOMEDSImpl_Driver *Engine)
virtual Standard_EXPORT Handle (SALOMEDSImpl_SObject) Paste(const Handle(SALOMEDSImpl_SObject)&theObject
virtual Standard_EXPORT bool Impl_SaveAs (const TCollection_AsciiString &aUrl, const Handle(SALOMEDSImpl_Study)&aStudy, SALOMEDSImpl_DriverFactory *aFactory, bool theMultiFile, bool theASCII)
virtual Standard_EXPORT bool Impl_SaveObject (const Handle(SALOMEDSImpl_SObject)&SC, HDFgroup *hdf_group_datatype)
virtual Standard_EXPORT TCollection_AsciiString Impl_SubstituteSlash (const TCollection_AsciiString &aUrl)
virtual Standard_EXPORT bool Impl_SaveProperties (const Handle(SALOMEDSImpl_Study)&aStudy, HDFgroup *hdf_group)
Standard_EXPORT TCollection_AsciiString GetErrorCode ()
virtual Standard_EXPORT bool IsError ()

Data Fields

virtual Standard_EXPORT SALOMEDSImpl_Driver * Engine

Private Member Functions

 Handle (SALOMEDSImpl_OCAFApplication) _OCAFApp
 Handle (TDocStd_Document) _clipboard

Private Attributes

int _IDcounter
TCollection_AsciiString _errorCode

Constructor & Destructor Documentation

SALOMEDSImpl_StudyManager::SALOMEDSImpl_StudyManager (   ) 
 

Function : SALOMEDSImpl_StudyManager Purpose : SALOMEDSImpl_StudyManager constructor

SALOMEDSImpl_StudyManager::~SALOMEDSImpl_StudyManager (   )  [virtual]
 

Function : ~SALOMEDSImpl_StudyManager Purpose : SALOMEDSImpl_StudyManager destructor

Member Function Documentation

SALOMEDSImpl_StudyManager::Handle (  SALOMEDSImpl_OCAFApplication   )  [private]
 

SALOMEDSImpl_StudyManager::Handle (  TDocStd_Document   )  [private]
 

virtual Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  SALOMEDSImpl_Study   )  const [virtual]
 

virtual Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  SALOMEDSImpl_Study   )  const [virtual]
 

void SALOMEDSImpl_StudyManager::Close (  const Handle(SALOMEDSImpl_Study)&  aStudy  )  [virtual]
 

Function : Close Purpose : Close a study. If the study hasn't been saved, ask the user to confirm the close action without saving

bool SALOMEDSImpl_StudyManager::Save (  const Handle(SALOMEDSImpl_Study)&  aStudy,
SALOMEDSImpl_DriverFactory *  aFactory,
bool  theMultiFile
)  [virtual]
 

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

bool SALOMEDSImpl_StudyManager::SaveASCII (  const Handle(SALOMEDSImpl_Study)&  aStudy,
SALOMEDSImpl_DriverFactory *  aFactory,
bool  theMultiFile
)  [virtual]
 

bool SALOMEDSImpl_StudyManager::SaveAs (  const TCollection_AsciiString &  aUrl,
const Handle(SALOMEDSImpl_Study)&  aStudy,
SALOMEDSImpl_DriverFactory *  aFactory,
bool  theMultiFile
)  [virtual]
 

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

bool SALOMEDSImpl_StudyManager::SaveAsASCII (  const TCollection_AsciiString &  aUrl,
const Handle(SALOMEDSImpl_Study)&  aStudy,
SALOMEDSImpl_DriverFactory *  aFactory,
bool  theMultiFile
)  [virtual]
 

virtual Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  TColStd_HSequenceOfTransient   )  [virtual]
 

virtual Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  SALOMEDSImpl_Study   )  const [virtual]
 

virtual Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  SALOMEDSImpl_Study   )  [virtual]
 

Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  TDocStd_Document   )  const
 

Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  TDocStd_Document   )  [inline]
 

Standard_EXPORT bool SALOMEDSImpl_StudyManager::CopyLabel (  const Handle(SALOMEDSImpl_Study)&  theSourceStudy,
SALOMEDSImpl_Driver *  theEngine,
const int  theSourceStartDepth,
const TDF_Label &  theSource,
const TDF_Label &  theDestinationMain
) 
 

TDF_Label SALOMEDSImpl_StudyManager::PasteLabel (  const Handle(SALOMEDSImpl_Study)&  theDestinationStudy,
SALOMEDSImpl_Driver *  theEngine,
const TDF_Label &  theSource,
const TDF_Label &  theDestinationStart,
const int  theCopiedStudyID,
const bool  isFirstElement
) 
 

Function : PasteLabel Purpose :

bool SALOMEDSImpl_StudyManager::CanCopy (  const Handle(SALOMEDSImpl_SObject)&  theObject,
SALOMEDSImpl_Driver *  theEngine
)  [virtual]
 

Function : CanCopy Purpose :

bool SALOMEDSImpl_StudyManager::Copy (  const Handle(SALOMEDSImpl_SObject)&  theObject,
SALOMEDSImpl_Driver *  theEngine
)  [virtual]
 

Function : Copy Purpose :

bool SALOMEDSImpl_StudyManager::CanPaste (  const Handle(SALOMEDSImpl_SObject)&  theObject,
SALOMEDSImpl_Driver *  theEngine
)  [virtual]
 

Function : CanPaste Purpose :

virtual Standard_EXPORT SALOMEDSImpl_StudyManager::Handle (  SALOMEDSImpl_SObject   )  const [virtual]
 

bool SALOMEDSImpl_StudyManager::Impl_SaveAs (  const TCollection_AsciiString &  aUrl,
const Handle(SALOMEDSImpl_Study)&  aStudy,
SALOMEDSImpl_DriverFactory *  aFactory,
bool  theMultiFile,
bool  theASCII
)  [virtual]
 

Function : _SaveAs Purpose : save the study in HDF file

bool SALOMEDSImpl_StudyManager::Impl_SaveObject (  const Handle(SALOMEDSImpl_SObject)&  SC,
HDFgroup *  hdf_group_datatype
)  [virtual]
 

Function : Impl_SaveObject Purpose :

TCollection_AsciiString SALOMEDSImpl_StudyManager::Impl_SubstituteSlash (  const TCollection_AsciiString &  aUrl  )  [virtual]
 

Function : Impl_SubstituteSlash Purpose :

bool SALOMEDSImpl_StudyManager::Impl_SaveProperties (  const Handle(SALOMEDSImpl_Study)&  aStudy,
HDFgroup *  hdf_group
)  [virtual]
 

Function : _SaveProperties Purpose : save the study properties in HDF file

Standard_EXPORT TCollection_AsciiString SALOMEDSImpl_StudyManager::GetErrorCode (   )  [inline]
 

virtual Standard_EXPORT bool SALOMEDSImpl_StudyManager::IsError (   )  [inline, virtual]
 

Field Documentation

int SALOMEDSImpl_StudyManager::_IDcounter [private]
 

TCollection_AsciiString SALOMEDSImpl_StudyManager::_errorCode [private]
 

virtual Standard_EXPORT SALOMEDSImpl_Driver* SALOMEDSImpl_StudyManager::Engine
 

  General KERNEL Documentation     End User KERNEL Services  

Generated on Wed Jul 26 15:31:54 2006 for SALOME v.3.2.1 by doxygen 1.4.6