#include <BcfFile.h>

Inheritance diagram for OdBcf::OdBcfFile:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfFile)

	OdBcfFile ()

virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE

virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE

virtual bool	validate () const ODRX_OVERRIDE

void	setFilename (const OdString &filenameValue)

OdString &	getFilename ()

const OdString &	getFilename () const

bool	isFilenameUnset () const

void	setReference (const OdString &referenceValue)

OdString &	getReference ()

const OdString &	getReference () const

bool	isReferenceUnset () const

void	setFileAttributes (const OdBcfFileAttributesGroup &fileAttributesValue)

OdBcfFileAttributesGroup &	getFileAttributes ()

const OdBcfFileAttributesGroup &	getFileAttributes () const

bool	isFileAttributesUnset () const

void	setDate (const OdBcfTimeStampPtr &dateValue)

OdBcfTimeStampPtr &	getDate ()

const OdBcfTimeStampPtr &	getDate () const

bool	isDateUnset () const

OdBcfFile &	operator= (const OdBcfFileData &val)

Public Member Functions inherited from OdBcf::OdBcfElement
	ODRX_DECLARE_MEMBERS (OdBcfElement)

virtual OdResult	inFields (TiXmlElement *pParent)=0

virtual OdResult	outFields (TiXmlElement *pParent) const =0

virtual bool	validate () const =0

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

Protected Attributes
friend	OdBcfSession

Protected Attributes inherited from OdBcf::OdBcfFileData
OdString	m_filename

OdString	m_reference

OdBcfFileAttributesGroup	m_fileAttributes

OdBcfTimeStampPtr	m_pDate

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

A class that stores and operates data about a BCF file.

Definition at line 72 of file BcfFile.h.

Constructor & Destructor Documentation

◆ OdBcfFile()

OdBcf::OdBcfFile::OdBcfFile ( )

Creates a new file object with default parameters.

Member Function Documentation

◆ getDate() [1/2]

OdBcfTimeStampPtr & OdBcf::OdBcfFile::getDate ( )

Retrieves the date of creation of the file object.

Returns: An <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the creation date.

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

◆ getDate() [2/2]

const OdBcfTimeStampPtr & OdBcf::OdBcfFile::getDate ( ) const

Retrieves the date of creation of the file object.

Returns: An <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the creation date.

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

◆ getFileAttributes() [1/2]

OdBcfFileAttributesGroup & OdBcf::OdBcfFile::getFileAttributes ( )

Retrieves the file attributes.

Returns: An <link OdBcf::OdBcfFileAttributesGroup, OdBcfFileAttributesGroup> object that contains the file attributes.

Remarks: The file attribute object returned by the method can be modified in the calling subroutine.

◆ getFileAttributes() [2/2]

const OdBcfFileAttributesGroup & OdBcf::OdBcfFile::getFileAttributes ( ) const

Retrieves the file attributes.

Returns: An <link OdBcf::OdBcfFileAttributesGroup, OdBcfFileAttributesGroup> object that contains the file attributes.

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

◆ getFilename() [1/2]

OdString & OdBcf::OdBcfFile::getFilename ( )

Retrieves the related BIM file name.

Returns: A string that contains the full name of the file.

Remarks: The related BIM file can have different extensions: IFC, IfcZip, IfcXML, hdf5 and other supported file types. The filename returned by the method can be modified in the calling subroutine.

◆ getFilename() [2/2]

const OdString & OdBcf::OdBcfFile::getFilename ( ) const

Retrieves the related BIM file name.

Returns: A string that contains the full name of the file.

Remarks: The related BIM file can have different extensions: IFC, IfcZip, IfcXML, hdf5 and other supported file types. The filename returned by the method can't be modified in the calling subroutine.

◆ getReference() [1/2]

OdString & OdBcf::OdBcfFile::getReference ( )

Retrieves the reference for the file object.

Returns: A string that contains the reference value.

Remarks: The reference value returned by the method can be modified in the calling subroutine.

◆ getReference() [2/2]

const OdString & OdBcf::OdBcfFile::getReference ( ) const

Retrieves the reference for the file object.

