CDF_Store Class Reference

#include <CDF_Store.hxx>

Public Member Functions
	CDF_Store (const occ::handle< CDM_Document > &aDocument)
	creates a store list from the document of the current selection.
occ::handle< TCollection_HExtendedString >	Folder () const
	returns the folder in which the current document will be stored.
occ::handle< TCollection_HExtendedString >	Name () const
	returns the name under which the current document will be stored
bool	IsStored () const
	returns true if the current document is already stored
bool	IsModified () const
bool	CurrentIsConsistent () const
bool	IsConsistent () const
bool	HasAPreviousVersion () const
occ::handle< TCollection_HExtendedString >	PreviousVersion () const
bool	IsMainDocument () const
	returns true if the currentdocument is the main one, ie the document of the current selection.
bool	SetFolder (const TCollection_ExtendedString &aFolder)
	defines the folder in which the document should be stored. returns true if the Folder exists, false otherwise.
CDF_StoreSetNameStatus	SetName (const char16_t *const aName)
	defines the name under which the document should be stored.
void	SetComment (const char16_t *const aComment)
occ::handle< TCollection_HExtendedString >	Comment () const
CDF_StoreSetNameStatus	RecheckName ()
	defines the name under which the document should be stored. uses for example after modification of the folder.
bool	SetPreviousVersion (const char16_t *const aPreviousVersion)
void	Realize (const Message_ProgressRange &theRange=Message_ProgressRange())
const char16_t *	Path () const
	returns the complete path of the created meta-data.
occ::handle< TCollection_HExtendedString >	MetaDataPath () const
	returns the path of the previous store is the object is already stored, otherwise an empty string;
occ::handle< TCollection_HExtendedString >	Description () const
	returns the description of the format of the main object.
void	SetCurrent (const char16_t *const aPresentation)
void	SetMain ()
	the two following methods can be used just after Realize or Import – method to know if these methods worked correctly, and if not why.
PCDM_StoreStatus	StoreStatus () const
const char16_t *	AssociatedStatusText () const
CDF_StoreSetNameStatus	SetName (const TCollection_ExtendedString &aName)
	defines the name under which the document should be stored.
bool	SetFolder (const char16_t *const aFolder)
	defines the folder in which the document should be stored. returns true if the Folder exists, false otherwise.

Constructor & Destructor Documentation

CDF_Store()

CDF_Store::CDF_Store

(

const occ::handle< CDM_Document > &

aDocument

)

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

Member Function Documentation

AssociatedStatusText()

const char16_t * CDF_Store::AssociatedStatusText

(

)

const

Comment()

occ::handle< TCollection_HExtendedString > CDF_Store::Comment

(

)

const

CurrentIsConsistent()

bool CDF_Store::CurrentIsConsistent

(

)

const

Description()

occ::handle< TCollection_HExtendedString > CDF_Store::Description

(

)

const

returns the description of the format of the main object.

Folder()

occ::handle< TCollection_HExtendedString > CDF_Store::Folder

(

)

const

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

HasAPreviousVersion()

bool CDF_Store::HasAPreviousVersion

(

)

const

IsConsistent()

bool CDF_Store::IsConsistent

(

)

const

IsMainDocument()

bool CDF_Store::IsMainDocument

(

)

const

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

IsModified()

bool CDF_Store::IsModified

(

)

const

IsStored()

bool CDF_Store::IsStored

(

)

const

returns true if the current document is already stored

MetaDataPath()

occ::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()

occ::handle< TCollection_HExtendedString > CDF_Store::Name

(

)

const

returns the name under which the current document will be stored

Path()

const char16_t * CDF_Store::Path

(

)

const

returns the complete path of the created meta-data.

PreviousVersion()

occ::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 char16_t *const

aComment

)

SetCurrent()

void CDF_Store::SetCurrent

(

const char16_t *const

aPresentation

)

SetFolder() [1/2]

bool CDF_Store::SetFolder

(

const char16_t *const

aFolder

)

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

SetFolder() [2/2]

bool CDF_Store::SetFolder

(

const TCollection_ExtendedString &

aFolder

)

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

SetMain()

void CDF_Store::SetMain

(

)

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

SetName() [1/2]

CDF_StoreSetNameStatus CDF_Store::SetName

(

const char16_t *const

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

bool CDF_Store::SetPreviousVersion

(

const char16_t *const

aPreviousVersion

)

StoreStatus()

PCDM_StoreStatus CDF_Store::StoreStatus

(

)

const

---

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

• CDF_Store.hxx