#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

const OdBcfTimeStampPtr &	getDate () const

bool	isDateUnset () const

const OdString &	getAuthor () const

bool	isAuthorUnset () const

void	setComment (const OdString &commentValue)

OdString &	getComment ()

const OdString &	getComment () const

bool	isCommentUnset () const

void	setViewpoint (const OdBcfGUIDAttributePtr &viewpointValue)

OdBcfGUIDAttributePtr &	getViewpoint ()

const OdBcfGUIDAttributePtr &	getViewpoint () const

bool	isViewpointUnset () const

void	setModifiedDate (const OdBcfTimeStampPtr &modifiedDateValue)

OdBcfTimeStampPtr &	getModifiedDate ()

const OdBcfTimeStampPtr &	getModifiedDate () const

bool	isModifiedDateUnset () const

void	setModifiedAuthor (const OdString &modifiedAuthorValue)

OdString &	getModifiedAuthor ()

const OdString &	getModifiedAuthor () const

bool	isModifiedAuthorUnset () 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
OdBcfTimeStampPtr &	getDate ()

OdString &	getAuthor ()

OdGUID &	getGuid ()

void	setDate (const OdBcfTimeStampPtr &dateValue)

void	setAuthor (const OdString &authorValue)

void	setGuid (const OdGUID &guidValue)

Protected Attributes
OdBcfTimeStampPtr	m_pDate

OdString	m_author

OdString	m_comment

OdBcfGUIDAttributePtr	m_pViewpoint

OdBcfTimeStampPtr	m_pModifiedDate

OdString	m_modifiedAuthor

OdGUID	m_guid

friend	OdBcfSession

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 comments data.

Definition at line 48 of file BcfComment.h.

Constructor & Destructor Documentation

◆ OdBcfComment()

OdBcf::OdBcfComment::OdBcfComment ( )

Creates a new commentary object with default parameters.

Member Function Documentation

◆ getAuthor() [1/2]

OdString & OdBcf::OdBcfComment::getAuthor ( )

protected

Retrieves the information about the author of the comment object.

Returns: A string that contains information about the author of the comment object.

Remarks: The string returned by the method can be modified in the calling subroutine.

◆ getAuthor() [2/2]

const OdString & OdBcf::OdBcfComment::getAuthor ( ) const

Retrieves the comment's author.

Returns: A string that contains information about the comment's author.

Remarks: The string with information about the author returned by the method can't be modified in the calling subroutine.

◆ getComment() [1/2]

OdString & OdBcf::OdBcfComment::getComment ( )

Retrieves the comment text.

Returns: A string that contains the comment text.

Remarks: The comment text returned by the method can be modified in the calling subroutine.

◆ getComment() [2/2]

const OdString & OdBcf::OdBcfComment::getComment ( ) const

Retrieves the comment text.

Returns: A string that contains the comment text.

Remarks: The comment text returned by the method can't be modified in the calling subroutine.

◆ getDate() [1/2]

OdBcfTimeStampPtr & OdBcf::OdBcfComment::getDate ( )

protected

Retrieves the creation date of the comment object.

Returns: A smart pointer to the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that represents the creation date.

Remarks: The timestamp object returned by the method can be modified in the calling subroutine.

◆ getDate() [2/2]

const OdBcfTimeStampPtr & OdBcf::OdBcfComment::getDate ( ) const

Retrieves the comment's date.

Returns: A smart pointer to the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the date.

Remarks: The timestamp object returned by the method can't be modified in the calling subroutine.

◆ getGuid() [1/2]

OdGUID & OdBcf::OdBcfComment::getGuid ( )

protected

Retrieves the global unique identifier (GUID) of the comment object.

Returns: An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the comment GUID.

Remarks: The GUID returned by the method can be modified in the calling subroutine.

◆ getGuid() [2/2]

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

Retrieves the global unique identifier (GUID) of the comment object.

Returns: An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the GUID value.

Remarks: The GUID returned by the method can't be modified in the calling subroutine.

◆ getModifiedAuthor() [1/2]

OdString & OdBcf::OdBcfComment::getModifiedAuthor ( )

Retrieves the information about the author of the last modification of the comment text.

Returns: A string that contains the information about the author of the last comment text modification.

Remarks: The string returned by the method can be modified in the calling subroutine.

◆ getModifiedAuthor() [2/2]

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

Retrieves the information about the author of the last modification of the comment text.

Returns: A string that contains the information about the author of the last comment text modification.

Remarks: The string returned by the method can't be modified in the calling subroutine.

◆ getModifiedDate() [1/2]

OdBcfTimeStampPtr & OdBcf::OdBcfComment::getModifiedDate ( )

Retrieves the date of the last modification of the comment text.

Returns: A smart pointer to the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the date of the last comment text modification.

Remarks: The timestamp object returned by the method can be modified in the calling subroutine.

◆ getModifiedDate() [2/2]

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

Retrieves the date of the last modification of the comment text.

Returns: A smart pointer to the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object that contains the date of the last comment text modification.

Remarks: The timestamp object returned by the method can't be modified in the calling subroutine.

◆ getViewpoint() [1/2]

OdBcfGUIDAttributePtr & OdBcf::OdBcfComment::getViewpoint ( )

Retrieves the comment's viewpoint value.

Returns: A smart pointer to the <link OdBcf::OdBcfGUIDAttribute, OdBcfGUIDAttribute> object that represents the view point value.

Remarks: The viewpoint value returned by the method can be modified in the calling subroutine.

◆ getViewpoint() [2/2]

const OdBcfGUIDAttributePtr & OdBcf::OdBcfComment::getViewpoint ( ) const

Retrieves the comment's viewpoint value.

