OdBcf::OdBcfHeader Class Reference

#include <BcfHeader.h>

Inheritance diagram for OdBcf::OdBcfHeader:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfHeader)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
void	setFile (const OdBcfFileArray &fileValue)
OdBcfFileArray &	getFile ()
const OdBcfFileArray &	getFile () const
bool	isFileUnset () const
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

Static Public Member Functions
static OdSmartPtr< OdBcfHeader >	createObject (const OdBcfFileArray &file)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfFileArray	m_file

Detailed Description

A class that stores and operates header data of a BCF file.

Definition at line 48 of file BcfHeader.h.

Member Function Documentation

createObject()

static OdSmartPtr< OdBcfHeader > OdBcf::OdBcfHeader::createObject ( const OdBcfFileArray &  file )

static

Creates a new header object from specified BCF files.

Parameters

file	[in] An array of smart pointers to BCF files objects.

Returns

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

getFile() [1/2]

OdBcfFileArray & OdBcf::OdBcfHeader::getFile

(

)

Retrieves files associated with the header object.

Returns

An array of smart pointers to <link OdBcf::OdBcfFile, OdBcfFile> objects.

Remarks

The array returned by the method can be modified in the calling subroutine.

getFile() [2/2]

const OdBcfFileArray & OdBcf::OdBcfHeader::getFile

(

)

const

Retrieves files associated with the header object.

Returns

An array of smart pointers to <link OdBcf::OdBcfFile, OdBcfFile> objects.

Remarks

The array returned by the method can't be modified in the calling subroutine.

inFields()

virtual OdResult OdBcf::OdBcfHeader::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.

isFileUnset()

bool OdBcf::OdBcfHeader::isFileUnset

(

)

const

Defines whether the array of file object associated with the header is not initialized.

Returns

true if the file array is not initialized; otherwise, the method returns false.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfHeader::ODRX_DECLARE_MEMBERS

(

OdBcfHeader

)

outFields()

virtual OdResult OdBcf::OdBcfHeader::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.

setFile()

void OdBcf::OdBcfHeader::setFile

(

const OdBcfFileArray &

fileValue

)

Sets file associated with the header object.

Parameters

fileValue

[in] An array of smart pointers to <link OdBcf::OdBcfFile, OdBcfFile> objects to be set.

validate()

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

virtual

Checks whether the header 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

m_file

OdBcfFileArray OdBcf::OdBcfHeader::m_file

protected

Definition at line 114 of file BcfHeader.h.

---

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

• BcfHeader.h