Open CASCADE Technology  7.5.0
Public Member Functions | Protected Attributes

TDocStd_Application Class Reference

The abstract root class for all application classes. They are in charge of: More...

#include <TDocStd_Application.hxx>

Inheritance diagram for TDocStd_Application:
Inheritance graph
[legend]

Public Member Functions

 TDocStd_Application ()
 Constructs the new instance and registers it in CDM_Session. More...
 
Standard_Boolean IsDriverLoaded () const
 Check if meta data driver was successfully loaded by the application constructor. More...
 
virtual Handle< Resource_ManagerResources () override
 Returns resource manager defining supported persistent formats. More...
 
virtual Standard_CString ResourcesName ()
 Returns the name of the file containing the resources of this application, for support of legacy method of loading formats data from resource files. More...
 
void DefineFormat (const TCollection_AsciiString &theFormat, const TCollection_AsciiString &theDescription, const TCollection_AsciiString &theExtension, const Handle< PCDM_RetrievalDriver > &theReader, const Handle< PCDM_StorageDriver > &theWriter)
 Sets up resources and registers read and storage drivers for the specified format. More...
 
void ReadingFormats (TColStd_SequenceOfAsciiString &theFormats)
 Returns the sequence of reading formats supported by the application. More...
 
void WritingFormats (TColStd_SequenceOfAsciiString &theFormats)
 Returns the sequence of writing formats supported by the application. More...
 
Standard_Integer NbDocuments () const
 returns the number of documents handled by the current applicative session. More...
 
void GetDocument (const Standard_Integer index, Handle< TDocStd_Document > &aDoc) const
 Constructs the new document aDoc. aDoc is identified by the index index which is any integer between 1 and n where n is the number of documents returned by NbDocument. Example Handle(TDocStd_Application) anApp; if (!CafTest::Find(A)) return 1; Handle(TDocStd) aDoc; Standard_Integer nbdoc = anApp->NbDocuments(); for (Standard_Integer i = 1; i <= nbdoc; i++) { aApp->GetDocument(i,aDoc);. More...
 
virtual void NewDocument (const TCollection_ExtendedString &format, Handle< TDocStd_Document > &aDoc)
 Constructs the empty new document aDoc. This document will have the format format. If InitDocument is redefined for a specific application, the new document is handled by the applicative session. More...
 
virtual void InitDocument (const Handle< TDocStd_Document > &aDoc) const
 Initialize the document aDoc for the applicative session. This virtual function is called by NewDocument and is to be redefined for each specific application.

<>Modified flag (different of disk version) <>to open/save a document More...
 
void Close (const Handle< TDocStd_Document > &aDoc)
 Close the given document. the document is not any more handled by the applicative session. More...
 
Standard_Integer IsInSession (const TCollection_ExtendedString &path) const
 Returns an index for the document found in the path path in this applicative session. If the returned value is 0, the document is not present in the applicative session. This method can be used for the interactive part of an application. For instance, on a call to Open, the document to be opened may already be in memory. IsInSession checks to see if this is the case. Open can be made to depend on the value of the index returned: if IsInSession returns 0, the document is opened; if it returns another value, a message is displayed asking the user if he wants to override the version of the document in memory. Example: Standard_Integer insession = A->IsInSession(aDoc); if (insession > 0) { std::cout << "document " << insession << " is already in session" << std::endl; return 0; }. More...
 
PCDM_ReaderStatus Open (const TCollection_ExtendedString &path, Handle< TDocStd_Document > &aDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
 Retrieves the document aDoc stored under the name aName in the directory directory. In order not to override a version of aDoc which is already in memory, this method can be made to depend on the value returned by IsInSession. More...
 
PCDM_ReaderStatus Open (Standard_IStream &theIStream, Handle< TDocStd_Document > &theDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
 Retrieves aDoc from standard SEEKABLE stream theIStream. the stream should support SEEK fuctionality. More...
 
PCDM_StoreStatus SaveAs (const Handle< TDocStd_Document > &aDoc, const TCollection_ExtendedString &path, const Message_ProgressRange &theRange=Message_ProgressRange())
 Save the active document in the file <name> in the path <path> ; o verwrites the file if it already exists. More...
 
PCDM_StoreStatus SaveAs (const Handle< TDocStd_Document > &theDoc, Standard_OStream &theOStream, const Message_ProgressRange &theRange=Message_ProgressRange())
 Save theDoc to standard SEEKABLE stream theOStream. the stream should support SEEK fuctionality. More...
 
PCDM_StoreStatus Save (const Handle< TDocStd_Document > &aDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
 Save aDoc active document. Exceptions: Standard_NotImplemented if the document was not retrieved in the applicative session by using Open. More...
 
PCDM_StoreStatus SaveAs (const Handle< TDocStd_Document > &aDoc, const TCollection_ExtendedString &path, TCollection_ExtendedString &theStatusMessage, const Message_ProgressRange &theRange=Message_ProgressRange())
 Save the active document in the file <name> in the path <path> . overwrite the file if it already exist. More...
 
PCDM_StoreStatus SaveAs (const Handle< TDocStd_Document > &theDoc, Standard_OStream &theOStream, TCollection_ExtendedString &theStatusMessage, const Message_ProgressRange &theRange=Message_ProgressRange())
 Save theDoc TO standard SEEKABLE stream theOStream. the stream should support SEEK fuctionality. More...
 
PCDM_StoreStatus Save (const Handle< TDocStd_Document > &aDoc, TCollection_ExtendedString &theStatusMessage, const Message_ProgressRange &theRange=Message_ProgressRange())
 Save the document overwriting the previous file. More...
 
virtual void OnOpenTransaction (const Handle< TDocStd_Document > &theDoc)
 Notification that is fired at each OpenTransaction event. More...
 
virtual void OnCommitTransaction (const Handle< TDocStd_Document > &theDoc)
 Notification that is fired at each CommitTransaction event. More...
 
virtual void OnAbortTransaction (const Handle< TDocStd_Document > &theDoc)
 Notification that is fired at each AbortTransaction event. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from CDF_Application
void Open (const Handle< CDM_Document > &aDocument)
 puts the document in the current session directory and calls the virtual method Activate on it. More...
 
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; More...
 
Handle< CDM_DocumentRetrieve (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const Standard_Boolean UseStorageConfiguration=Standard_True, const Message_ProgressRange &theRange=Message_ProgressRange())
 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: More...
 
Handle< CDM_DocumentRetrieve (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion, const Standard_Boolean UseStorageConfiguration=Standard_True, const Message_ProgressRange &theRange=Message_ProgressRange())
 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. More...
 
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)
 
PCDM_ReaderStatus GetRetrieveStatus () const
 Checks status after Retrieve. More...
 
Handle< CDM_DocumentRead (Standard_IStream &theIStream, const Message_ProgressRange &theRange=Message_ProgressRange())
 Reads aDoc from standard SEEKABLE stream theIStream, the stream should support SEEK fuctionality. More...
 
virtual Handle< PCDM_ReaderReaderFromFormat (const TCollection_ExtendedString &aFormat)
 Returns instance of read driver for specified format. More...
 
virtual Handle< PCDM_StorageDriverWriterFromFormat (const TCollection_ExtendedString &aFormat)
 Returns instance of storage driver for specified format. More...
 
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; More...
 
Standard_ExtString DefaultFolder ()
 
Standard_Boolean SetDefaultFolder (const Standard_ExtString aFolder)
 
Handle< CDF_MetaDataDriverMetaDataDriver () const
 returns MetaDatdDriver of this application More...
 
- Public Member Functions inherited from CDM_Application
virtual Handle< Message_MessengerMessageDriver ()
 Returns default messenger;. More...
 
virtual void BeginOfUpdate (const Handle< CDM_Document > &aDocument)
 this method is called before the update of a document. By default, writes in MessageDriver(). More...
 
virtual void EndOfUpdate (const Handle< CDM_Document > &aDocument, const Standard_Boolean theStatus, const TCollection_ExtendedString &ErrorString)
 this method is called affter the update of a document. By default, writes in MessageDriver(). More...
 
void Write (const Standard_ExtString aString)
 writes the string in the application MessagerDriver. More...
 
virtual TCollection_ExtendedString Name () const
 Returns the application name. More...
 
virtual TCollection_AsciiString Version () const
 Returns the application version. More...
 
virtual CDM_MetaDataLookUpTableMetaDataLookUpTable ()
 Returns MetaData LookUpTable. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

Handle< Resource_ManagermyResources
 
Standard_Boolean myIsDriverLoaded
 
- Protected Attributes inherited from CDF_Application
PCDM_ReaderStatus myRetrievableStatus
 
NCollection_IndexedDataMap< TCollection_ExtendedString, Handle< PCDM_RetrievalDriver > > myReaders
 
NCollection_IndexedDataMap< TCollection_ExtendedString, Handle< PCDM_StorageDriver > > myWriters
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from CDF_Application
static Handle< CDF_ApplicationLoad (const Standard_GUID &aGUID)
 plugs an application. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Data Fields inherited from CDF_Application
Handle< CDF_MetaDataDrivermyMetaDataDriver
 
Handle< CDF_DirectorymyDirectory
 
- Protected Member Functions inherited from CDF_Application
 CDF_Application ()
 
- Protected Member Functions inherited from CDM_Application
 CDM_Application ()
 
void SetDocumentVersion (const Handle< CDM_Document > &aDocument, const Handle< CDM_MetaData > &aMetaData) const
 
void SetReferenceCounter (const Handle< CDM_Document > &aDocument, const Standard_Integer aReferenceCounter)
 

Detailed Description

The abstract root class for all application classes. They are in charge of:

Constructor & Destructor Documentation

◆ TDocStd_Application()

TDocStd_Application::TDocStd_Application ( )

Constructs the new instance and registers it in CDM_Session.

Member Function Documentation

◆ Close()

void TDocStd_Application::Close ( const Handle< TDocStd_Document > &  aDoc)

Close the given document. the document is not any more handled by the applicative session.

◆ DefineFormat()

void TDocStd_Application::DefineFormat ( const TCollection_AsciiString theFormat,
const TCollection_AsciiString theDescription,
const TCollection_AsciiString theExtension,
const Handle< PCDM_RetrievalDriver > &  theReader,
const Handle< PCDM_StorageDriver > &  theWriter 
)

Sets up resources and registers read and storage drivers for the specified format.

Parameters
theFormat- unique name for the format, used to identify it.
theDescription- textual description of the format.
theExtension- extension of the files in that format. The same extension can be used by several formats.
theReader- instance of the read driver for the format. Null value is allowed (no possibility to read).
theWriter- instance of the write driver for the format. Null value is allowed (no possibility to write).

◆ DumpJson()

void TDocStd_Application::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ GetDocument()

void TDocStd_Application::GetDocument ( const Standard_Integer  index,
Handle< TDocStd_Document > &  aDoc 
) const

Constructs the new document aDoc. aDoc is identified by the index index which is any integer between 1 and n where n is the number of documents returned by NbDocument. Example Handle(TDocStd_Application) anApp; if (!CafTest::Find(A)) return 1; Handle(TDocStd) aDoc; Standard_Integer nbdoc = anApp->NbDocuments(); for (Standard_Integer i = 1; i <= nbdoc; i++) { aApp->GetDocument(i,aDoc);.

◆ InitDocument()

virtual void TDocStd_Application::InitDocument ( const Handle< TDocStd_Document > &  aDoc) const
virtual

Initialize the document aDoc for the applicative session. This virtual function is called by NewDocument and is to be redefined for each specific application.

<>Modified flag (different of disk version) <>to open/save a document

Reimplemented in XCAFApp_Application.

◆ IsDriverLoaded()

Standard_Boolean TDocStd_Application::IsDriverLoaded ( ) const

Check if meta data driver was successfully loaded by the application constructor.

◆ IsInSession()

Standard_Integer TDocStd_Application::IsInSession ( const TCollection_ExtendedString path) const

Returns an index for the document found in the path path in this applicative session. If the returned value is 0, the document is not present in the applicative session. This method can be used for the interactive part of an application. For instance, on a call to Open, the document to be opened may already be in memory. IsInSession checks to see if this is the case. Open can be made to depend on the value of the index returned: if IsInSession returns 0, the document is opened; if it returns another value, a message is displayed asking the user if he wants to override the version of the document in memory. Example: Standard_Integer insession = A->IsInSession(aDoc); if (insession > 0) { std::cout << "document " << insession << " is already in session" << std::endl; return 0; }.

◆ NbDocuments()

Standard_Integer TDocStd_Application::NbDocuments ( ) const

returns the number of documents handled by the current applicative session.

◆ NewDocument()

virtual void TDocStd_Application::NewDocument ( const TCollection_ExtendedString format,
Handle< TDocStd_Document > &  aDoc 
)
virtual

Constructs the empty new document aDoc. This document will have the format format. If InitDocument is redefined for a specific application, the new document is handled by the applicative session.

◆ OnAbortTransaction()

virtual void TDocStd_Application::OnAbortTransaction ( const Handle< TDocStd_Document > &  theDoc)
virtual

Notification that is fired at each AbortTransaction event.

◆ OnCommitTransaction()

virtual void TDocStd_Application::OnCommitTransaction ( const Handle< TDocStd_Document > &  theDoc)
virtual

Notification that is fired at each CommitTransaction event.

◆ OnOpenTransaction()

virtual void TDocStd_Application::OnOpenTransaction ( const Handle< TDocStd_Document > &  theDoc)
virtual

Notification that is fired at each OpenTransaction event.

◆ Open() [1/2]

PCDM_ReaderStatus TDocStd_Application::Open ( const TCollection_ExtendedString path,
Handle< TDocStd_Document > &  aDoc,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Retrieves the document aDoc stored under the name aName in the directory directory. In order not to override a version of aDoc which is already in memory, this method can be made to depend on the value returned by IsInSession.

◆ Open() [2/2]

PCDM_ReaderStatus TDocStd_Application::Open ( Standard_IStream theIStream,
Handle< TDocStd_Document > &  theDoc,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Retrieves aDoc from standard SEEKABLE stream theIStream. the stream should support SEEK fuctionality.

◆ ReadingFormats()

void TDocStd_Application::ReadingFormats ( TColStd_SequenceOfAsciiString theFormats)

Returns the sequence of reading formats supported by the application.

Parameters
theFormats- sequence of reading formats. Output parameter.

◆ Resources()

virtual Handle< Resource_Manager > TDocStd_Application::Resources ( )
overridevirtual

Returns resource manager defining supported persistent formats.

Default implementation loads resource file with name ResourcesName(), unless field myResources is already initialized (either by previous call or in any other way).

The resource manager should define:

  • Format name for each file extension supported:
    • [Extension].FileFormat: [Format]
  • For each format supported (as returned by Formats()), its extension, description string, and (when applicable) GUIDs of storage and retrieval plugins:
    • [Format].Description: [Description]
    • [Format].FileExtension: [Extension]
    • [Format].RetrievalPlugin: [GUID] (optional)
    • [Format].StoragePlugin: [GUID] (optional)

Implements CDM_Application.

◆ ResourcesName()

virtual Standard_CString TDocStd_Application::ResourcesName ( )
virtual

Returns the name of the file containing the resources of this application, for support of legacy method of loading formats data from resource files.

Method DefineFormat() can be used to define all necessary parameters explicitly without actually using resource files.

In a resource file, the application associates the schema name of the document with the storage and retrieval plug-ins that are to be loaded for each document. On retrieval, the application reads the schema name in the heading of the CSF file and loads the plug-in indicated in the resource file. This plug-in instantiates the actual driver for transient-persistent conversion. Your application can bring this process into play by defining a class which inherits CDF_Application and redefines the function which returns the appropriate resources file. At this point, the function Retrieve and the class CDF_Store can be called. This allows you to deal with storage and retrieval of - as well as copying and pasting - documents. To implement a class like this, several virtual functions should be redefined. In particular, you must redefine the abstract function Resources inherited from the superclass CDM_Application.

Default implementation returns empty string.

Reimplemented in TObj_Application, XCAFApp_Application, AppStd_Application, and AppStdL_Application.

◆ Save() [1/2]

PCDM_StoreStatus TDocStd_Application::Save ( const Handle< TDocStd_Document > &  aDoc,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Save aDoc active document. Exceptions: Standard_NotImplemented if the document was not retrieved in the applicative session by using Open.

◆ Save() [2/2]

PCDM_StoreStatus TDocStd_Application::Save ( const Handle< TDocStd_Document > &  aDoc,
TCollection_ExtendedString theStatusMessage,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Save the document overwriting the previous file.

◆ SaveAs() [1/4]

PCDM_StoreStatus TDocStd_Application::SaveAs ( const Handle< TDocStd_Document > &  aDoc,
const TCollection_ExtendedString path,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Save the active document in the file <name> in the path <path> ; o verwrites the file if it already exists.

◆ SaveAs() [2/4]

PCDM_StoreStatus TDocStd_Application::SaveAs ( const Handle< TDocStd_Document > &  theDoc,
Standard_OStream theOStream,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Save theDoc to standard SEEKABLE stream theOStream. the stream should support SEEK fuctionality.

◆ SaveAs() [3/4]

PCDM_StoreStatus TDocStd_Application::SaveAs ( const Handle< TDocStd_Document > &  aDoc,
const TCollection_ExtendedString path,
TCollection_ExtendedString theStatusMessage,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Save the active document in the file <name> in the path <path> . overwrite the file if it already exist.

◆ SaveAs() [4/4]

PCDM_StoreStatus TDocStd_Application::SaveAs ( const Handle< TDocStd_Document > &  theDoc,
Standard_OStream theOStream,
TCollection_ExtendedString theStatusMessage,
const Message_ProgressRange theRange = Message_ProgressRange() 
)

Save theDoc TO standard SEEKABLE stream theOStream. the stream should support SEEK fuctionality.

◆ WritingFormats()

void TDocStd_Application::WritingFormats ( TColStd_SequenceOfAsciiString theFormats)

Returns the sequence of writing formats supported by the application.

Parameters
theFormats- sequence of writing formats. Output parameter.

Field Documentation

◆ myIsDriverLoaded

Standard_Boolean TDocStd_Application::myIsDriverLoaded
protected

◆ myResources

Handle< Resource_Manager > TDocStd_Application::myResources
protected

The documentation for this class was generated from the following file: