#include <BcfArchive.h>

Inheritance diagram for OdBcf::OdBcfArchive:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfArchive)

	OdBcfArchive ()

virtual bool	validate () const

const OdBcfArchiveFolderPtr &	getRootDir () const

bool	isRootDirUnset () const

const OdBcfVersionPtr &	getVersion () const

bool	isVersionUnset () const

void	setProjectExtension (const OdBcfProjectExtensionPtr &projectExtensionValue)

OdBcfProjectExtensionPtr &	getProjectExtension ()

const OdBcfProjectExtensionPtr &	getProjectExtension () const

bool	isProjectExtensionUnset () const

void	setTopics (const OdBcfTopicFolderMap &topicsValue)

OdBcfTopicFolderMap &	getTopics ()

const OdBcfTopicFolderMap &	getTopics () const

bool	isTopicsUnset () const

const OdGUID &	getArchiveGUID () const

bool	isArchiveGUIDUnset () const

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
void	setRootDir (const OdBcfArchiveFolderPtr &rootDirValue)

void	setVersion (const OdBcfVersionPtr &versionValue)

OdBcfArchiveFolderPtr &	getRootDir ()

OdBcfVersionPtr &	getVersion ()

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 a new archive object with default parameters.

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 the 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 the archive.
changed	[in] A flag that determines whether the archive was changed after creation (equal to true) or not (equal to false).

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

◆ getArchiveGUID()

const OdGUID & OdBcf::OdBcfArchive::getArchiveGUID ( ) const

Retrieves the archive's global unique identifier (GUID).

Returns: An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that represents the identifier.

◆ getProjectExtension() [1/2]

OdBcfProjectExtensionPtr & OdBcf::OdBcfArchive::getProjectExtension ( )

Retrieves the archive's project extension.

Returns: A smart pointer to the <link OdBcf::OdBcfProjectExtension, OdBcfProjectExtension> object that represents the project extension.

Remarks: The project extension object returned by the method can be modified in the calling subroutine.

◆ getProjectExtension() [2/2]

const OdBcfProjectExtensionPtr & OdBcf::OdBcfArchive::getProjectExtension ( ) const

Retrieves the archive's project extension.

Returns: A smart pointer to the <link OdBcf::OdBcfProjectExtension, OdBcfProjectExtension> object that represents the project extension.

Remarks: The project extension object returned by the method can't be modified in the calling subroutine.

◆ getRootDir() [1/2]

OdBcfArchiveFolderPtr & OdBcf::OdBcfArchive::getRootDir ( )

protected

Retrieves the archive's root directory.

Returns: A smart pointer to the <link OdBcf::OdBcfArchiveFolder, OdBcfArchiveFolder> object that represents the root directory.

Remarks: The object that represents the root directory returned by the method can be modified in the calling subroutine.

◆ getRootDir() [2/2]

const OdBcfArchiveFolderPtr & OdBcf::OdBcfArchive::getRootDir ( ) const

Retrieves the archive's root directory.

Returns: A smart pointer to the <link OdBcf::OdBcfArchiveFolder, OdBcfArchiveFolder> object that represents the root directory.

Remarks: The root directory object returned by the method can't be modified in the calling subroutine.

◆ getTopics() [1/2]

OdBcfTopicFolderMap & OdBcf::OdBcfArchive::getTopics ( )

Retrieves the archive's topic folders.

Returns: A map of the <link OdBcf::OdBcfTopicFolder, OdBcfTopicFolder> objects.

Remarks: The project extension object returned by the method can be modified in the calling subroutine.

◆ getTopics() [2/2]

const OdBcfTopicFolderMap & OdBcf::OdBcfArchive::getTopics ( ) const

Retrieves the archive's topic folders.

Returns: A map of the <link OdBcf::OdBcfTopicFolder, OdBcfTopicFolder> objects.

Remarks: The project extension object returned by the method can't be modified in the calling subroutine.

◆ getVersion() [1/2]

OdBcfVersionPtr & OdBcf::OdBcfArchive::getVersion ( )

protected

Retrieves the archive's version.

Returns: A smart pointer to the <link OdBcf::OdBcfVersion, OdBcfVersion> object that represents the version.

Remarks: The object that represents the version returned by the method can be modified in the calling subroutine.

◆ getVersion() [2/2]

const OdBcfVersionPtr & OdBcf::OdBcfArchive::getVersion ( ) const

Retrieves the archive's version.

Returns: A smart pointer to the <link OdBcf::OdBcfVersion, OdBcfVersion> object that represents the version.

Remarks: The version object returned by the method can't be modified in the calling subroutine.

