CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdBcf::OdBcfTopic Class Reference

#include <BcfTopic.h>

Inheritance diagram for OdBcf::OdBcfTopic:
OdBcf::OdBcfElement OdBcf::OdBcfTopicData OdRxObject

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
 
void setReferenceLink (const OdStringArray &referenceLinkValue)
 
OdStringArray & getReferenceLink ()
 
const OdStringArray & getReferenceLink () const
 
bool isReferenceLinkUnset () const
 
void setTitle (const OdString &titleValue)
 
OdString & getTitle ()
 
const OdString & getTitle () const
 
bool isTitleUnset () const
 
void setPriority (const OdString &priorityValue)
 
OdString & getPriority ()
 
const OdString & getPriority () const
 
bool isPriorityUnset () const
 
void setIndex (const OdInt32 &indexValue)
 
OdInt32 & getIndex ()
 
const OdInt32 & getIndex () const
 
bool isIndexUnset () const
 
void setLabels (const OdStringArray &labelsValue)
 
OdStringArray & getLabels ()
 
const OdStringArray & getLabels () const
 
bool isLabelsUnset () const
 
void setDueDate (const OdBcfTimeStampPtr &dueDateValue)
 
OdBcfTimeStampPtr & getDueDate ()
 
const OdBcfTimeStampPtr & getDueDate () const
 
bool isDueDateUnset () const
 
void setAssignedTo (const OdString &assignedToValue)
 
OdString & getAssignedTo ()
 
const OdString & getAssignedTo () const
 
bool isAssignedToUnset () const
 
void setStage (const OdString &stageValue)
 
OdString & getStage ()
 
const OdString & getStage () const
 
bool isStageUnset () const
 
void setDescription (const OdString &descriptionValue)
 
OdString & getDescription ()
 
const OdString & getDescription () const
 
bool isDescriptionUnset () const
 
void setBimSnippet (const OdBcfBimSnippetPtr &bimSnippetValue)
 
OdBcfBimSnippetPtr & getBimSnippet ()
 
const OdBcfBimSnippetPtr & getBimSnippet () const
 
bool isBimSnippetUnset () const
 
void setTopicType (const OdString &topicTypeValue)
 
OdString & getTopicType ()
 
const OdString & getTopicType () const
 
bool isTopicTypeUnset () const
 
void setTopicStatus (const OdString &topicStatusValue)
 
OdString & getTopicStatus ()
 
const OdString & getTopicStatus () const
 
bool isTopicStatusUnset () const
 
const OdBcfTimeStampPtr & getCreationDate () const
 
bool isCreationDateUnset () const
 
const OdString & getCreationAuthor () const
 
bool isCreationAuthorUnset () const
 
const OdBcfTimeStampPtr & getModifiedDate () const
 
bool isModifiedDateUnset () const
 
const OdString & getModifiedAuthor () const
 
bool isModifiedAuthorUnset () const
 
const OdBcfDocumentReferenceArray & getDocumentReference () const
 
bool isDocumentReferenceUnset () const
 
const OdBcfGUIDAttributeArray & getRelatedTopic () const
 
bool isRelatedTopicUnset () const
 
const OdGUID & getGuid () const
 
bool isGuidUnset () const
 
- Public Member Functions inherited from OdBcf::OdBcfElement
 ODRX_DECLARE_MEMBERS (OdBcfElement)
 
virtual OdResult inFields (TiXmlElement *pParent)=0
 
virtual OdResult outFields (TiXmlElement *pParent) const =0
 
virtual bool validate () const =0
 
- 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

void setCreationDate (const OdBcfTimeStampPtr &creationDateValue)
 
void setCreationAuthor (const OdString &creationAuthorValue)
 
void setModifiedDate (const OdBcfTimeStampPtr &modifiedDateValue)
 
void setModifiedAuthor (const OdString &modifiedAuthorValue)
 
void setDocumentReference (const OdBcfDocumentReferenceArray &documentReferenceValue)
 
void setRelatedTopic (const OdBcfGUIDAttributeArray &relatedTopicValue)
 
void setGuid (const OdGUID &guidValue)
 
OdBcfTimeStampPtr & getCreationDate ()
 
OdString & getCreationAuthor ()
 
OdBcfTimeStampPtr & getModifiedDate ()
 
OdString & getModifiedAuthor ()
 
