OdBcf::OdBcfComment Class Reference

#include <BcfComment.h>

Inheritance diagram for OdBcf::OdBcfComment:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfComment)
	OdBcfComment ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
	DECLARE_CONST_ACCESSORS (Date, OdBcfTimeStampPtr, m_pDate)
	DECLARE_CONST_ACCESSORS (Author, OdString, m_author)
	DECLARE_ACCESSORS (Comment, OdString, m_comment)
	DECLARE_ACCESSORS (Viewpoint, OdBcfGUIDAttributePtr, m_pViewpoint)
	DECLARE_ACCESSORS (ModifiedDate, OdBcfTimeStampPtr, m_pModifiedDate)
	DECLARE_ACCESSORS (ModifiedAuthor, OdString, m_modifiedAuthor)
	DECLARE_CONST_ACCESSORS (Guid, OdGUID, m_guid)
Public Member Functions inherited from OdBcf::OdBcfElement
	ODRX_DECLARE_MEMBERS (OdBcfElement)
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 Member Functions
	DECLARE_GET (Date, OdBcfTimeStampPtr, m_pDate)
	DECLARE_GET (Author, OdString, m_author)
	DECLARE_GET (Guid, OdGUID, m_guid)
	DECLARE_SET (Date, OdBcfTimeStampPtr, m_pDate)
	DECLARE_SET (Author, OdString, m_author)
	DECLARE_SET (Guid, OdGUID, m_guid)

Protected Attributes
OdBcfTimeStampPtr	m_pDate
OdString	m_author
OdString	m_comment
OdBcfGUIDAttributePtr	m_pViewpoint
OdBcfTimeStampPtr	m_pModifiedDate
OdString	m_modifiedAuthor
OdGUID	m_guid

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

Detailed Description

A class that contains Comment data type.

Definition at line 46 of file BcfComment.h.

Constructor & Destructor Documentation

OdBcfComment()

OdBcf::OdBcfComment::OdBcfComment

(

)

Creates a new object with default parameters.

Member Function Documentation

DECLARE_ACCESSORS() [1/4]

OdBcf::OdBcfComment::DECLARE_ACCESSORS	(	Comment	,
		OdString	,
		m_comment
	)

DECLARE_ACCESSORS() [2/4]

OdBcf::OdBcfComment::DECLARE_ACCESSORS	(	ModifiedAuthor	,
		OdString	,
		m_modifiedAuthor
	)

DECLARE_ACCESSORS() [3/4]

OdBcf::OdBcfComment::DECLARE_ACCESSORS	(	ModifiedDate	,
		OdBcfTimeStampPtr	,
		m_pModifiedDate
	)

DECLARE_ACCESSORS() [4/4]

OdBcf::OdBcfComment::DECLARE_ACCESSORS	(	Viewpoint	,
		OdBcfGUIDAttributePtr	,
		m_pViewpoint
	)

DECLARE_CONST_ACCESSORS() [1/3]

OdBcf::OdBcfComment::DECLARE_CONST_ACCESSORS	(	Author	,
		OdString	,
		m_author
	)

DECLARE_CONST_ACCESSORS() [2/3]

OdBcf::OdBcfComment::DECLARE_CONST_ACCESSORS	(	Date	,
		OdBcfTimeStampPtr	,
		m_pDate
	)

DECLARE_CONST_ACCESSORS() [3/3]

OdBcf::OdBcfComment::DECLARE_CONST_ACCESSORS	(	Guid	,
		OdGUID	,
		m_guid
	)

DECLARE_GET() [1/3]

OdBcf::OdBcfComment::DECLARE_GET ( Author  , OdString  , m_author    )

protected

DECLARE_GET() [2/3]

OdBcf::OdBcfComment::DECLARE_GET ( Date  , OdBcfTimeStampPtr  , m_pDate    )

protected

DECLARE_GET() [3/3]

OdBcf::OdBcfComment::DECLARE_GET ( Guid  , OdGUID  , m_guid    )

protected

DECLARE_SET() [1/3]

OdBcf::OdBcfComment::DECLARE_SET ( Author  , OdString  , m_author    )

protected

DECLARE_SET() [2/3]

OdBcf::OdBcfComment::DECLARE_SET ( Date  , OdBcfTimeStampPtr  , m_pDate    )

protected

DECLARE_SET() [3/3]

OdBcf::OdBcfComment::DECLARE_SET ( Guid  , OdGUID  , m_guid    )

protected

inFields()

virtual OdResult OdBcf::OdBcfComment::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::OdBcfComment::ODRX_DECLARE_MEMBERS

(

OdBcfComment

)

outFields()

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

m_author

OdString OdBcf::OdBcfComment::m_author

protected

Definition at line 90 of file BcfComment.h.

m_comment

OdString OdBcf::OdBcfComment::m_comment

protected

Definition at line 91 of file BcfComment.h.

m_guid

OdGUID OdBcf::OdBcfComment::m_guid

protected

Definition at line 95 of file BcfComment.h.

m_modifiedAuthor

OdString OdBcf::OdBcfComment::m_modifiedAuthor

protected

Definition at line 94 of file BcfComment.h.

m_pDate

OdBcfTimeStampPtr OdBcf::OdBcfComment::m_pDate

protected

Definition at line 89 of file BcfComment.h.

m_pModifiedDate

OdBcfTimeStampPtr OdBcf::OdBcfComment::m_pModifiedDate

protected

Definition at line 93 of file BcfComment.h.

m_pViewpoint

OdBcfGUIDAttributePtr OdBcf::OdBcfComment::m_pViewpoint

protected

Definition at line 92 of file BcfComment.h.

---

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

• BcfComment.h