BcfComment.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _BFC_COMMENT_H
#define _BFC_COMMENT_H
 
#include "BcfCommon.h"
#include "OdGUID.h"
 
#include "BcfElement.h"
 
namespace OdBcf {
 
  class OdBcfTimeStamp;
  typedef OdSmartPtr<OdBcfTimeStamp> OdBcfTimeStampPtr;
 
  class OdBcfGUIDAttribute;
  typedef OdSmartPtr<OdBcfGUIDAttribute> OdBcfGUIDAttributePtr;
 
  class OdBcfSession;
 
  class BCF_EXPORT OdBcfComment : public OdBcfElement
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfComment);
    //DOM-IGNORE-END
 
    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;
 
 
    //DOM-IGNORE-BEGIN
  protected:
    OdBcfTimeStampPtr     m_pDate;
    OdString              m_author;
    OdString              m_comment;
    OdBcfGUIDAttributePtr m_pViewpoint;
    OdBcfTimeStampPtr     m_pModifiedDate;
    OdString              m_modifiedAuthor;
    OdGUID                m_guid;
 
    OdBcfTimeStampPtr& getDate();
 
    OdString& getAuthor();
 
    OdGUID& getGuid();
 
    void setDate(const OdBcfTimeStampPtr &dateValue);
 
    void setAuthor(const OdString &authorValue);
 
    void setGuid(const OdGUID &guidValue);
 
    friend OdBcfSession;
    //DOM-IGNORE-END
  };
 
  typedef OdSmartPtr<OdBcfComment> OdBcfCommentPtr;
 
} //namespace OdBcf
 
#endif // _BFC_COMMENT_H