BcfTopic.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 _BFC_TOPIC_H
#define _BFC_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;
 
  class OdBcfBimSnippet;
  typedef OdSmartPtr<OdBcfBimSnippet> OdBcfBimSnippetPtr;
 
  class OdBcfDocumentReference;
  
  typedef OdSmartPtr<OdBcfDocumentReference> OdBcfDocumentReferencePtr;
  
  typedef OdArray<OdBcfDocumentReferencePtr> OdBcfDocumentReferenceArray;
 
  class OdBcfGUIDAttribute;
  typedef OdSmartPtr<OdBcfGUIDAttribute> OdBcfGUIDAttributePtr;
  
  typedef OdArray<OdBcfGUIDAttributePtr> OdBcfGUIDAttributeArray;
 
  class OdBcfSession;
 
  class OdBcfTopicData
  {
  public:
    OdStringArray               m_referenceLink;
    
    OdString                    m_title;
    
    OdString                    m_priority;
 
    OdInt32                     m_index;
    
    OdStringArray               m_labels;
    
    OdBcfTimeStampPtr           m_pDueDate;
    
    OdString                    m_assignedTo;
    
    OdString                    m_stage;
    
    OdString                    m_description;
    
    OdBcfBimSnippetPtr          m_pBimSnippet;
    
    OdString                    m_topicType;
    
    OdString                    m_topicStatus;
  protected:
  
    OdBcfTimeStampPtr           m_pCreationDate;
    
    OdString                    m_creationAuthor;
    
    OdBcfTimeStampPtr           m_pModifiedDate;
    
    OdString                    m_modifiedAuthor;
    
    OdBcfDocumentReferenceArray m_documentReference;
    
    OdBcfGUIDAttributeArray     m_relatedTopic;
    
    OdGUID                      m_guid;
  };
 
  class BCF_EXPORT OdBcfTopic : public OdBcfElement, protected OdBcfTopicData
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfTopic);
    //DOM-IGNORE-END
 
    OdBcfTopic();
 
    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;
 
    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;
 
    virtual bool validate() const ODRX_OVERRIDE;
 
    void setReferenceLink(const OdStringArray &referenceLinkValue);
 
    OdStringArray& getReferenceLink();
 
    const OdStringArray& getReferenceLink() const;
 
    bool isReferenceLinkUnset() 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 OdStringArray &labelsValue);
 
    OdStringArray& getLabels();
 
    const OdStringArray& getLabels() const;
 
    bool isLabelsUnset() const;
 
    void setDueDate(const OdBcfTimeStampPtr &dueDateValue);
 
    OdBcfTimeStampPtr& getDueDate();
 
    const 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 OdBcfTimeStampPtr& getCreationDate() const;
 
    bool isCreationDateUnset() const;
 
    const OdString& getCreationAuthor() const;
 
    bool isCreationAuthorUnset() const;
 
    const OdBcfTimeStampPtr& getModifiedDate() const;
 
    bool isModifiedDateUnset() const;
 
    const OdString& getModifiedAuthor() const;
 
    bool isModifiedAuthorUnset() const;
 
    const OdBcfDocumentReferenceArray& getDocumentReference() const;
 
    bool isDocumentReferenceUnset() const;
 
    const OdBcfGUIDAttributeArray& getRelatedTopic() const;
 
    bool isRelatedTopicUnset() const;
 
    const OdGUID& getGuid() const;
 
    bool isGuidUnset() const;
 
 
    //DOM-IGNORE-BEGIN
  protected:
    void setCreationDate(const OdBcfTimeStampPtr &creationDateValue);
 
    void setCreationAuthor(const OdString &creationAuthorValue);
 
    void setModifiedDate(const OdBcfTimeStampPtr &modifiedDateValue);
 
    void setModifiedAuthor(const OdString &modifiedAuthorValue);
 
    void setDocumentReference(const OdBcfDocumentReferenceArray &documentReferenceValue);
 
    void setRelatedTopic(const OdBcfGUIDAttributeArray &relatedTopicValue);
 
    void setGuid(const OdGUID &guidValue);
 
    OdBcfTimeStampPtr& getCreationDate();
 
    OdString& getCreationAuthor();
 
    OdBcfTimeStampPtr& getModifiedDate();
 
    OdString& getModifiedAuthor();
 
    OdBcfDocumentReferenceArray& getDocumentReference();
 
    OdBcfGUIDAttributeArray& getRelatedTopic();
 
    OdGUID& getGuid();
 
 
    OdBcfTopic& operator = (const OdBcfTopicData& val);
 
    friend OdBcfSession;
    //DOM-IGNORE-END
  };
 
  typedef OdSmartPtr<OdBcfTopic> OdBcfTopicPtr;
 
  typedef OdArray<OdBcfTopicPtr> OdBcfTopicArray;
 
} //namespace OdBcf
 
#endif // _BFC_TOPIC_H