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

.. js:class:: Bcf.BCFMarkupHeaderFile

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Bcf.BCFMarkupHeaderFile.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :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
============

.. js:method:: Bcf.BCFMarkupHeaderFile.constructor

   .. rst-class:: sig-pretty-signature
   
      | BCFMarkupHeaderFile(**ifcProject**\ : (*undefined* \| *string*\ ), **ifcSpatialStructureElement**\ : (*undefined* \| *string*\ ), **isExternal**\ : (*undefined* \| *boolean*\ ), **filename**\ : (*undefined* \| *string*\ ), **date**\ : (*undefined* \| *Date*\ ), **reference**\ : (*undefined* \| *string*\ )): :js:class:`BCFMarkupHeaderFile <Bcf.BCFMarkupHeaderFile>`
   
   **Parameters**
   
      **ifcProject**\ : (*undefined* \| *string*\ )
   
      **ifcSpatialStructureElement**\ : (*undefined* \| *string*\ )
   
      **isExternal**\ : (*undefined* \| *boolean*\ )
   
      **filename**\ : (*undefined* \| *string*\ )
   
      **date**\ : (*undefined* \| *Date*\ )
   
      **reference**\ : (*undefined* \| *string*\ )
   
   
   **Returns**\ : :js:class:`BCFMarkupHeaderFile <Bcf.BCFMarkupHeaderFile>`
   





Methods
=======

.. js:method:: Bcf.BCFMarkupHeaderFile.getBimDate

   .. rst-class:: sig-pretty-signature
   
      | getBimDate(): (*None* \| *Date*\ )
   
   Date of the BIM file.
   
   **Returns**\ : (*None* \| *Date*\ )
   



.. js:method:: Bcf.BCFMarkupHeaderFile.getBimFilename

   .. rst-class:: sig-pretty-signature
   
      | getBimFilename(): (*None* \| *string*\ )
   
   The BIM file related to this topic.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkupHeaderFile.getIfcProject

   .. rst-class:: sig-pretty-signature
   
      | getIfcProject(): (*None* \| *string*\ )
   
   [[GenericId]] Reference to the project to which this topic is related in the IFC file
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkupHeaderFile.getIfcSpacialStructureElement

   .. rst-class:: sig-pretty-signature
   
      | getIfcSpacialStructureElement(): (*None* \| *string*\ )
   
   [[GenericId]] Reference to the spatial structure element, e.g. IfcBuildingStorey, to which this topic is related.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkupHeaderFile.getIsExternal

   .. rst-class:: sig-pretty-signature
   
      | getIsExternal(): (*None* \| *boolean*\ )
   
   Is the IFC file external or within the bcfzip
   
   **Returns**\ : (*None* \| *boolean*\ )
   



.. js:method:: Bcf.BCFMarkupHeaderFile.getReference

   .. rst-class:: sig-pretty-signature
   
      | getReference(): (*None* \| *string*\ )
   
   URI to IfcFile. IsExternal=false "..\example.ifc" (within bcfzip) IsExternal=true "https://.../example.ifc"
   
   **Returns**\ : (*None* \| *string*\ )
   





