Bcf_3_0DocumentReference.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_DOCUMENT_REFERENCE_H
#define _BCF_3_0_DOCUMENT_REFERENCE_H
 
#include "BcfCommon.h"
 
#include "BcfElement.h"
#include "Bcf_3_0DocumentReferenceGroup.h"

namespace OdBcf_3_0 {

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

    static OdSmartPtr<OdBcfDocumentReference> createObject(
      const OdGUID& documentGuid,
      const OdString& url,
      const OdString& description,
      const OdBcfDocumentReferenceGroup& documentReference);

    OdBcfDocumentReference();

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    const OdGUID& getDocumentGuid() const;

    bool isDocumentGuidUnset() const;

    const OdString& getUrl() const;

    bool isUrlUnset() const;

    const OdString& getDescription() const;

    bool isDescriptionUnset() const;

    const OdBcfDocumentReferenceGroup& getDocumentReferenceAttributes() const;

    bool isDocumentReferenceAttributesUnset() const;
 
    //DOM-IGNORE-BEGIN
  protected:
    OdGUID                      m_documentGuid;
    OdString                    m_url;
    OdString                    m_description;
    OdBcfDocumentReferenceGroup m_documentReference;

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

  typedef OdSmartPtr<OdBcfDocumentReference> OdBcfDocumentReferencePtr;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_DOCUMENT_REFERENCE_H