OdBcfDocumentReferenceArray & getDocumentReference ()
 
OdBcfGUIDAttributeArray & getRelatedTopic ()
 
OdGUID & getGuid ()
 
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 stores and operates a topic data.

Definition at line 174 of file BcfTopic.h.

Constructor & Destructor Documentation

◆ OdBcfTopic()

OdBcf::OdBcfTopic::OdBcfTopic ( )

Creates a new topic object with default parameters.

Member Function Documentation

◆ getAssignedTo() [1/2]

OdString & OdBcf::OdBcfTopic::getAssignedTo ( )

Retrieves the topic's AssignedTo property value.

Returns
A string that contains the AssignedTo property value.
Remarks
The property value returned by the method can be modified in the calling subroutine.

◆ getAssignedTo() [2/2]

const OdString & OdBcf::OdBcfTopic::getAssignedTo ( ) const

Retrieves the topic's AssignedTo property value.

Returns
A string that contains the AssignedTo property value.
Remarks
The property value returned by the method can't be modified in the calling subroutine.

◆ getBimSnippet() [1/2]

OdBcfBimSnippetPtr & OdBcf::OdBcfTopic::getBimSnippet ( )

Retrieves the <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object associated with the topic.

Returns
A smart pointer to the <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object.
Remarks
The <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object returned by the method can be modified in the calling subroutine.

◆ getBimSnippet() [2/2]

const OdBcfBimSnippetPtr & OdBcf::OdBcfTopic::getBimSnippet ( ) const

Retrieves the <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object associated with the topic.

Returns
A smart pointer to the <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object.
Remarks
The <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object returned by the method can't be modified in the calling subroutine.

◆ getCreationAuthor() [1/2]

OdString & OdBcf::OdBcfTopic::getCreationAuthor ( )
protected

Retrieves the information about an author that has created the topic.

Returns
A string that contains data about the creator of the topic.
Remarks
The string returned by the method can be modified in the calling subroutine.

◆ getCreationAuthor() [2/2]

const OdString & OdBcf::OdBcfTopic::getCreationAuthor ( ) const

Retrieves the information about an author that has created the topic.

Returns
A string that contains data about the creator of the topic.
Remarks
The string returned by the method can't be modified in the calling subroutine.

◆ getCreationDate() [1/2]

OdBcfTimeStampPtr & OdBcf::OdBcfTopic::getCreationDate ( )
protected

Retrieves the topic creation date.

Returns
A smart pointer to an <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the creation date.
Remarks
The timestamp object returned by the method can be modified in the calling subroutine.

◆ getCreationDate() [2/2]

const OdBcfTimeStampPtr & OdBcf::OdBcfTopic::getCreationDate ( ) const

Retrieves the topic creation date.

Returns
A smart pointer to an <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the creation date.
Remarks
The timestamp object returned by the method can't be modified in the calling subroutine.

◆ getDescription() [1/2]

OdString & OdBcf::OdBcfTopic::getDescription ( )

Retrieves the topic description.

Returns
A string that contains the description.
Remarks
The description returned by the method can be modified in the calling subroutine.

◆ getDescription() [2/2]

const OdString & OdBcf::OdBcfTopic::getDescription ( ) const

Retrieves the topic description.

Returns
A string that contains the description.
Remarks
The description returned by the method can't be modified in the calling subroutine.

◆ getDocumentReference() [1/2]

OdBcfDocumentReferenceArray & OdBcf::OdBcfTopic::getDocumentReference ( )
protected

Retrieves the array of documents referenced within the topic.

Returns
An array of smart pointers to <link OdBcf::OdBcfDocumentReference, OdBcfDocumentReference> objects.
Remarks
The array returned by the method can be modified in the calling subroutine.

◆ getDocumentReference() [2/2]

const OdBcfDocumentReferenceArray & OdBcf::OdBcfTopic::getDocumentReference ( ) const

Retrieves the array of documents referenced within the topic.

Returns
An array of smart pointers to <link OdBcf::OdBcfDocumentReference, OdBcfDocumentReference> objects.
Remarks
The array returned by the method can't be modified in the calling subroutine.

◆ getDueDate() [1/2]

OdBcfTimeStampPtr & OdBcf::OdBcfTopic::getDueDate ( )

Retrieves the topic due date.

Returns
A smart pointer to the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the due date.
Remarks
The timestamp object returned by the method can be modified in the calling subroutine.

