OdBcf::OdBcfTopic Class Reference

#include <BcfTopic.h>

Inheritance diagram for OdBcf::OdBcfTopic:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfTopic)
	OdBcfTopic ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
	DECLARE_ACCESSORS (ReferenceLink, OdStringArray, m_referenceLink)
	DECLARE_ACCESSORS (Title, OdString, m_title)
	DECLARE_ACCESSORS (Priority, OdString, m_priority)
	DECLARE_ACCESSORS (Index, OdInt32, m_index)
	DECLARE_ACCESSORS (Labels, OdStringArray, m_labels)
	DECLARE_ACCESSORS (DueDate, OdBcfTimeStampPtr, m_pDueDate)
	DECLARE_ACCESSORS (AssignedTo, OdString, m_assignedTo)
	DECLARE_ACCESSORS (Stage, OdString, m_stage)
	DECLARE_ACCESSORS (Description, OdString, m_description)
	DECLARE_ACCESSORS (BimSnippet, OdBcfBimSnippetPtr, m_pBimSnippet)
	DECLARE_ACCESSORS (TopicType, OdString, m_topicType)
	DECLARE_ACCESSORS (TopicStatus, OdString, m_topicStatus)
	DECLARE_CONST_ACCESSORS (CreationDate, OdBcfTimeStampPtr, m_pCreationDate)
	DECLARE_CONST_ACCESSORS (CreationAuthor, OdString, m_creationAuthor)
	DECLARE_CONST_ACCESSORS (ModifiedDate, OdBcfTimeStampPtr, m_pModifiedDate)
	DECLARE_CONST_ACCESSORS (ModifiedAuthor, OdString, m_modifiedAuthor)
	DECLARE_CONST_ACCESSORS (DocumentReference, OdBcfDocumentReferenceArray, m_documentReference)
	DECLARE_CONST_ACCESSORS (RelatedTopic, OdBcfGUIDAttributeArray, m_relatedTopic)
	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_SET (CreationDate, OdBcfTimeStampPtr, m_pCreationDate)
	DECLARE_SET (CreationAuthor, OdString, m_creationAuthor)
	DECLARE_SET (ModifiedDate, OdBcfTimeStampPtr, m_pModifiedDate)
	DECLARE_SET (ModifiedAuthor, OdString, m_modifiedAuthor)
	DECLARE_SET (DocumentReference, OdBcfDocumentReferenceArray, m_documentReference)
	DECLARE_SET (RelatedTopic, OdBcfGUIDAttributeArray, m_relatedTopic)
	DECLARE_SET (Guid, OdGUID, m_guid)
	DECLARE_GET (CreationDate, OdBcfTimeStampPtr, m_pCreationDate)
	DECLARE_GET (CreationAuthor, OdString, m_creationAuthor)
	DECLARE_GET (ModifiedDate, OdBcfTimeStampPtr, m_pModifiedDate)
	DECLARE_GET (ModifiedAuthor, OdString, m_modifiedAuthor)
	DECLARE_GET (DocumentReference, OdBcfDocumentReferenceArray, m_documentReference)
	DECLARE_GET (RelatedTopic, OdBcfGUIDAttributeArray, m_relatedTopic)
	DECLARE_GET (Guid, OdGUID, m_guid)
OdBcfTopic &	operator= (const OdBcfTopicData &val)

Protected Attributes
friend	OdBcfSession
Protected Attributes inherited from OdBcf::OdBcfTopicData
OdBcfTimeStampPtr	m_pCreationDate
OdString	m_creationAuthor
OdBcfTimeStampPtr	m_pModifiedDate
OdString	m_modifiedAuthor
OdBcfDocumentReferenceArray	m_documentReference
OdBcfGUIDAttributeArray	m_relatedTopic
OdGUID	m_guid
OdStringArray	m_referenceLink
OdString	m_title
OdString	m_priority
OdInt32	m_index
OdStringArray	m_labels
OdBcfTimeStampPtr	m_pDueDate
OdString	m_assignedTo
OdString	m_stage
OdString	m_description
OdBcfBimSnippetPtr	m_pBimSnippet
OdString	m_topicType
OdString	m_topicStatus

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 Topic data type.

Definition at line 87 of file BcfTopic.h.

Constructor & Destructor Documentation

OdBcfTopic()

OdBcf::OdBcfTopic::OdBcfTopic

(

)

Creates a new object with default parameters.

Member Function Documentation

DECLARE_ACCESSORS() [1/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	AssignedTo	,
		OdString	,
		m_assignedTo
	)

DECLARE_ACCESSORS() [2/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	BimSnippet	,
		OdBcfBimSnippetPtr	,
		m_pBimSnippet
	)

DECLARE_ACCESSORS() [3/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	Description	,
		OdString	,
		m_description
	)

DECLARE_ACCESSORS() [4/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	DueDate	,
		OdBcfTimeStampPtr	,
		m_pDueDate
	)

DECLARE_ACCESSORS() [5/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	Index	,
		OdInt32	,
		m_index
	)