Returns: A smart pointer to the <link OdBcf::OdBcfGUIDAttribute, OdBcfGUIDAttribute> object that represents the view point value.

Remarks: The viewpoint value returned by the method can't be modified in the calling subroutine.

◆ inFields()

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

◆ isAuthorUnset()

bool OdBcf::OdBcfComment::isAuthorUnset ( ) const

Defines whether the comment's author is not initialized.

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

◆ isCommentUnset()

bool OdBcf::OdBcfComment::isCommentUnset ( ) const

Defines whether the comment text is not initialized.

Returns: true if the comment text is not initialized; otherwise, the method returns false.

◆ isDateUnset()

bool OdBcf::OdBcfComment::isDateUnset ( ) const

Defines whether the comment's date is not initialized.

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

◆ isGuidUnset()

bool OdBcf::OdBcfComment::isGuidUnset ( ) const

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

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

◆ isModifiedAuthorUnset()

bool OdBcf::OdBcfComment::isModifiedAuthorUnset ( ) const

Defines whether the information about the author of the last comment text modification is not initialized.

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

◆ isModifiedDateUnset()

bool OdBcf::OdBcfComment::isModifiedDateUnset ( ) const

Defines whether the date of the last comment text modification is not initialized.

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

◆ isViewpointUnset()

bool OdBcf::OdBcfComment::isViewpointUnset ( ) const

Defines whether the comment viewpoint value is not initialized.

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

◆ 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 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.

◆ setAuthor()

void OdBcf::OdBcfComment::setAuthor ( const OdString & authorValue )

protected

Sets information about the author of the comment object.

Parameters

authorValue [in] A string with information about the comment author.

◆ setComment()

void OdBcf::OdBcfComment::setComment ( const OdString & commentValue )

Sets a new comment's text.

Parameters

commentValue [in] A string that contains the new comment text.

◆ setDate()

void OdBcf::OdBcfComment::setDate ( const OdBcfTimeStampPtr & dateValue )

protected

Sets the date of the creation of the comment object.

Parameters

dateValue [in] A new value to set represented with the <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> object.

◆ setGuid()

void OdBcf::OdBcfComment::setGuid ( const OdGUID & guidValue )

protected

Sets the global unique identifier (GUID) for the comment object.

Parameters

guidValue [in] An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the comment GUID.

◆ setModifiedAuthor()

void OdBcf::OdBcfComment::setModifiedAuthor ( const OdString & modifiedAuthorValue )

Sets a new author of the last comment text modification.

Parameters

modifiedAuthorValue [in] A string that contains information about the author of the last comment text modification.

◆ setModifiedDate()

void OdBcf::OdBcfComment::setModifiedDate ( const OdBcfTimeStampPtr & modifiedDateValue )

Sets a new date of the last comment text modification.

Parameters

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

◆ setViewpoint()

void OdBcf::OdBcfComment::setViewpoint ( const OdBcfGUIDAttributePtr & viewpointValue )

Sets a new viewpoint value.

Parameters

viewpointValue [in] A smart pointer to the <link OdBcf::OdBcfGUIDAttribute, OdBcfGUIDAttribute> object that contains the new viewpoint value.

◆ validate()

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

virtual

Checks whether the commentary 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

◆ m_author

OdString OdBcf::OdBcfComment::m_author

protected

Definition at line 239 of file BcfComment.h.

◆ m_comment

OdString OdBcf::OdBcfComment::m_comment

protected

Definition at line 240 of file BcfComment.h.

◆ m_guid

OdGUID OdBcf::OdBcfComment::m_guid

protected

Definition at line 244 of file BcfComment.h.

◆ m_modifiedAuthor

OdString OdBcf::OdBcfComment::m_modifiedAuthor

protected

Definition at line 243 of file BcfComment.h.

◆ m_pDate

OdBcfTimeStampPtr OdBcf::OdBcfComment::m_pDate

protected

Definition at line 238 of file BcfComment.h.

◆ m_pModifiedDate

OdBcfTimeStampPtr OdBcf::OdBcfComment::m_pModifiedDate

protected

Definition at line 242 of file BcfComment.h.

◆ m_pViewpoint

OdBcfGUIDAttributePtr OdBcf::OdBcfComment::m_pViewpoint

protected

Definition at line 241 of file BcfComment.h.

◆ OdBcfSession

friend OdBcf::OdBcfComment::OdBcfSession

protected

Definition at line 288 of file BcfComment.h.

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

BcfComment.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdBcfComment()

Member Function Documentation

◆ getAuthor() [1/2]

◆ getAuthor() [2/2]

◆ getComment() [1/2]

◆ getComment() [2/2]

◆ getDate() [1/2]

◆ getDate() [2/2]

◆ getGuid() [1/2]

◆ getGuid() [2/2]

◆ getModifiedAuthor() [1/2]

◆ getModifiedAuthor() [2/2]

◆ getModifiedDate() [1/2]

◆ getModifiedDate() [2/2]

◆ getViewpoint() [1/2]

◆ getViewpoint() [2/2]

◆ inFields()

◆ isAuthorUnset()

◆ isCommentUnset()

◆ isDateUnset()

◆ isGuidUnset()

◆ isModifiedAuthorUnset()

◆ isModifiedDateUnset()

◆ isViewpointUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ outFields()

◆ setAuthor()

◆ setComment()

◆ setDate()

◆ setGuid()

◆ setModifiedAuthor()

◆ setModifiedDate()

◆ setViewpoint()

◆ validate()

Member Data Documentation

◆ m_author

◆ m_comment

◆ m_guid

◆ m_modifiedAuthor

◆ m_pDate

◆ m_pModifiedDate

◆ m_pViewpoint

◆ OdBcfSession