OdBcfTopic Class

Syntax

C++

class OdBcfTopic : public OdBcf::OdBcfElement, protected OdBcfTopicData;

Description

A class that stores and operates a topic data.

Class Hierarchy

File: Bcf_2_1Topic.h

Namespace: OdBcf_2_1

Methods

OdBcfTopic

Creates a new topic object with default parameters.

Data Members

Show:Inherited

No members matching the current filter

m_assignedTo	A string that contains the object the topic is assigned to. (Inherited from OdBcfTopicData)
m_description	A string that contains the topic's description. (Inherited from OdBcfTopicData)
m_index	The topic's index value. (Inherited from OdBcfTopicData)
m_labels	A string array that contains the topic's labels. (Inherited from OdBcfTopicData)
m_pBimSnippet	A smart pointer to the topic's BIM snippet object. (Inherited from OdBcfTopicData)
m_pDueDate	A smart pointer to the timestamp object that contains the topic's due date. (Inherited from OdBcfTopicData)
m_priority	A string that contains the topic's priority value. (Inherited from OdBcfTopicData)
m_referenceLink	A string array that contains reference links to the topic. (Inherited from OdBcfTopicData)
m_stage	A string that contains the topic's stage name. (Inherited from OdBcfTopicData)
m_title	A string that contains the topic's title. (Inherited from OdBcfTopicData)
m_topicStatus	A string that contains the topic's status. (Inherited from OdBcfTopicData)
m_topicType	A string that contains the topic's type. (Inherited from OdBcfTopicData)

Methods

Show:Inherited

No members matching the current filter

getAssignedTo()	This is the overview for the getAssignedTo method overload.
getBimSnippet()	This is the overview for the getBimSnippet method overload.
getCreationAuthor	Retrieves the information about an author that has created the topic.
getCreationDate	Retrieves the topic creation date.
getDescription()	This is the overview for the getDescription method overload.
getDocumentReference	Retrieves the array of documents referenced within the topic.
getDueDate()	This is the overview for the getDueDate method overload.
getGuid	Retrieves the global unique identifier (GUID) of the topic.
getIndex()	This is the overview for the getIndex method overload.
getLabels()	This is the overview for the getLabels method overload.
getModifiedAuthor	Retrieves the information about an author that has modified the topic.
getModifiedDate	Retrieves the date of the last modification of the topic.
getPriority()	This is the overview for the getPriority method overload.
getReferenceLink()	This is the overview for the getReferenceLink method overload.
getRelatedTopic	Retrieves the array of related topics for the topic.
getStage()	This is the overview for the getStage method overload.
getTitle()	This is the overview for the getTitle method overload.
getTopicStatus()	This is the overview for the getTopicStatus method overload.
getTopicType()	This is the overview for the getTopicType method overload.
inFields	Reads XML data into ODA data structures. (Inherited from OdBcfElement)
inFields	Reads XML data into ODA data structures.
isAssignedToUnset	Defines whether the topic's AssignedTo property is not initialized.
isBimSnippetUnset	Defines whether the OdBcfBimSnippet object is not initialized.
isCreationAuthorUnset	Defines whether the data about the author that has created the topic is not initialized.
isCreationDateUnset	Defines whether the topic creation date is not initialized.
isDescriptionUnset	Defines whether the topic description is not initialized.
isDocumentReferenceUnset	Defines whether the array of documents referenced within the topic is not initialized.
isDueDateUnset	Defines whether the topic due date is not initialized.
isGuidUnset	Defines whether the global unique identifier (GUID) of the topic is not initialized.
isIndexUnset	Defines whether the topic index is not initialized.
isLabelsUnset	Defines whether the topic labels are not initialized.
isModifiedAuthorUnset	Defines whether the data about the author that has modified the topic is not initialized.
isModifiedDateUnset	Defines whether the topic modification date is not initialized.
isPriorityUnset	Defines whether the priority value of the topic object is not initialized.
isReferenceLinkUnset	Defines whether the array of reference links associated with the topic object is not initialized.
isRelatedTopicUnset	Defines whether the array of related topics is not initialized.
isStageUnset	Defines whether the topic's Stage property is not initialized.
isTitleUnset	Defines whether the title of the topic object is not initialized.
isTopicStatusUnset	Defines whether the topic status value is not initialized.
isTopicTypeUnset	Defines whether the topic type is not initialized.
outFields	Writes data into XML structures. (Inherited from OdBcfElement)
outFields	Writes data into XML structures.
setAssignedTo	Sets a new value of the AssignedTo property of the topic object.
setBimSnippet	Sets a new BimSnippet object of the topic.
setDescription	Sets the topic description.
setDueDate	Sets a new due date for the topic object.
setIndex	Sets the index of the topic object.
setLabels	Sets the topic labels.
setPriority	Sets the priority of the topic object.
setReferenceLink	Sets an array of reference links for the topic object.
setStage	Sets a new value of the Stage property for the topic object.
setTitle	Sets the title of the topic object.
setTopicStatus	Sets the topic status.
setTopicType	Sets the type of the topic.
validate	Checks whether the BCF datatype instance has all required fields initialized. (Inherited from OdBcfElement)
validate	Checks whether the topic instance has all required fields initialized.

Links

OdBcfTopic Methods

Relief for ODA Team in Ukraine