DECLARE_ACCESSORS() [6/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	Labels	,
		OdStringArray	,
		m_labels
	)

DECLARE_ACCESSORS() [7/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	Priority	,
		OdString	,
		m_priority
	)

DECLARE_ACCESSORS() [8/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	ReferenceLink	,
		OdStringArray	,
		m_referenceLink
	)

DECLARE_ACCESSORS() [9/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	Stage	,
		OdString	,
		m_stage
	)

DECLARE_ACCESSORS() [10/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	Title	,
		OdString	,
		m_title
	)

DECLARE_ACCESSORS() [11/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	TopicStatus	,
		OdString	,
		m_topicStatus
	)

DECLARE_ACCESSORS() [12/12]

OdBcf::OdBcfTopic::DECLARE_ACCESSORS	(	TopicType	,
		OdString	,
		m_topicType
	)

DECLARE_CONST_ACCESSORS() [1/7]

OdBcf::OdBcfTopic::DECLARE_CONST_ACCESSORS	(	CreationAuthor	,
		OdString	,
		m_creationAuthor
	)

DECLARE_CONST_ACCESSORS() [2/7]

OdBcf::OdBcfTopic::DECLARE_CONST_ACCESSORS	(	CreationDate	,
		OdBcfTimeStampPtr	,
		m_pCreationDate
	)

DECLARE_CONST_ACCESSORS() [3/7]

OdBcf::OdBcfTopic::DECLARE_CONST_ACCESSORS	(	DocumentReference	,
		OdBcfDocumentReferenceArray	,
		m_documentReference
	)

DECLARE_CONST_ACCESSORS() [4/7]

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

DECLARE_CONST_ACCESSORS() [5/7]

OdBcf::OdBcfTopic::DECLARE_CONST_ACCESSORS	(	ModifiedAuthor	,
		OdString	,
		m_modifiedAuthor
	)

DECLARE_CONST_ACCESSORS() [6/7]

OdBcf::OdBcfTopic::DECLARE_CONST_ACCESSORS	(	ModifiedDate	,
		OdBcfTimeStampPtr	,
		m_pModifiedDate
	)

DECLARE_CONST_ACCESSORS() [7/7]

OdBcf::OdBcfTopic::DECLARE_CONST_ACCESSORS	(	RelatedTopic	,
		OdBcfGUIDAttributeArray	,
		m_relatedTopic
	)

DECLARE_GET() [1/7]

OdBcf::OdBcfTopic::DECLARE_GET ( CreationAuthor  , OdString  , m_creationAuthor    )

protected

DECLARE_GET() [2/7]

OdBcf::OdBcfTopic::DECLARE_GET ( CreationDate  , OdBcfTimeStampPtr  , m_pCreationDate    )

protected

DECLARE_GET() [3/7]

OdBcf::OdBcfTopic::DECLARE_GET ( DocumentReference  , OdBcfDocumentReferenceArray  , m_documentReference    )

protected

DECLARE_GET() [4/7]

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

protected

DECLARE_GET() [5/7]

OdBcf::OdBcfTopic::DECLARE_GET ( ModifiedAuthor  , OdString  , m_modifiedAuthor    )

protected

DECLARE_GET() [6/7]

OdBcf::OdBcfTopic::DECLARE_GET ( ModifiedDate  , OdBcfTimeStampPtr  , m_pModifiedDate    )

protected

DECLARE_GET() [7/7]

OdBcf::OdBcfTopic::DECLARE_GET ( RelatedTopic  , OdBcfGUIDAttributeArray  , m_relatedTopic    )

protected

DECLARE_SET() [1/7]

OdBcf::OdBcfTopic::DECLARE_SET ( CreationAuthor  , OdString  , m_creationAuthor    )

protected

DECLARE_SET() [2/7]

OdBcf::OdBcfTopic::DECLARE_SET ( CreationDate  , OdBcfTimeStampPtr  , m_pCreationDate    )

protected

DECLARE_SET() [3/7]

OdBcf::OdBcfTopic::DECLARE_SET ( DocumentReference  , OdBcfDocumentReferenceArray  , m_documentReference    )

protected

DECLARE_SET() [4/7]

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

protected

DECLARE_SET() [5/7]

OdBcf::OdBcfTopic::DECLARE_SET ( ModifiedAuthor  , OdString  , m_modifiedAuthor    )

protected

DECLARE_SET() [6/7]

OdBcf::OdBcfTopic::DECLARE_SET ( ModifiedDate  , OdBcfTimeStampPtr  , m_pModifiedDate    )

protected

DECLARE_SET() [7/7]

OdBcf::OdBcfTopic::DECLARE_SET ( RelatedTopic  , OdBcfGUIDAttributeArray  , m_relatedTopic    )

protected

inFields()

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

(

OdBcfTopic

)

operator=()

OdBcfTopic& OdBcf::OdBcfTopic::operator= ( const OdBcfTopicData &  val )

protected

outFields()

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

protected

Definition at line 162 of file BcfTopic.h.

---

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

• BcfTopic.h