◆ getDueDate() [2/2]

const OdBcfTimeStampPtr & OdBcf::OdBcfTopic::getDueDate ( ) const

Retrieves the topic due date.

Returns
A smart pointer to the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the due date.
Remarks
The timestamp object returned by the method can't be modified in the calling subroutine.

◆ getGuid() [1/2]

OdGUID & OdBcf::OdBcfTopic::getGuid ( )
protected

Retrieves the global unique identifier (GUID) of the topic.

Returns
An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the topic GUID.
Remarks
The GUID returned by the method can be modified in the calling subroutine.

◆ getGuid() [2/2]

const OdGUID & OdBcf::OdBcfTopic::getGuid ( ) const

Retrieves the global unique identifier (GUID) of the topic.

Returns
An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the topic GUID.
Remarks
The GUID returned by the method can't be modified in the calling subroutine.

◆ getIndex() [1/2]

OdInt32 & OdBcf::OdBcfTopic::getIndex ( )

Retrieves the topic index.

Returns
A 32-bit integer value that represents the index.
Remarks
The index value returned by the method can be modified in the calling subroutine.

◆ getIndex() [2/2]

const OdInt32 & OdBcf::OdBcfTopic::getIndex ( ) const

Retrieves the topic index.

Returns
A 32-bit integer value that represents the index.
Remarks
The index value returned by the method can't be modified in the calling subroutine.

◆ getLabels() [1/2]

OdStringArray & OdBcf::OdBcfTopic::getLabels ( )

Retrieves the topic labels.

Returns
An array of strings, which contain label texts.
Remarks
The array returned by the method can be modified in the calling subroutine.

◆ getLabels() [2/2]

const OdStringArray & OdBcf::OdBcfTopic::getLabels ( ) const

Retrieves the topic labels.

Returns
An array of strings, which contain label texts.
Remarks
The array returned by the method can't be modified in the calling subroutine.

◆ getModifiedAuthor() [1/2]

OdString & OdBcf::OdBcfTopic::getModifiedAuthor ( )
protected

Retrieves the information about an author that has modified the topic.

Returns
A string that contains data about the author that has modified the topic.
Remarks
The string returned by the method can be modified in the calling subroutine.

◆ getModifiedAuthor() [2/2]

const OdString & OdBcf::OdBcfTopic::getModifiedAuthor ( ) const

Retrieves the information about an author that has modified the topic.

Returns
A string that contains data about the author that has modified the topic.
Remarks
The string returned by the method can't be modified in the calling subroutine.

◆ getModifiedDate() [1/2]

OdBcfTimeStampPtr & OdBcf::OdBcfTopic::getModifiedDate ( )
protected

Retrieves the date of the last modification of the topic.

Returns
A smart pointer to an <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the date of the topic modification.
Remarks
The timestamp object returned by the method can be modified in the calling subroutine.

◆ getModifiedDate() [2/2]

const OdBcfTimeStampPtr & OdBcf::OdBcfTopic::getModifiedDate ( ) const

Retrieves the date of the last modification of the topic.

Returns
A smart pointer to an <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the date of the topic modification.
Remarks
The timestamp object returned by the method can't be modified in the calling subroutine.

◆ getPriority() [1/2]

OdString & OdBcf::OdBcfTopic::getPriority ( )

Retrieves the topic priority.

Returns
A string that contains the priority value.
Remarks
The priority value returned by the method can be modified in the calling subroutine.

◆ getPriority() [2/2]

const OdString & OdBcf::OdBcfTopic::getPriority ( ) const

Retrieves the topic priority.

Returns
A string that contains the priority value.
Remarks
The priority value returned by the method can't be modified in the calling subroutine.

◆ getReferenceLink() [1/2]

OdStringArray & OdBcf::OdBcfTopic::getReferenceLink ( )

Retrieves the array of reference links related to the topic object.

Returns
An array of strings that contains the links.
Remarks
The array returned by the method can be modified in the calling subroutine.

◆ getReferenceLink() [2/2]

const OdStringArray & OdBcf::OdBcfTopic::getReferenceLink ( ) const

Retrieves the array of reference links related to the topic object.

Returns
An array of strings that contains the links.
Remarks
The array returned by the method can't be modified in the calling subroutine.

◆ getRelatedTopic() [1/2]

