Open CASCADE Technology
6.5.4
|
#include <CDF_Application.hxx>
Public Member Functions | |
void | Open (const Handle< CDM_Document > &aDocument) |
puts the document in the current session directory and calls the virtual method Activate on it. | |
CDM_CanCloseStatus | CanClose (const Handle< CDM_Document > &aDocument) |
void | Close (const Handle< CDM_Document > &aDocument) |
removes the document of the current session directory and closes the document; | |
Handle_CDM_Document | Retrieve (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const Standard_Boolean UseStorageConfiguration=Standard_True) |
This method retrieves a document from the database. If the Document references other documents which have been updated, the latest version of these documents will be used if {UseStorageConfiguration} is Standard_True. The content of {aFolder}, {aName} and {aVersion} depends on the Database Manager system. If the DBMS is only based on the OS, {aFolder} is a directory and {aName} is the name of a file. In this case the use of the syntax with {aVersion} has no sense. For example: Handle(CDM_Document) theDocument=myApplication->Retrieve("/home/cascade","box.dsg"); If the DBMS is EUCLID/Design Manager, {aFolder}, {aName} have the form they have in EUCLID/Design Manager. For example: Handle(CDM_Document) theDocument=myApplication->Retrieve("|user|cascade","box"); Since the version is not specified in this syntax, the latest wil be used. A link is kept with the database through an instance of CDM_MetaData | |
Handle_CDM_Document | Retrieve (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion, const Standard_Boolean UseStorageConfiguration=Standard_True) |
This method retrieves a document from the database. If the Document references other documents which have been updated, the latest version of these documents will be used if {UseStorageConfiguration} is Standard_True. -- If the DBMS is only based on the OS, this syntax should not be used. If the DBMS is EUCLID/Design Manager, {aFolder}, {aName} and {aVersion} have the form they have in EUCLID/Design Manager. For example: Handle(CDM_Document) theDocument=myApplication->Retrieve("|user|cascade","box","2"); A link is kept with the database through an instance of CDM_MetaData | |
PCDM_ReaderStatus | CanRetrieve (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName) |
PCDM_ReaderStatus | CanRetrieve (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion) |
virtual void | Formats (TColStd_SequenceOfExtendedString &Formats)=0 |
PCDM_ReaderStatus | GetRetrieveStatus () const |
Checks status after Retrieve | |
Standard_Boolean | FindReader (const TCollection_ExtendedString &aFileName) |
Handle_PCDM_Reader | Reader (const TCollection_ExtendedString &aFileName) |
Standard_Boolean | FindReaderFromFormat (const TCollection_ExtendedString &aFormat) |
Handle_PCDM_Reader | ReaderFromFormat (const TCollection_ExtendedString &aFormat) |
Standard_Boolean | Format (const TCollection_ExtendedString &aFileName, TCollection_ExtendedString &theFormat) |
try to retrieve a Format directly in the file or in application resource by using extension. returns True if found; | |
Standard_ExtString | DefaultFolder () |
Standard_Boolean | SetDefaultFolder (const Standard_ExtString aFolder) |
Standard_ExtString | DefaultExtension () |
Static Public Member Functions | |
static Handle_CDF_Application | Load (const Standard_GUID &aGUID) |
plugs an application. Open is used | |
Protected Member Functions | |
CDF_Application () | |
Protected Attributes | |
PCDM_ReaderStatus | myRetrievableStatus |
CDF_Application::CDF_Application | ( | ) | [protected] |
CDM_CanCloseStatus CDF_Application::CanClose | ( | const Handle< CDM_Document > & | aDocument | ) |
PCDM_ReaderStatus CDF_Application::CanRetrieve | ( | const TCollection_ExtendedString & | aFolder, |
const TCollection_ExtendedString & | aName | ||
) |
PCDM_ReaderStatus CDF_Application::CanRetrieve | ( | const TCollection_ExtendedString & | aFolder, |
const TCollection_ExtendedString & | aName, | ||
const TCollection_ExtendedString & | aVersion | ||
) |
void CDF_Application::Close | ( | const Handle< CDM_Document > & | aDocument | ) |
Standard_Boolean CDF_Application::FindReaderFromFormat | ( | const TCollection_ExtendedString & | aFormat | ) |
Standard_Boolean CDF_Application::Format | ( | const TCollection_ExtendedString & | aFileName, |
TCollection_ExtendedString & | theFormat | ||
) |
virtual void CDF_Application::Formats | ( | TColStd_SequenceOfExtendedString & | Formats | ) | [pure virtual] |
Implemented in TDocStd_Application, TObj_Application, AppStdL_Application, AppStd_Application, and XCAFApp_Application.
static Handle_CDF_Application CDF_Application::Load | ( | const Standard_GUID & | aGUID | ) | [static] |
- for opening a Document that has been created in an application <br> - for opening a Document from the database <br> - for opening a Document from a file. <br>
The Open methods always add the document in the session directory and
calls the virtual Activate method. The document is considered to be
opened until Close is used. To be storable, a document must be
opened by an application since the application resources are
needed to store it.
void CDF_Application::Open | ( | const Handle< CDM_Document > & | aDocument | ) |
Handle_PCDM_Reader CDF_Application::Reader | ( | const TCollection_ExtendedString & | aFileName | ) |
Handle_PCDM_Reader CDF_Application::ReaderFromFormat | ( | const TCollection_ExtendedString & | aFormat | ) |
Handle_CDM_Document CDF_Application::Retrieve | ( | const TCollection_ExtendedString & | aFolder, |
const TCollection_ExtendedString & | aName, | ||
const Standard_Boolean | UseStorageConfiguration = Standard_True |
||
) |
Handle_CDM_Document CDF_Application::Retrieve | ( | const TCollection_ExtendedString & | aFolder, |
const TCollection_ExtendedString & | aName, | ||
const TCollection_ExtendedString & | aVersion, | ||
const Standard_Boolean | UseStorageConfiguration = Standard_True |
||
) |