Bcf_3_0Comment.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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 _BCF_3_0_COMMENT_H
#define _BCF_3_0_COMMENT_H
 
#include "BcfCommon.h"
#include "OdGUID.h"
 
#include "BcfElement.h"

namespace OdBcf {
 
  class OdBcfTimeStamp;
  typedef OdSmartPtr<OdBcfTimeStamp> OdBcfTimeStampPtr;
}

namespace OdBcf_3_0 {
 
  class OdBcfGUIDAttribute;
  typedef OdSmartPtr<OdBcfGUIDAttribute> OdBcfGUIDAttributePtr;
 
  class OdBcfSession;

  class BCF_3_0_EXPORT OdBcfCommentData
  {
  public:

    OdBcfCommentData();

    OdBcf::OdBcfTimeStampPtr m_pDate;

    OdString                 m_author;

    OdString                 m_comment;

    OdBcfGUIDAttributePtr    m_pViewpoint;

    OdBcf::OdBcfTimeStampPtr m_pModifiedDate;

    OdString                 m_modifiedAuthor;

    OdGUID                   m_guid;
  };

  class BCF_3_0_EXPORT OdBcfComment : public OdBcf::OdBcfElement, protected OdBcfCommentData
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfComment);
    //DOM-IGNORE-END

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    const OdBcf::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 OdBcf::OdBcfTimeStampPtr &modifiedDateValue);

    OdBcf::OdBcfTimeStampPtr& getModifiedDate();

    const OdBcf::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;

    OdBcfComment& operator = (const OdBcfCommentData& val);
 
    //DOM-IGNORE-BEGIN
  protected:

    OdBcf::OdBcfTimeStampPtr& getDate();

    OdString& getAuthor();

    OdGUID& getGuid();

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

    void setAuthor(const OdString &authorValue);

    void setGuid(const OdGUID &guidValue);

    virtual bool validateData() const ODRX_OVERRIDE;
 
    friend OdBcfSession;
    //DOM-IGNORE-END
  };

  typedef OdSmartPtr<OdBcfComment> OdBcfCommentPtr;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_COMMENT_H