Bcf_2_1Markup.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_2_1_MARKUP_H
#define _BCF_2_1_MARKUP_H
 
#include "BcfCommon.h"
#include "OdArray.h"
 
#include "BcfElement.h"

namespace OdBcf_2_1 {
 
  class OdBcfHeader;
  typedef OdSmartPtr<OdBcfHeader> OdBcfHeaderPtr;
 
  class OdBcfTopic;
  typedef OdSmartPtr<OdBcfTopic> OdBcfTopicPtr;
 
  class OdBcfComment;
  typedef OdSmartPtr<OdBcfComment> OdBcfCommentPtr;
  
  typedef OdArray<OdBcfCommentPtr> OdBcfCommentArray;
 
  class OdBcfViewPoint;
  typedef OdSmartPtr<OdBcfViewPoint> OdBcfViewPointPtr;
  typedef OdArray<OdBcfViewPointPtr> OdBcfViewPointArray;

  class BCF_2_1_EXPORT OdBcfMarkup : public OdBcf::OdBcfElement
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfMarkup);
    //DOM-IGNORE-END

    static OdSmartPtr<OdBcfMarkup> createObject(
      const OdBcfTopicPtr       &pTopic,
      const OdBcfHeaderPtr      &pHeader = OdBcfHeaderPtr(),
      const OdBcfCommentArray   &comment = OdBcfCommentArray(),
      const OdBcfViewPointArray &viewpoints = OdBcfViewPointArray()); 
      
    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    void setHeader(const OdBcfHeaderPtr &headerValue);

    OdBcfHeaderPtr& getHeader();

    const OdBcfHeaderPtr& getHeader() const;

    bool isHeaderUnset() const;

    void setTopic(const OdBcfTopicPtr &topicValue);

    OdBcfTopicPtr& getTopic();

    const OdBcfTopicPtr& getTopic() const;

    bool isTopicUnset() const;

    void setComment(const OdBcfCommentArray &commentValue);

    OdBcfCommentArray& getComment();

    const OdBcfCommentArray& getComment() const;

    bool isCommentUnset() const;

    void setViewpoints(const OdBcfViewPointArray &viewpointsValue);

    OdBcfViewPointArray& getViewpoints();

    const OdBcfViewPointArray& getViewpoints() const;

    bool isViewpointsUnset() const;
 
 
    //DOM-IGNORE-BEGIN
  protected:
    OdBcfHeaderPtr      m_pHeader;
    OdBcfTopicPtr       m_pTopic;
    OdBcfCommentArray   m_comment;
    OdBcfViewPointArray m_viewpoints;

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

  typedef OdSmartPtr<OdBcfMarkup> OdBcfMarkupPtr;
 
} //namespace OdBcf_2_1
 
#endif // _BCF_2_1_MARKUP_H