OdBcfGUIDAttributeArray & OdBcf::OdBcfTopic::getRelatedTopic ( )
protected

Retrieves the array of related topics for the topic.

Returns
An array of smart pointers to <link OdBcf::OdBcfGUIDAttribute, OdBcfGUIDAttribute> objects that contains the related topics.
Remarks
The array returned by the method can't be modified in the calling subroutine.

◆ getRelatedTopic() [2/2]

const OdBcfGUIDAttributeArray & OdBcf::OdBcfTopic::getRelatedTopic ( ) const

Retrieves the array of related topics for the topic.

Returns
An array of smart pointers to <link OdBcf::OdBcfGUIDAttribute, OdBcfGUIDAttribute> objects that contains the related topics.
Remarks
The array returned by the method can't be modified in the calling subroutine.

◆ getStage() [1/2]

OdString & OdBcf::OdBcfTopic::getStage ( )

Retrieves the topic's Stage property value.

Returns
A string that contains the Stage property value.
Remarks
The property value returned by the method can be modified in the calling subroutine.

◆ getStage() [2/2]

const OdString & OdBcf::OdBcfTopic::getStage ( ) const

Retrieves the topic's Stage property value.

Returns
A string that contains the Stage property value.
Remarks
The property value returned by the method can't be modified in the calling subroutine.

◆ getTitle() [1/2]

OdString & OdBcf::OdBcfTopic::getTitle ( )

Retrieves the topic title.

Returns
A string that contains the title text.
Remarks
The title text returned by the method can be modified in the calling subroutine.

◆ getTitle() [2/2]

const OdString & OdBcf::OdBcfTopic::getTitle ( ) const

Retrieves the topic title.

Returns
A string that contains the title text.
Remarks
The title text returned by the method can't be modified in the calling subroutine.

◆ getTopicStatus() [1/2]

OdString & OdBcf::OdBcfTopic::getTopicStatus ( )

Retrieves the topic status.

Returns
A string that contains the topic status value.
Remarks
The topic status value returned by the method can be modified in the calling subroutine.

◆ getTopicStatus() [2/2]

const OdString & OdBcf::OdBcfTopic::getTopicStatus ( ) const

Retrieves the topic status.

Returns
A string that contains the topic status value.
Remarks
The topic status value returned by the method can't be modified in the calling subroutine.

◆ getTopicType() [1/2]

OdString & OdBcf::OdBcfTopic::getTopicType ( )

Retrieves the topic type.

Returns
A string that contains the topic type name.
Remarks
The topic type name returned by the method can be modified in the calling subroutine.

◆ getTopicType() [2/2]

const OdString & OdBcf::OdBcfTopic::getTopicType ( ) const

Retrieves the topic type.

Returns
A string that contains the topic type name.
Remarks
The topic type name returned by the method can't be modified in the calling subroutine.

◆ inFields()

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

Reads XML data into ODA data structures.

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

Implements OdBcf::OdBcfElement.

◆ isAssignedToUnset()

bool OdBcf::OdBcfTopic::isAssignedToUnset ( ) const

Defines whether the topic's AssignedTo property is not initialized.

Returns
true if the property value is not initialized; otherwise, the method returns false.

◆ isBimSnippetUnset()

bool OdBcf::OdBcfTopic::isBimSnippetUnset ( ) const

Defines whether the <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object is not initialized.

Returns
true if the <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object is not initialized; otherwise, the method returns false.

◆ isCreationAuthorUnset()

bool OdBcf::OdBcfTopic::isCreationAuthorUnset ( ) const

Defines whether the data about the author that has created the topic is not initialized.

Returns
true if the author data is not initialized; otherwise, the method returns false.

◆ isCreationDateUnset()

bool OdBcf::OdBcfTopic::isCreationDateUnset ( ) const

Defines whether the topic creation date is not initialized.

Returns
true if the topic creation date is not initialized; otherwise, the method returns false.

◆ isDescriptionUnset()

bool OdBcf::OdBcfTopic::isDescriptionUnset ( ) const

Defines whether the topic description is not initialized.

Returns
true if the description is not initialized; otherwise, the method returns false.

◆ isDocumentReferenceUnset()

bool OdBcf::OdBcfTopic::isDocumentReferenceUnset ( ) const

Defines whether the array of documents referenced within the topic is not initialized.

Returns
true if the document references array is not initialized; otherwise, the method returns false.

