CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Attributes | List of all members
OdBcf::OdBcfFile Class Reference

#include <BcfFile.h>

Inheritance diagram for OdBcf::OdBcfFile:
OdBcf::OdBcfElement OdBcf::OdBcfFileData OdRxObject

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
 
 DECLARE_ACCESSORS (Filename, OdString, m_filename)
 
 DECLARE_ACCESSORS (Reference, OdString, m_reference)
 
 DECLARE_ACCESSORS (FileAttributes, OdBcfFileAttributesGroup, m_fileAttributes)
 
 DECLARE_ACCESSORS (Date, OdBcfTimeStampPtr, m_pDate)
 
OdBcfFileoperator= (const OdBcfFileData &val)
 
- Public Member Functions inherited from OdBcf::OdBcfElement
 ODRX_DECLARE_MEMBERS (OdBcfElement)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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 OdRxClassdesc ()
 

Detailed Description

A class that contains File data type.

Definition at line 57 of file BcfFile.h.

Constructor & Destructor Documentation

◆ OdBcfFile()

OdBcf::OdBcfFile::OdBcfFile ( )

Creates a new object with default parameters.

Member Function Documentation

◆ DECLARE_ACCESSORS() [1/4]

OdBcf::OdBcfFile::DECLARE_ACCESSORS ( Date  ,
OdBcfTimeStampPtr  ,
m_pDate   
)

◆ DECLARE_ACCESSORS() [2/4]

OdBcf::OdBcfFile::DECLARE_ACCESSORS ( FileAttributes  ,
OdBcfFileAttributesGroup  ,
m_fileAttributes   
)

◆ DECLARE_ACCESSORS() [3/4]

OdBcf::OdBcfFile::DECLARE_ACCESSORS ( Filename  ,
OdString  ,
m_filename   
)

◆ DECLARE_ACCESSORS() [4/4]

OdBcf::OdBcfFile::DECLARE_ACCESSORS ( Reference  ,
OdString  ,
m_reference   
)

◆ inFields()

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

Reads XML data into ODA data structures.

Parameters
pParent[in] A pointer to parent element of the data structure.
Returns
Returns eOk if data was successfully read; otherwise, the method returns an appropriate error.

Implements OdBcf::OdBcfElement.

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfFile::ODRX_DECLARE_MEMBERS ( OdBcfFile  )

◆ operator=()

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

◆ outFields()

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

Writes data into XML structures.

Parameters
pParent[in] A pointer to parent element of the data structure.
Returns
Returns eOk if data was successfully written; otherwise, the method returns an appropriate error.

Implements OdBcf::OdBcfElement.

◆ validate()

virtual bool OdBcf::OdBcfFile::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.

Implements OdBcf::OdBcfElement.

Member Data Documentation

◆ OdBcfSession

friend OdBcf::OdBcfFile::OdBcfSession
protected

Definition at line 100 of file BcfFile.h.


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