.. role:: ts-api-decorator

###################
BCFMarkupHeaderFile
###################

.. js:module:: Bcf
   :noindex:

.. container:: ts-api-section

   .. js:class:: BCFMarkupHeaderFile



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Bcf.BCFMarkupHeaderFile.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Bcf.BCFMarkupHeaderFile.getBimDate`
   * :js:meth:`~Bcf.BCFMarkupHeaderFile.getBimFilename`
   * :js:meth:`~Bcf.BCFMarkupHeaderFile.getIfcProject`
   * :js:meth:`~Bcf.BCFMarkupHeaderFile.getIfcSpacialStructureElement`
   * :js:meth:`~Bcf.BCFMarkupHeaderFile.getIsExternal`
   * :js:meth:`~Bcf.BCFMarkupHeaderFile.getReference`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: BCFMarkupHeaderFile.constructor( ifcProject, ifcSpatialStructureElement, isExternal, filename, date, reference)

      :param ifcProject: None
      :type ifcProject: undefined | string
      :param ifcSpatialStructureElement: None
      :type ifcSpatialStructureElement: undefined | string
      :param isExternal: None
      :type isExternal: undefined | boolean
      :param filename: None
      :type filename: undefined | string
      :param date: None
      :type date: undefined | Date
      :param reference: None
      :type reference: undefined | string


      :rtype: BCFMarkupHeaderFile



Methods
=======

.. rst-class:: ts-api-section

getBimDate
----------

.. js:method:: BCFMarkupHeaderFile.getBimDate()



   Date of the BIM file.


   :rtype: null | Date

.. rst-class:: ts-api-section

getBimFilename
--------------

.. js:method:: BCFMarkupHeaderFile.getBimFilename()



   The BIM file related to this topic.


   :rtype: null | string

.. rst-class:: ts-api-section

getIfcProject
-------------

.. js:method:: BCFMarkupHeaderFile.getIfcProject()



   [[GenericId]] Reference to the project to which this topic is related in the IFC file


   :rtype: null | string

.. rst-class:: ts-api-section

getIfcSpacialStructureElement
-----------------------------

.. js:method:: BCFMarkupHeaderFile.getIfcSpacialStructureElement()



   [[GenericId]] Reference to the spatial structure element, e.g. IfcBuildingStorey, to which this topic is related.


   :rtype: null | string

.. rst-class:: ts-api-section

getIsExternal
-------------

.. js:method:: BCFMarkupHeaderFile.getIsExternal()



   Is the IFC file external or within the bcfzip


   :rtype: null | boolean

.. rst-class:: ts-api-section

getReference
------------

.. js:method:: BCFMarkupHeaderFile.getReference()



   URI to IfcFile.
   IsExternal=false "..\example.ifc" (within bcfzip)
   IsExternal=true "https://.../example.ifc"


   :rtype: null | string

