Open CASCADE Technology  7.7.0.dev
Public Member Functions

CDF_Store Class Reference

#include <CDF_Store.hxx>

Public Member Functions

 CDF_Store (const Handle< CDM_Document > &aDocument)
 creates a store list from the document of the current selection. More...
 
Handle< TCollection_HExtendedStringFolder () const
 returns the folder in which the current document will be stored. More...
 
Handle< TCollection_HExtendedStringName () const
 returns the name under which the current document will be stored More...
 
Standard_Boolean IsStored () const
 returns true if the current document is already stored More...
 
Standard_Boolean IsModified () const
 
Standard_Boolean CurrentIsConsistent () const
 
Standard_Boolean IsConsistent () const
 
Standard_Boolean HasAPreviousVersion () const
 
Handle< TCollection_HExtendedStringPreviousVersion () const
 
Standard_Boolean IsMainDocument () const
 returns true if the currentdocument is the main one, ie the document of the current selection. More...
 
Standard_Boolean SetFolder (const TCollection_ExtendedString &aFolder)
 defines the folder in which the document should be stored. returns Standard_True if the Folder exists, Standard_False otherwise. More...
 
CDF_StoreSetNameStatus SetName (const Standard_ExtString aName)
 defines the name under which the document should be stored. More...
 
void SetComment (const Standard_ExtString aComment)
 
Handle< TCollection_HExtendedStringComment () const
 
CDF_StoreSetNameStatus RecheckName ()
 defines the name under which the document should be stored. uses for example after modification of the folder. More...
 
Standard_Boolean SetPreviousVersion (const Standard_ExtString aPreviousVersion)
 
void Realize (const Message_ProgressRange &theRange=Message_ProgressRange())
 
Standard_ExtString Path () const
 returns the complete path of the created meta-data. More...
 
Handle< TCollection_HExtendedStringMetaDataPath () const
 returns the path of the previous store is the object is already stored, otherwise an empty string; More...
 
Handle< TCollection_HExtendedStringDescription () const
 returns the description of the format of the main object. More...
 
void SetCurrent (const Standard_ExtString aPresentation)
 
void SetMain ()
 the two following methods can be used just after Realize or Import – method to know if thes methods worked correctly, and if not why. More...
 
PCDM_StoreStatus StoreStatus () const
 
Standard_ExtString AssociatedStatusText () const
 
CDF_StoreSetNameStatus SetName (const TCollection_ExtendedString &aName)
 defines the name under which the document should be stored. More...
 
Standard_Boolean SetFolder (const Standard_ExtString aFolder)
 defines the folder in which the document should be stored. returns Standard_True if the Folder exists, Standard_False otherwise. More...
 

Constructor & Destructor Documentation

◆ CDF_Store()

CDF_Store::CDF_Store ( const Handle< CDM_Document > &  aDocument)

creates a store list from the document of the current selection.

Member Function Documentation

◆ AssociatedStatusText()

Standard_ExtString CDF_Store::AssociatedStatusText ( ) const

◆ Comment()

Handle< TCollection_HExtendedString > CDF_Store::Comment ( ) const

◆ CurrentIsConsistent()

Standard_Boolean CDF_Store::CurrentIsConsistent ( ) const

◆ Description()

Handle< TCollection_HExtendedString > CDF_Store::Description ( ) const

returns the description of the format of the main object.

◆ Folder()

Handle< TCollection_HExtendedString > CDF_Store::Folder ( ) const

returns the folder in which the current document will be stored.

◆ HasAPreviousVersion()

Standard_Boolean CDF_Store::HasAPreviousVersion ( ) const

◆ IsConsistent()

Standard_Boolean CDF_Store::IsConsistent ( ) const

◆ IsMainDocument()

Standard_Boolean CDF_Store::IsMainDocument ( ) const

returns true if the currentdocument is the main one, ie the document of the current selection.

◆ IsModified()

Standard_Boolean CDF_Store::IsModified ( ) const

◆ IsStored()

Standard_Boolean CDF_Store::IsStored ( ) const

returns true if the current document is already stored

◆ MetaDataPath()

Handle< TCollection_HExtendedString > CDF_Store::MetaDataPath ( ) const

returns the path of the previous store is the object is already stored, otherwise an empty string;

◆ Name()

Handle< TCollection_HExtendedString > CDF_Store::Name ( ) const

returns the name under which the current document will be stored

◆ Path()

Standard_ExtString CDF_Store::Path ( ) const

returns the complete path of the created meta-data.

◆ PreviousVersion()

Handle< TCollection_HExtendedString > CDF_Store::PreviousVersion ( ) const

◆ Realize()

void CDF_Store::Realize ( const Message_ProgressRange theRange = Message_ProgressRange())

◆ RecheckName()

CDF_StoreSetNameStatus CDF_Store::RecheckName ( )

defines the name under which the document should be stored. uses for example after modification of the folder.

◆ SetComment()

void CDF_Store::SetComment ( const Standard_ExtString  aComment)

◆ SetCurrent()

void CDF_Store::SetCurrent ( const Standard_ExtString  aPresentation)

◆ SetFolder() [1/2]

Standard_Boolean CDF_Store::SetFolder ( const Standard_ExtString  aFolder)

defines the folder in which the document should be stored. returns Standard_True if the Folder exists, Standard_False otherwise.

◆ SetFolder() [2/2]

Standard_Boolean CDF_Store::SetFolder ( const TCollection_ExtendedString aFolder)

defines the folder in which the document should be stored. returns Standard_True if the Folder exists, Standard_False otherwise.

◆ SetMain()

void CDF_Store::SetMain ( )

the two following methods can be used just after Realize or Import – method to know if thes methods worked correctly, and if not why.

◆ SetName() [1/2]

CDF_StoreSetNameStatus CDF_Store::SetName ( const Standard_ExtString  aName)

defines the name under which the document should be stored.

◆ SetName() [2/2]

CDF_StoreSetNameStatus CDF_Store::SetName ( const TCollection_ExtendedString aName)

defines the name under which the document should be stored.

◆ SetPreviousVersion()

Standard_Boolean CDF_Store::SetPreviousVersion ( const Standard_ExtString  aPreviousVersion)

◆ StoreStatus()

PCDM_StoreStatus CDF_Store::StoreStatus ( ) const

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