Bcf_3_0Extensions.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_EXTENSIONS_H
#define _BCF_3_0_EXTENSIONS_H
 
#include "BcfCommon.h"
#include "OdArray.h"
 
#include "BcfElement.h"

namespace OdBcf_3_0 {
 
  class OdBcfTopicTypes;
  typedef OdSmartPtr<OdBcfTopicTypes> OdBcfTopicTypesPtr;
 
  class OdBcfTopicStatuses;
  typedef OdSmartPtr<OdBcfTopicStatuses> OdBcfTopicStatusesPtr;
 
  class OdBcfPriorities;
  typedef OdSmartPtr<OdBcfPriorities> OdBcfPrioritiesPtr;
 
  class OdBcfTopicLabels;
  typedef OdSmartPtr<OdBcfTopicLabels> OdBcfTopicLabelsPtr;
 
  class OdBcfUsers;
  typedef OdSmartPtr<OdBcfUsers> OdBcfUsersPtr;
 
  class OdBcfSnippetTypes;
  typedef OdSmartPtr<OdBcfSnippetTypes> OdBcfSnippetTypesPtr;
 
  class OdBcfStages;
  typedef OdSmartPtr<OdBcfStages> OdBcfStagesPtr;
 
  class OdBcfSession;

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

    static OdSmartPtr<OdBcfExtensions> createObject(
      const OdBcfTopicTypesPtr    &pTopicTypes,
      const OdBcfTopicStatusesPtr &pTopicStatuses = OdBcfTopicStatusesPtr(),
      const OdBcfPrioritiesPtr    &pPriorities = OdBcfPrioritiesPtr(),
      const OdBcfTopicLabelsPtr   &pTopicLabels = OdBcfTopicLabelsPtr(),
      const OdBcfUsersPtr         &pUsers = OdBcfUsersPtr(),
      const OdBcfSnippetTypesPtr  &pSnippetTypes = OdBcfSnippetTypesPtr(),
      const OdBcfStagesPtr        &pStages = OdBcfStagesPtr());
      
    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    void setTopicTypes(const OdBcfTopicTypesPtr &topicTypesValue);

    OdBcfTopicTypesPtr& getTopicTypes();

    const OdBcfTopicTypesPtr& getTopicTypes() const;

    bool isTopicTypesUnset() const;

    void setTopicStatuses(const OdBcfTopicStatusesPtr& topicStatusesValue);

    OdBcfTopicStatusesPtr& getTopicStatuses();

    const OdBcfTopicStatusesPtr& getTopicStatuses() const;

    bool isTopicStatusesUnset() const;

    void setPriorities(const OdBcfPrioritiesPtr& prioritiesValue);

    OdBcfPrioritiesPtr& getPriorities();

    const OdBcfPrioritiesPtr& getPriorities() const;

    bool isPrioritiesUnset() const;

    void setTopicLabels(const OdBcfTopicLabelsPtr& topicLabelsValue);

    OdBcfTopicLabelsPtr& getTopicLabels();

    const OdBcfTopicLabelsPtr& getTopicLabels() const;

    bool isTopicLabelsUnset() const;

    void setUsers(const OdBcfUsersPtr& usersValue);

    OdBcfUsersPtr& getUsers();

    const OdBcfUsersPtr& getUsers() const;

    bool isUsersUnset() const;

    void setSnippetTypes(const OdBcfSnippetTypesPtr& snippetTypesValue);

    OdBcfSnippetTypesPtr& getSnippetTypes();

    const OdBcfSnippetTypesPtr& getSnippetTypes() const;

    bool isSnippetTypesUnset() const;

    void setStages(const OdBcfStagesPtr& stagesValue);

    OdBcfStagesPtr& getStages();

    const OdBcfStagesPtr& getStages() const;

    bool isStagesUnset() const;
 
    //DOM-IGNORE-BEGIN
  protected:
    OdBcfTopicTypesPtr    m_pTopicTypes;
    OdBcfTopicStatusesPtr m_pTopicStatuses;
    OdBcfPrioritiesPtr    m_pPriorities;
    OdBcfTopicLabelsPtr   m_pTopicLabels;
    OdBcfUsersPtr         m_pUsers;
    OdBcfSnippetTypesPtr  m_pSnippetTypes;
    OdBcfStagesPtr        m_pStages;

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

  typedef OdSmartPtr<OdBcfExtensions> OdBcfExtensionsPtr;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_EXTENSIONS_H