◆ isDueDateUnset()

bool OdBcf::OdBcfTopic::isDueDateUnset ( ) const

Defines whether the topic due date is not initialized.

Returns
true if the due date is not initialized; otherwise, the method returns false.

◆ isGuidUnset()

bool OdBcf::OdBcfTopic::isGuidUnset ( ) const

Defines whether the global unique identifier (GUID) of the topic is not initialized.

Returns
true if the GUID is not initialized; otherwise, the method returns false.

◆ isIndexUnset()

bool OdBcf::OdBcfTopic::isIndexUnset ( ) const

Defines whether the topic index is not initialized.

Returns
true if the index value is not initialized; otherwise, the method returns false.

◆ isLabelsUnset()

bool OdBcf::OdBcfTopic::isLabelsUnset ( ) const

Defines whether the topic labels are not initialized.

Returns
true if the string array that contains strings with label texts is not initialized; otherwise, the method returns false.

◆ isModifiedAuthorUnset()

bool OdBcf::OdBcfTopic::isModifiedAuthorUnset ( ) const

Defines whether the data about the author that has modified the topic is not initialized.

Returns
true if the data about the author of the modification is not initialized; otherwise, the method returns false.

◆ isModifiedDateUnset()

bool OdBcf::OdBcfTopic::isModifiedDateUnset ( ) const

Defines whether the topic modification date is not initialized.

Returns
true if the modification date is not initialized; otherwise, the method returns false.

◆ isPriorityUnset()

bool OdBcf::OdBcfTopic::isPriorityUnset ( ) const

Defines whether the priority value of the topic object is not initialized.

Returns
true if the priority value is not initialized; otherwise, the method returns false.

◆ isReferenceLinkUnset()

bool OdBcf::OdBcfTopic::isReferenceLinkUnset ( ) const

Defines whether the array of reference links associated with the topic object is not initialized.

Returns
true if the reference links array is not initialized; otherwise, the method returns false.

◆ isRelatedTopicUnset()

bool OdBcf::OdBcfTopic::isRelatedTopicUnset ( ) const

Defines whether the array of related topics is not initialized.

Returns
true if the array of related topics is not initialized; otherwise, the method returns false.

◆ isStageUnset()

bool OdBcf::OdBcfTopic::isStageUnset ( ) const

Defines whether the topic's Stage property is not initialized.

Returns
true if the property value is not initialized; otherwise, the method returns false.

◆ isTitleUnset()

bool OdBcf::OdBcfTopic::isTitleUnset ( ) const

Defines whether the title of the topic object is not initialized.

Returns
true if the title is not initialized; otherwise, the method returns false.

◆ isTopicStatusUnset()

bool OdBcf::OdBcfTopic::isTopicStatusUnset ( ) const

Defines whether the topic status value is not initialized.

Returns
true if the topic status value is not initialized; otherwise, the method returns false.

◆ isTopicTypeUnset()

bool OdBcf::OdBcfTopic::isTopicTypeUnset ( ) const

Defines whether the topic type is not initialized.

Returns
true if the topic type is not initialized; otherwise, the method returns false.

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfTopic::ODRX_DECLARE_MEMBERS ( OdBcfTopic  )

◆ operator=()

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

An assignment operator for a BCF topic object.

Parameters
val[in] Another BCF topic object that should be assigned (the right-hand operand).
Returns
A reference to the topic object after the modification by the assignment operator.

◆ outFields()

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

Writes data into XML structures.

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

Implements OdBcf::OdBcfElement.

◆ setAssignedTo()

void OdBcf::OdBcfTopic::setAssignedTo ( const OdString &  assignedToValue)

Sets a new value of the AssignedTo property of the topic object.

Parameters
assignedToValue[in] A string that contains AssignedTo property value to be set.

◆ setBimSnippet()

void OdBcf::OdBcfTopic::setBimSnippet ( const OdBcfBimSnippetPtr &  bimSnippetValue)

Sets a new BimSnippet object of the topic.

Parameters
bimSnippetValue[in] A smart pointer to an <link OdBcf::OdBcfBimSnippet, OdBcfBimSnippet> object to be set.

◆ setCreationAuthor()

void OdBcf::OdBcfTopic::setCreationAuthor ( const OdString &  creationAuthorValue)
protected

Sets the data about the creator of the topic.

