#include <CDF_Application.hxx>

Inheritance diagram for CDF_Application:

[legend]

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

virtual void	Formats (TColStd_SequenceOfExtendedString &Formats)=0

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 Handle_Resource_Manager	Resources ()=0
	the manager returned by this virtual method will be <br> used to search for Format`.Retrieval resource items. <br> More...

virtual Handle_CDM_MessageDriver	MessageDriver ()
	By default returns a NullMessageDriver; 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 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_CDF_Application	Load (const Standard_GUID &aGUID)
	plugs an application. <br> Open is used More...

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

Protected Attributes
PCDM_ReaderStatus	myRetrievableStatus

Constructor & Destructor Documentation

CDF_Application::CDF_Application ( )

protected

Member Function Documentation

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 )

removes the document of the current session directory
and closes the document;

Standard_ExtString CDF_Application::DefaultExtension ( )

Standard_ExtString CDF_Application::DefaultFolder ( )

Standard_Boolean CDF_Application::FindReader ( const TCollection_ExtendedString & aFileName )

Standard_Boolean CDF_Application::FindReaderFromFormat ( const TCollection_ExtendedString & aFormat )

Standard_Boolean CDF_Application::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;

virtual void CDF_Application::Formats ( TColStd_SequenceOfExtendedString & Formats )

pure virtual

Implemented in TDocStd_Application, TObj_Application, AppStdL_Application, AppStd_Application, and XCAFApp_Application.

PCDM_ReaderStatus CDF_Application::GetRetrieveStatus ( ) const

Checks status after Retrieve

static Handle_CDF_Application CDF_Application::Load ( const Standard_GUID & aGUID )

static

 plugs an application. <br>

Open is used

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

puts the document in the current session directory
and calls the virtual method Activate on it.

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`
	)

 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

Handle_CDM_Document CDF_Application::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

Standard_Boolean CDF_Application::SetDefaultFolder ( const Standard_ExtString aFolder )

Field Documentation

PCDM_ReaderStatus CDF_Application::myRetrievableStatus

protected

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

CDF_Application.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation