This is a base class for OCAF based TObj models with declared virtual methods. More...

#include <TObj_Application.hxx>

Inheritance diagram for TObj_Application:

[legend]

Public Member Functions
Handle< Message_Messenger > &	Messenger ()
	Returns reference to associated messenger handle. More...

virtual Standard_Boolean	SaveDocument (const Handle< TDocStd_Document > &theSourceDoc, const char *theTargetFile)
	Saving the OCAF document to a file. More...

virtual Standard_Boolean	LoadDocument (const char *theSourceFile, Handle< TDocStd_Document > &theTargetDoc)
	Loading the OCAF document from a file. More...

virtual Standard_Boolean	CreateNewDocument (Handle< TDocStd_Document > &theDoc, const TCollection_ExtendedString &theFormat)
	Create the OCAF document from scratch. More...

virtual void	ErrorMessage (const TCollection_ExtendedString &theMsg, const Message_Gravity theLevel)
	Signal error during Load or Save Default imiplementation is empty. More...

virtual void	ErrorMessage (const TCollection_ExtendedString &theMsg)
	Signal error during Load or Save Default imiplementation invoke previous declaration with 0. More...

void	SetVerbose (const Standard_Boolean isVerbose)
	Sets the verbose flag, meaning that load/save models should show CPU and elapsed times. More...

Standard_Boolean	IsVerbose () const
	Returns the verbose flag. More...

virtual Standard_CString	ResourcesName ()
	Return name of resource (i.e. "TObj") More...

virtual void	Formats (TColStd_SequenceOfExtendedString &theFormats)
	Return format (i.e "TObj") More...

virtual Handle< CDM_MessageDriver >	MessageDriver ()
	Defines message driver for CDM layer. More...

Public Member Functions inherited from TDocStd_Application
Standard_Boolean	IsDriverLoaded () const
	Check if meta data driver was successfully loaded by the application constructor More...

virtual Handle_Resource_Manager	Resources ()
	create (if not done) a Manager using ResourcesName method. 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. <br> 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. <br> 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. <br> 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 <br> 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) { cout << "document " << insession << " is already in session" << endl; return 0; } More...

PCDM_ReaderStatus	Open (const TCollection_ExtendedString &path, Handle< TDocStd_Document > &aDoc)
	Retrieves the document aDoc stored under the <br> 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_StoreStatus	SaveAs (const Handle< TDocStd_Document > &aDoc, const TCollection_ExtendedString &path)
	Save the active document in the file <name> in the path <path> ; o verwrites the file if it already exists. More...

PCDM_StoreStatus	Save (const Handle< TDocStd_Document > &aDoc)
	Save aDoc active document. <br> 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)
	Save the active document in the file <name> in the path <path> . overwrite the file if it already exist. More...

PCDM_StoreStatus	Save (const Handle< TDocStd_Document > &aDoc, TCollection_ExtendedString &theStatusMessage)
	Save the document overwriting the previous file 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_Document	Retrieve (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const Standard_Boolean UseStorageConfiguration=Standard_True)
	This method retrieves a document from the database. <br> If the Document references other documents which have <br> been updated, the latest version of these documents will <br> be used if {UseStorageConfiguration} is Standard_True. <br> The content of {aFolder}, {aName} and {aVersion} depends on <br> the Database Manager system. If the DBMS is only based on <br> the OS, {aFolder} is a directory and {aName} is the name of a <br> file. In this case the use of the syntax with {aVersion} <br> has no sense. For example: <br> 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 More...

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. <br> If the Document references other documents which have <br> been updated, the latest version of these documents <br> will be used if {UseStorageConfiguration} is <br> Standard_True. -- If the DBMS is only based on the <br> OS, this syntax should not be used. <br> 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 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...

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; More...

Standard_ExtString	DefaultFolder ()

Standard_Boolean	SetDefaultFolder (const Standard_ExtString aFolder)

Standard_ExtString	DefaultExtension ()

Public Member Functions inherited from CDM_Application
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 Status, 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...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (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 void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

Static Public Member Functions
static Handle< TObj_Application >	GetInstance ()
	Returns static instance of the application. More...

Static Public Member Functions inherited from CDF_Application
static Handle_CDF_Application	Load (const Standard_GUID &aGUID)
	plugs an application. <br> Open is used More...

Protected Member Functions
	TObj_Application ()
	Constructor is protected. Use method GetInstance() method to obtain the static instance of the object (or derive your own application) More...

Protected Member Functions inherited from TDocStd_Application
	TDocStd_Application ()

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...

Protected Member Functions inherited from CDF_Application
	CDF_Application ()

Protected Member Functions inherited from 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)

Additional Inherited Members
Protected Attributes inherited from CDF_Application
PCDM_ReaderStatus	myRetrievableStatus

Detailed Description

This is a base class for OCAF based TObj models with declared virtual methods.

Constructor & Destructor Documentation

TObj_Application::TObj_Application ( )

protected

Constructor is protected. Use method GetInstance() method to obtain the static instance of the object (or derive your own application)

Constructor

Member Function Documentation

virtual Standard_Boolean TObj_Application::CreateNewDocument	(	Handle< TDocStd_Document > &	theDoc,
		const TCollection_ExtendedString &	theFormat
	)

virtual

Create the OCAF document from scratch.

virtual void TObj_Application::ErrorMessage	(	const TCollection_ExtendedString &	theMsg,
		const Message_Gravity	theLevel
	)

virtual

Signal error during Load or Save Default imiplementation is empty.

virtual void TObj_Application::ErrorMessage ( const TCollection_ExtendedString & theMsg )

inlinevirtual

Signal error during Load or Save Default imiplementation invoke previous declaration with 0.

virtual void TObj_Application::Formats ( TColStd_SequenceOfExtendedString & theFormats )

virtual

Return format (i.e "TObj")

Implements TDocStd_Application.

static Handle< TObj_Application > TObj_Application::GetInstance ( )

static

Returns static instance of the application.

Standard_Boolean TObj_Application::IsVerbose ( ) const

inline

Returns the verbose flag.

virtual Standard_Boolean TObj_Application::LoadDocument	(	const char *	theSourceFile,
		Handle< TDocStd_Document > &	theTargetDoc
	)

virtual

Loading the OCAF document from a file.

virtual Handle< CDM_MessageDriver > TObj_Application::MessageDriver ( )

inlinevirtual

Defines message driver for CDM layer.

Reimplemented from CDM_Application.

Handle< Message_Messenger >& TObj_Application::Messenger ( )

inline

Returns reference to associated messenger handle.

virtual Standard_CString TObj_Application::ResourcesName ( )

virtual

Return name of resource (i.e. "TObj")

Redefined OCAF methods

Implements TDocStd_Application.

virtual Standard_Boolean TObj_Application::SaveDocument	(	const Handle< TDocStd_Document > &	theSourceDoc,
		const char *	theTargetFile
	)

virtual

Saving the OCAF document to a file.

Load/Save support

void TObj_Application::SetVerbose ( const Standard_Boolean isVerbose )

inline

Sets the verbose flag, meaning that load/save models should show CPU and elapsed times.

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

TObj_Application.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation