Bcf_3_0TopicFolder.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_TOPIC_FOLDER_H
#define _BCF_3_0_TOPIC_FOLDER_H
 
#include "BcfCommon.h"
#include "BcfValidation.h"
#include "OdGUID.h"
#include "OdArray.h"
#define STL_USING_MAP
#include "OdaSTL.h"

namespace OdBcf_3_0 {
 
  class OdBcfMarkup;
  typedef OdSmartPtr<OdBcfMarkup> OdBcfMarkupPtr;
 
  class OdBcfVisualizationInfo;
  typedef OdSmartPtr<OdBcfVisualizationInfo> OdBcfVisualizationInfoPtr;
  
  typedef OdArray<OdBcfVisualizationInfoPtr> OdBcfVisualizationInfoArray;

  class BCF_3_0_EXPORT OdBcfTopicFolder : public OdRxObject, public OdBcf::OdBcfValidation
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfTopicFolder);
    //DOM-IGNORE-END

    static OdSmartPtr<OdBcfTopicFolder> createObject(
      const OdBcfMarkupPtr              &pMarkup, 
      const OdBcfVisualizationInfoArray &visualizationInfo);

    void setMarkup(const OdBcfMarkupPtr &markupValue);

    OdBcfMarkupPtr& getMarkup();

    const OdBcfMarkupPtr& getMarkup() const;

    bool isMarkupUnset() const;

    void setVisualizationInfo(const OdBcfVisualizationInfoArray &visualizationInfoValue);

    OdBcfVisualizationInfoArray& getVisualizationInfo();

    const OdBcfVisualizationInfoArray& getVisualizationInfo() const;

    bool isVisualizationInfoUnset() const;
 
    //DOM-IGNORE-BEGIN
  protected:
    OdBcfMarkupPtr              m_pMarkup;
    OdBcfVisualizationInfoArray m_visualizationInfo; 

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

  typedef OdSmartPtr<OdBcfTopicFolder> OdBcfTopicFolderPtr;

  typedef std::map<OdGUID, OdBcfTopicFolderPtr> OdBcfTopicFolderMap;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_TOPIC_FOLDER_H