BcfTopic.h

Go to the documentation of this file.

// Copyright (C) 2002-2020, 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-2020 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;
 
    DECLARE_ACCESSORS(      ReferenceLink,     OdStringArray,               m_referenceLink);
    DECLARE_ACCESSORS(      Title,             OdString,                    m_title);
    DECLARE_ACCESSORS(      Priority,          OdString,                    m_priority);
    DECLARE_ACCESSORS(      Index,             OdInt32,                     m_index);
    DECLARE_ACCESSORS(      Labels,            OdStringArray,               m_labels);
    DECLARE_ACCESSORS(      DueDate,           OdBcfTimeStampPtr,           m_pDueDate);
    DECLARE_ACCESSORS(      AssignedTo,        OdString,                    m_assignedTo);
    DECLARE_ACCESSORS(      Stage,             OdString,                    m_stage);
    DECLARE_ACCESSORS(      Description,       OdString,                    m_description);
    DECLARE_ACCESSORS(      BimSnippet,        OdBcfBimSnippetPtr,          m_pBimSnippet);
    DECLARE_ACCESSORS(      TopicType,         OdString,                    m_topicType);
    DECLARE_ACCESSORS(      TopicStatus,       OdString,                    m_topicStatus);
 
    DECLARE_CONST_ACCESSORS(CreationDate,      OdBcfTimeStampPtr,           m_pCreationDate);
    DECLARE_CONST_ACCESSORS(CreationAuthor,    OdString,                    m_creationAuthor);
    DECLARE_CONST_ACCESSORS(ModifiedDate,      OdBcfTimeStampPtr,           m_pModifiedDate);
    DECLARE_CONST_ACCESSORS(ModifiedAuthor,    OdString,                    m_modifiedAuthor);
    DECLARE_CONST_ACCESSORS(DocumentReference, OdBcfDocumentReferenceArray, m_documentReference);
    DECLARE_CONST_ACCESSORS(RelatedTopic,      OdBcfGUIDAttributeArray,     m_relatedTopic);
    DECLARE_CONST_ACCESSORS(Guid,              OdGUID,                      m_guid);
 
    //DOM-IGNORE-BEGIN
  protected:
    DECLARE_SET(            CreationDate,      OdBcfTimeStampPtr,           m_pCreationDate);
    DECLARE_SET(            CreationAuthor,    OdString,                    m_creationAuthor);
    DECLARE_SET(            ModifiedDate,      OdBcfTimeStampPtr,           m_pModifiedDate);
    DECLARE_SET(            ModifiedAuthor,    OdString,                    m_modifiedAuthor);
    DECLARE_SET(            DocumentReference, OdBcfDocumentReferenceArray, m_documentReference);
    DECLARE_SET(            RelatedTopic,      OdBcfGUIDAttributeArray,     m_relatedTopic);
    DECLARE_SET(            Guid,              OdGUID,                      m_guid);
                            
    DECLARE_GET(            CreationDate,      OdBcfTimeStampPtr,           m_pCreationDate);
    DECLARE_GET(            CreationAuthor,    OdString,                    m_creationAuthor);
    DECLARE_GET(            ModifiedDate,      OdBcfTimeStampPtr,           m_pModifiedDate);
    DECLARE_GET(            ModifiedAuthor,    OdString,                    m_modifiedAuthor);
    DECLARE_GET(            DocumentReference, OdBcfDocumentReferenceArray, m_documentReference);
    DECLARE_GET(            RelatedTopic,      OdBcfGUIDAttributeArray,     m_relatedTopic);
    DECLARE_GET(            Guid,              OdGUID,                      m_guid);
 
 
    OdBcfTopic& operator = (const OdBcfTopicData& val);
 
    friend OdBcfSession;
    //DOM-IGNORE-END
  };
 
  typedef OdSmartPtr<OdBcfTopic> OdBcfTopicPtr;
 
  typedef OdArray<OdBcfTopicPtr> OdBcfTopicArray;
 
} //namespace OdBcf
 
#endif // _BFC_TOPIC_H