Returns: A string that contains the reference value.

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

◆ inFields()

virtual OdResult OdBcf::OdBcfFile::inFields ( TiXmlElement * pParent )

virtual

Reads XML data into ODA data structures.

Parameters

pParent [in] A pointer to the parent element of the data structure.

Returns: eOk if data was successfully read; otherwise, the method returns an appropriate error code.

Implements OdBcf::OdBcfElement.

◆ isDateUnset()

bool OdBcf::OdBcfFile::isDateUnset ( ) const

Defines whether the file creation date is not initialized.

Returns: true if the file creation date is not initialized; otherwise, the method returns false.

◆ isFileAttributesUnset()

bool OdBcf::OdBcfFile::isFileAttributesUnset ( ) const

Defines whether the file attributes are not initialized.

Returns: true if the file attributes are not initialized; otherwise, the method returns false.

◆ isFilenameUnset()

bool OdBcf::OdBcfFile::isFilenameUnset ( ) const

Defines whether the name of the related BIM file is not initialized.

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

◆ isReferenceUnset()

bool OdBcf::OdBcfFile::isReferenceUnset ( ) const

Defines whether the reference value is not initialized.

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

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfFile::ODRX_DECLARE_MEMBERS ( OdBcfFile )

◆ operator=()

OdBcfFile & OdBcf::OdBcfFile::operator= ( const OdBcfFileData & val )

An assignment operator for BCF file objects. It assigns the \specified content represented with an <link OdBcf::OdBcfFileData, OdBcfFileData> class instance to the file object.

Parameters

val	[in] An <link OdBcf::OdBcfFileData, OdBcfFileData> object that contains data to be assigned with the file object.

Returns: The reference to the file object after the assignment operation ends.

◆ outFields()

virtual OdResult OdBcf::OdBcfFile::outFields ( TiXmlElement * pParent ) const

virtual

Writes data into XML structures.

Parameters

pParent [in] A pointer to the parent element of the data structure.

Returns: eOk if data was successfully written; otherwise, the method returns an appropriate error code.

Implements OdBcf::OdBcfElement.

◆ setDate()

void OdBcf::OdBcfFile::setDate ( const OdBcfTimeStampPtr & dateValue )

Sets a new date of creation for the file object.

Parameters

dateValue [in] An <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the new date value to be set.

◆ setFileAttributes()

void OdBcf::OdBcfFile::setFileAttributes ( const OdBcfFileAttributesGroup & fileAttributesValue )

Sets file attributes.

Parameters

fileAttributesValue [in] An <link OdBcf::OdBcfFileAttributesGroup, OdBcfFileAttributesGroup> object that contains the file attributes.

◆ setFilename()

void OdBcf::OdBcfFile::setFilename ( const OdString & filenameValue )

Sets a new name of the related BIM file.

Parameters

filenameValue [in] A string that contains the new full name of an IFC file.

Remarks: The related BIM file can have different extensions: IFC, IfcZip, IfcXML, hdf5 and other supported file types.

◆ setReference()

void OdBcf::OdBcfFile::setReference ( const OdString & referenceValue )

Sets a new reference value for the file object.

Parameters

referenceValue [in] A string that contains the new reference value.

◆ validate()

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

virtual

Checks whether the file instance has all required fields initialized.

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

Implements OdBcf::OdBcfElement.

Member Data Documentation

◆ OdBcfSession

friend OdBcf::OdBcfFile::OdBcfSession

protected

Definition at line 233 of file BcfFile.h.

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

BcfFile.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdBcfFile()

Member Function Documentation

◆ getDate() [1/2]

◆ getDate() [2/2]

◆ getFileAttributes() [1/2]

◆ getFileAttributes() [2/2]

◆ getFilename() [1/2]

◆ getFilename() [2/2]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ inFields()

◆ isDateUnset()

◆ isFileAttributesUnset()

◆ isFilenameUnset()

◆ isReferenceUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ operator=()

◆ outFields()

◆ setDate()

◆ setFileAttributes()

◆ setFilename()

◆ setReference()

◆ validate()

Member Data Documentation

◆ OdBcfSession