Parameters
creationAuthorValue[in] A string that contains the data about the topic creator.

◆ setCreationDate()

void OdBcf::OdBcfTopic::setCreationDate ( const OdBcfTimeStampPtr &  creationDateValue)
protected

Sets the topic creation date.

Parameters
creationDateValue[in] A smart pointer to an <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the creation date to be set.

◆ setDescription()

void OdBcf::OdBcfTopic::setDescription ( const OdString &  descriptionValue)

Sets the topic description.

Parameters
descriptionValue[in] A string that contains the new description to be set.

◆ setDocumentReference()

void OdBcf::OdBcfTopic::setDocumentReference ( const OdBcfDocumentReferenceArray &  documentReferenceValue)
protected

Sets a new array of referenced documents for the topic.

Parameters
documentReferenceValue[in] An array of smart pointers to <link OdBcf::OdBcfDocumentReference, OdBcfDocumentReference> objects to be set.

◆ setDueDate()

void OdBcf::OdBcfTopic::setDueDate ( const OdBcfTimeStampPtr &  dueDateValue)

Sets a new due date for the topic object.

Parameters
dueDateValue[in] A smart pointer to the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the due date to be set.

◆ setGuid()

void OdBcf::OdBcfTopic::setGuid ( const OdGUID &  guidValue)
protected

Sets the global unique identifier of the topic (GUID).

Parameters
guidValue[in] An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the GUID for the topic to be set.

◆ setIndex()

void OdBcf::OdBcfTopic::setIndex ( const OdInt32 &  indexValue)

Sets the index of the topic object.

Parameters
indexValue[in] A 32-bit integer value that represents the index to be set.

◆ setLabels()

void OdBcf::OdBcfTopic::setLabels ( const OdStringArray &  labelsValue)

Sets the topic labels.

Parameters
labelsValue[in] An array of strings, which contain the label texts.

◆ setModifiedAuthor()

void OdBcf::OdBcfTopic::setModifiedAuthor ( const OdString &  modifiedAuthorValue)
protected

Sets the data about the author of the last modification of the topic.

Parameters
modifiedAuthorValue[in] A string that contains the data about the last modification author.

◆ setModifiedDate()

void OdBcf::OdBcfTopic::setModifiedDate ( const OdBcfTimeStampPtr &  modifiedDateValue)
protected

Sets the date of the last modification of the topic

Parameters
modifiedDateValue[in] A smart pointer to an <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the date of the last topic modification.

◆ setPriority()

void OdBcf::OdBcfTopic::setPriority ( const OdString &  priorityValue)

Sets the priority of the topic object.

Parameters
priorityValue[in] A string array that contains the priority value to be set.

◆ setReferenceLink()

void OdBcf::OdBcfTopic::setReferenceLink ( const OdStringArray &  referenceLinkValue)

Sets an array of reference links for the topic object.

Parameters
referenceLinkValue[in] A string array that contains reference links.

◆ setRelatedTopic()

void OdBcf::OdBcfTopic::setRelatedTopic ( const OdBcfGUIDAttributeArray &  relatedTopicValue)
protected

Sets an array of related topics.

Parameters
relatedTopicValue[in] An array of smart pointers to <link OdBcf::OdBcfGUIDAttribute, OdBcfGUIDAttribute> objects that represents the related topics.

◆ setStage()

void OdBcf::OdBcfTopic::setStage ( const OdString &  stageValue)

Sets a new value of the Stage property for the topic object.

Parameters
stageValue[in] A string that contains a new stage value to be set.

◆ setTitle()

void OdBcf::OdBcfTopic::setTitle ( const OdString &  titleValue)

Sets the title of the topic object.

Parameters
titleValue[in] A string array that contains the title text.

◆ setTopicStatus()

void OdBcf::OdBcfTopic::setTopicStatus ( const OdString &  topicStatusValue)

Sets the topic status.

Parameters
topicStatusValue[in] A string that contains the topic status to be set.

◆ setTopicType()

void OdBcf::OdBcfTopic::setTopicType ( const OdString &  topicTypeValue)

Sets the type of the topic.

Parameters
topicTypeValue[in] A string that contains the type name.

◆ validate()

virtual bool OdBcf::OdBcfTopic::validate ( ) const
virtual

Checks whether the topic instance has all required fields initialized.

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 751 of file BcfTopic.h.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:45