Bcf_3_0Topic.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_H
#define _BCF_3_0_TOPIC_H
 
#include "BcfCommon.h"
 
#include "SharedPtr.h"
#include "StringArray.h"
#include "OdGUID.h"
 
#include "BcfElement.h"

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

namespace OdBcf_3_0 {
 
  class OdBcfReferenceLinks;

  typedef OdSmartPtr<OdBcfReferenceLinks> OdBcfReferenceLinksPtr;
 
  class OdBcfLabels;

  typedef OdSmartPtr<OdBcfLabels> OdBcfLabelsPtr;
 
  class OdBcfBimSnippet;

  typedef OdSmartPtr<OdBcfBimSnippet> OdBcfBimSnippetPtr;
 
  class OdBcfDocumentReferences;
  
  typedef OdSmartPtr<OdBcfDocumentReferences> OdBcfDocumentReferencesPtr;
 
  class OdBcfRelatedTopics;

  typedef OdSmartPtr<OdBcfRelatedTopics> OdBcfRelatedTopicsPtr;
 
  class OdBcfComments;

  typedef OdSmartPtr<OdBcfComments> OdBcfCommentsPtr;
 
  class OdBcfViewpoints;

  typedef OdSmartPtr<OdBcfViewpoints> OdBcfViewpointsPtr;
 
  class OdBcfSession;

  class BCF_3_0_EXPORT OdBcfTopicData
  {
  public:

    OdBcfTopicData();

    OdBcfReferenceLinksPtr      m_pReferenceLinks;
    
    OdString                    m_title;
    
    OdString                    m_priority;
    
    OdInt32                     m_index;
    
    OdBcfLabelsPtr              m_pLabels;
    
    OdBcf::OdBcfTimeStampPtr    m_pDueDate;
    
    OdString                    m_assignedTo;
    
    OdString                    m_stage;
    
    OdString                    m_description;
    
    OdBcfBimSnippetPtr          m_pBimSnippet;

    OdBcfCommentsPtr            m_pComments;
    
    OdString                    m_topicType;
    
    OdString                    m_topicStatus;
 
  public:
  
    OdBcf::OdBcfTimeStampPtr    m_pCreationDate;
    
    OdString                    m_creationAuthor;
    
    OdBcf::OdBcfTimeStampPtr    m_pModifiedDate;
    
    OdString                    m_modifiedAuthor;
    
    OdBcfDocumentReferencesPtr  m_pDocumentReferences;

    OdBcfRelatedTopicsPtr       m_pRelatedTopics;

    OdBcfViewpointsPtr          m_pViewpoints;
    
    OdGUID                      m_guid;

    OdString                    m_serverAssignedId;
  };

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

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    void setReferenceLinks(const OdBcfReferenceLinksPtr &referenceLinksValue);

    OdBcfReferenceLinksPtr& getReferenceLinks();

    const OdBcfReferenceLinksPtr& getReferenceLinks() const;

    bool isReferenceLinksUnset() const;

    void setTitle(const OdString &titleValue);

    OdString& getTitle();

    const OdString& getTitle() const;

    bool isTitleUnset() const;

    void setPriority(const OdString &priorityValue);

    OdString& getPriority();

    const OdString& getPriority() const;

    bool isPriorityUnset() const;

    void setIndex(const OdInt32 &indexValue);

    OdInt32& getIndex();

    const OdInt32& getIndex() const;

    bool isIndexUnset() const;

    void setLabels(const OdBcfLabelsPtr &labelsValue);

    OdBcfLabelsPtr& getLabels();

    const OdBcfLabelsPtr& getLabels() const;

    bool isLabelsUnset() const;

    void setDueDate(const OdBcf::OdBcfTimeStampPtr &dueDateValue);

    OdBcf::OdBcfTimeStampPtr& getDueDate();

    const OdBcf::OdBcfTimeStampPtr& getDueDate() const;