◆ isArchiveGUIDUnset()

bool OdBcf::OdBcfArchive::isArchiveGUIDUnset ( ) const

Defines whether the archive's global unique identifier (GUID) is not initialized.

Returns: true if the GUID is not initialized; otherwise, the method returns false.

◆ isProjectExtensionUnset()

bool OdBcf::OdBcfArchive::isProjectExtensionUnset ( ) const

Defines whether the archive's project extension is not initialized.

Returns: true if the project extension is not initialized; otherwise, the method returns false.

◆ isRootDirUnset()

bool OdBcf::OdBcfArchive::isRootDirUnset ( ) const

Defines whether the archive's root directory is not initialized.

Returns: true if the root directory is not initialized; otherwise, the method returns false.

◆ isTopicsUnset()

bool OdBcf::OdBcfArchive::isTopicsUnset ( ) const

Defines whether the archive's topic folders are not initialized.

Returns: true if the topic folders map is not initialized; otherwise, the method returns false.

◆ isVersionUnset()

bool OdBcf::OdBcfArchive::isVersionUnset ( ) const

Defines whether the archive's version is not initialized.

Returns: true if the version is not initialized; otherwise, the method returns false.

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfArchive::ODRX_DECLARE_MEMBERS ( OdBcfArchive )

◆ setProjectExtension()

void OdBcf::OdBcfArchive::setProjectExtension ( const OdBcfProjectExtensionPtr & projectExtensionValue )

Sets a new project extension object for the archive.

Parameters

projectExtensionValue [in] A smart pointer to the <link OdBcf::OdBcfProjectExtension, OdBcfProjectExtension> object to be set.

◆ setRootDir()

void OdBcf::OdBcfArchive::setRootDir ( const OdBcfArchiveFolderPtr & rootDirValue )

protected

Sets a new root directory for the archive.

Parameters

rootDirValue [in] A smart pointer to the <link OdBcf::OdBcfArchiveFolder, OdBcfArchiveFolder> object to be set as a root directory.

◆ setTopics()

void OdBcf::OdBcfArchive::setTopics ( const OdBcfTopicFolderMap & topicsValue )

Sets new topic folders for the archive.

Parameters

topicsValue [in] A smart pointer to the map of <link OdBcf::OdBcfTopicFolder, OdBcfTopicFolder> objects to be set as archive topics.

◆ setVersion()

void OdBcf::OdBcfArchive::setVersion ( const OdBcfVersionPtr & versionValue )

protected

Sets a new version for the archive.

Parameters

versionValue [in] A smart pointer to the <link OdBcf::OdBcfVersion, version> object to be set.

◆ validate()

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

virtual

Checks whether the instance has all required fields initialized.

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 191 of file BcfArchive.h.

◆ m_changed

bool OdBcf::OdBcfArchive::m_changed

protected

Definition at line 193 of file BcfArchive.h.

◆ m_pProjectExtension

OdBcfProjectExtensionPtr OdBcf::OdBcfArchive::m_pProjectExtension

protected

Definition at line 189 of file BcfArchive.h.

◆ m_pVersion

OdBcfVersionPtr OdBcf::OdBcfArchive::m_pVersion

protected

Definition at line 188 of file BcfArchive.h.

◆ m_rootDir

OdBcfArchiveFolderPtr OdBcf::OdBcfArchive::m_rootDir

protected

Definition at line 192 of file BcfArchive.h.

◆ m_topics

OdBcfTopicFolderMap OdBcf::OdBcfArchive::m_topics

protected

Definition at line 190 of file BcfArchive.h.

◆ OdBcfSession

friend OdBcf::OdBcfArchive::OdBcfSession

protected

Definition at line 224 of file BcfArchive.h.

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

BcfArchive.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OdBcfArchive()

Member Function Documentation

◆ createObject()

◆ getArchiveGUID()

◆ getProjectExtension() [1/2]

◆ getProjectExtension() [2/2]

◆ getRootDir() [1/2]

◆ getRootDir() [2/2]

◆ getTopics() [1/2]

◆ getTopics() [2/2]

◆ getVersion() [1/2]

◆ getVersion() [2/2]

◆ isArchiveGUIDUnset()

◆ isProjectExtensionUnset()

◆ isRootDirUnset()

◆ isTopicsUnset()

◆ isVersionUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ setProjectExtension()

◆ setRootDir()

◆ setTopics()

◆ setVersion()

◆ validate()

Member Data Documentation

◆ m_archiveGUID

◆ m_changed

◆ m_pProjectExtension

◆ m_pVersion

◆ m_rootDir

◆ m_topics

◆ OdBcfSession