OdBcf::OdBcfArchive Class Reference

#include <BcfArchive.h>

Inheritance diagram for OdBcf::OdBcfArchive:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfArchive)
	OdBcfArchive ()
virtual bool	validate () const
	DECLARE_CONST_ACCESSORS (RootDir, OdBcfArchiveFolderPtr, m_rootDir)
	DECLARE_CONST_ACCESSORS (Version, OdBcfVersionPtr, m_pVersion)
	DECLARE_ACCESSORS (ProjectExtension, OdBcfProjectExtensionPtr, m_pProjectExtension)
	DECLARE_ACCESSORS (Topics, OdBcfTopicFolderMap, m_topics)
	DECLARE_CONST_ACCESSORS (ArchiveGUID, OdGUID, m_archiveGUID)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdSmartPtr< OdBcfArchive >	createObject (const OdBcfArchiveFolderPtr &rootDir, const OdBcfVersionPtr &pVersion, const OdBcfProjectExtensionPtr &pProjectExtension=OdBcfProjectExtensionPtr(), const OdBcfTopicFolderMap &topics=OdBcfTopicFolderMap(), bool changed=false)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Member Functions
	DECLARE_SET (RootDir, OdBcfArchiveFolderPtr, m_rootDir)
	DECLARE_SET (Version, OdBcfVersionPtr, m_pVersion)
	DECLARE_GET (RootDir, OdBcfArchiveFolderPtr, m_rootDir)
	DECLARE_GET (Version, OdBcfVersionPtr, m_pVersion)

Protected Attributes
OdBcfVersionPtr	m_pVersion
OdBcfProjectExtensionPtr	m_pProjectExtension
OdBcfTopicFolderMap	m_topics
OdGUID	m_archiveGUID
OdBcfArchiveFolderPtr	m_rootDir
bool	m_changed
friend	OdBcfSession

Detailed Description

A class that provides functionality for working with project archive.

Definition at line 55 of file BcfArchive.h.

Constructor & Destructor Documentation

OdBcfArchive()

OdBcf::OdBcfArchive::OdBcfArchive

(

)

Creates archive object.

Member Function Documentation

createObject()

static OdSmartPtr<OdBcfArchive> OdBcf::OdBcfArchive::createObject ( const OdBcfArchiveFolderPtr &  rootDir, const OdBcfVersionPtr &  pVersion, const OdBcfProjectExtensionPtr &  pProjectExtension = OdBcfProjectExtensionPtr(), const OdBcfTopicFolderMap &  topics = OdBcfTopicFolderMap(), bool  changed = false  )

static

Creates a new archive object.

Parameters

rootDir	[in] A pointer to archive root directory.
pVersion	[in] A pointer to version of archive.
pProjectExtension	[in] A pointer to project extension of archive.
topics	[in] A map of topics in archive.
changed	[in] A flag that determines whether the archive was changed after creation (equal to true) or not (equal to false).

Returns

Returns a smart pointer to the created <link OdBcf::OdBcfArchive, OdBcfArchive> instance.

DECLARE_ACCESSORS() [1/2]

OdBcf::OdBcfArchive::DECLARE_ACCESSORS	(	ProjectExtension	,
		OdBcfProjectExtensionPtr	,
		m_pProjectExtension
	)

DECLARE_ACCESSORS() [2/2]

OdBcf::OdBcfArchive::DECLARE_ACCESSORS	(	Topics	,
		OdBcfTopicFolderMap	,
		m_topics
	)

DECLARE_CONST_ACCESSORS() [1/3]

OdBcf::OdBcfArchive::DECLARE_CONST_ACCESSORS	(	ArchiveGUID	,
		OdGUID	,
		m_archiveGUID
	)

DECLARE_CONST_ACCESSORS() [2/3]

OdBcf::OdBcfArchive::DECLARE_CONST_ACCESSORS	(	RootDir	,
		OdBcfArchiveFolderPtr	,
		m_rootDir
	)

DECLARE_CONST_ACCESSORS() [3/3]

OdBcf::OdBcfArchive::DECLARE_CONST_ACCESSORS	(	Version	,
		OdBcfVersionPtr	,
		m_pVersion
	)

DECLARE_GET() [1/2]

OdBcf::OdBcfArchive::DECLARE_GET ( RootDir  , OdBcfArchiveFolderPtr  , m_rootDir    )

protected

DECLARE_GET() [2/2]

OdBcf::OdBcfArchive::DECLARE_GET ( Version  , OdBcfVersionPtr  , m_pVersion    )

protected

DECLARE_SET() [1/2]

OdBcf::OdBcfArchive::DECLARE_SET ( RootDir  , OdBcfArchiveFolderPtr  , m_rootDir    )

protected

DECLARE_SET() [2/2]

OdBcf::OdBcfArchive::DECLARE_SET ( Version  , OdBcfVersionPtr  , m_pVersion    )

protected

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfArchive::ODRX_DECLARE_MEMBERS

(

OdBcfArchive

)

validate()

virtual bool OdBcf::OdBcfArchive::validate ( ) const

virtual

Checks if instance has all required fields initialized.

Returns

Returns true if all required fields are initialized; otherwise the method returns false.

Member Data Documentation

m_archiveGUID

OdGUID OdBcf::OdBcfArchive::m_archiveGUID

protected

Definition at line 101 of file BcfArchive.h.

m_changed

bool OdBcf::OdBcfArchive::m_changed

protected

Definition at line 103 of file BcfArchive.h.

m_pProjectExtension

OdBcfProjectExtensionPtr OdBcf::OdBcfArchive::m_pProjectExtension

protected

Definition at line 99 of file BcfArchive.h.

m_pVersion

OdBcfVersionPtr OdBcf::OdBcfArchive::m_pVersion

protected

Definition at line 98 of file BcfArchive.h.

m_rootDir

OdBcfArchiveFolderPtr OdBcf::OdBcfArchive::m_rootDir

protected

Definition at line 102 of file BcfArchive.h.

m_topics

OdBcfTopicFolderMap OdBcf::OdBcfArchive::m_topics

protected

Definition at line 100 of file BcfArchive.h.

OdBcfSession

friend OdBcf::OdBcfArchive::OdBcfSession

protected

Definition at line 110 of file BcfArchive.h.

---

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

• BcfArchive.h