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

#include <BcfProject.h>

Inheritance diagram for OdBcf::OdBcfProject:
OdBcf::OdBcfElement OdBcf::OdBcfProjectData OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfProject)
 
 OdBcfProject ()
 
virtual OdResult inFields (TiXmlElement *pParent) ODRX_OVERRIDE
 
virtual OdResult outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
 
virtual bool validate () const ODRX_OVERRIDE
 
 DECLARE_ACCESSORS (Name, OdString, m_name)
 
 DECLARE_CONST_ACCESSORS (ProjectId, OdString, m_projectId)
 
- 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 Member Functions

 DECLARE_GET (ProjectId, OdString, m_projectId)
 
 DECLARE_SET (ProjectId, OdString, m_projectId)
 
OdBcfProjectoperator= (const OdBcfProjectData &val)
 

Protected Attributes

friend OdBcfSession
 
- Protected Attributes inherited from OdBcf::OdBcfProjectData
OdString m_projectId
 
OdString m_name
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

A class that contains Project data type.

Definition at line 52 of file BcfProject.h.

Constructor & Destructor Documentation

◆ OdBcfProject()

OdBcf::OdBcfProject::OdBcfProject ( )

Creates a new object with default parameters.

Member Function Documentation

◆ DECLARE_ACCESSORS()

OdBcf::OdBcfProject::DECLARE_ACCESSORS ( Name  ,
OdString  ,
m_name   
)

◆ DECLARE_CONST_ACCESSORS()

OdBcf::OdBcfProject::DECLARE_CONST_ACCESSORS ( ProjectId  ,
OdString  ,
m_projectId   
)

◆ DECLARE_GET()

OdBcf::OdBcfProject::DECLARE_GET ( ProjectId  ,
OdString  ,
m_projectId   
)
protected

◆ DECLARE_SET()

OdBcf::OdBcfProject::DECLARE_SET ( ProjectId  ,
OdString  ,
m_projectId   
)
protected

◆ inFields()

virtual OdResult OdBcf::OdBcfProject::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::OdBcfProject::ODRX_DECLARE_MEMBERS ( OdBcfProject  )

◆ operator=()

OdBcfProject& OdBcf::OdBcfProject::operator= ( const OdBcfProjectData val)
protected

◆ outFields()

virtual OdResult OdBcf::OdBcfProject::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::OdBcfProject::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::OdBcfProject::OdBcfSession
protected

Definition at line 95 of file BcfProject.h.


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