    bool isDueDateUnset() const;

    void setAssignedTo(const OdString &assignedToValue);

    OdString& getAssignedTo();

    const OdString& getAssignedTo() const;

    bool isAssignedToUnset() const;

    void setStage(const OdString &stageValue);

    OdString& getStage();

    const OdString& getStage() const;
    
    bool isStageUnset() const;

    void setDescription(const OdString &descriptionValue);

    OdString& getDescription();

    const OdString& getDescription() const;

    bool isDescriptionUnset() const;

    void setBimSnippet(const OdBcfBimSnippetPtr &bimSnippetValue);

    OdBcfBimSnippetPtr& getBimSnippet();

    const OdBcfBimSnippetPtr& getBimSnippet() const;

    bool isBimSnippetUnset() const;

    void setTopicType(const OdString &topicTypeValue);

    OdString& getTopicType();

    const OdString& getTopicType() const;

    bool isTopicTypeUnset() const;

    void setTopicStatus(const OdString &topicStatusValue);

    OdString& getTopicStatus();

    const OdString& getTopicStatus() const;

    bool isTopicStatusUnset() const;

    const OdBcf::OdBcfTimeStampPtr& getCreationDate() const;

    bool isCreationDateUnset() const;

    const OdString& getCreationAuthor() const;

    bool isCreationAuthorUnset() const;

    const OdBcf::OdBcfTimeStampPtr& getModifiedDate() const;

    bool isModifiedDateUnset() const;

    const OdString& getModifiedAuthor() const;

    bool isModifiedAuthorUnset() const;

    const OdBcfDocumentReferencesPtr& getDocumentReferences() const;

    bool isDocumentReferencesUnset() const;

    const OdBcfRelatedTopicsPtr& getRelatedTopics() const;

    bool isRelatedTopicsUnset() const;

    void setComments(const OdBcfCommentsPtr& commentsValue);

    OdBcfCommentsPtr& getComments();

    const OdBcfCommentsPtr& getComments() const;

    bool isCommentsUnset() const;

    void setViewpoints(const OdBcfViewpointsPtr& viewpointsValue);

    OdBcfViewpointsPtr& getViewpoints();

    const OdBcfViewpointsPtr& getViewpoints() const;

    bool isViewpointsUnset() const;

    const OdGUID& getGuid() const;

    bool isGuidUnset() const;
    
    const OdString& getServerAssignedId() const;

    bool isServerAssignedIdUnset() const;
 
 
    //DOM-IGNORE-BEGIN
  protected:
    void setCreationDate(const OdBcf::OdBcfTimeStampPtr &creationDateValue);

    void setCreationAuthor(const OdString &creationAuthorValue);

    void setModifiedDate(const OdBcf::OdBcfTimeStampPtr &modifiedDateValue);

    void setModifiedAuthor(const OdString &modifiedAuthorValue);

    void setDocumentReferences(const OdBcfDocumentReferencesPtr &documentReferencesValue);

    void setRelatedTopics(const OdBcfRelatedTopicsPtr &relatedTopicsValue);

    void setGuid(const OdGUID &guidValue);

    void setServerAssignedId(const OdString& serverAssignedIdValue);

    OdBcf::OdBcfTimeStampPtr& getCreationDate();

    OdString& getCreationAuthor();

    OdBcf::OdBcfTimeStampPtr& getModifiedDate();

    OdString& getModifiedAuthor();

    OdBcfDocumentReferencesPtr& getDocumentReferences();

    OdBcfRelatedTopicsPtr& getRelatedTopics();

    OdGUID& getGuid();

    OdString& getServerAssignedId();

    OdBcfTopic& operator = (const OdBcfTopicData& val);

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

  typedef OdSmartPtr<OdBcfTopic> OdBcfTopicPtr;

  typedef OdArray<OdBcfTopicPtr> OdBcfTopicArray;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_TOPIC_H