Class BcfArchive

Namespace

IfcIO.Bcf

Assembly

IfcIO.dll

A managed buildingSMART BIM Collaboration Format (BCF 2.1) archive container holding issues, viewpoints, and comments.

public sealed class BcfArchive

Inheritance

object

BcfArchive

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

BcfArchive()

public BcfArchive()

BcfArchive(string?)

public BcfArchive(string? projectName = null)

Parameters

projectName string?

Properties

ProjectName

Optional project name or document title associated with this issue archive.

public string? ProjectName { get; set; }

Property Value

string?

Topics

The collection of coordination topics contained in this archive.

public List<BcfTopic> Topics { get; }

Property Value

List<BcfTopic>

Methods

AddTopic(string, string?, string, string)

Creates and adds a new topic to the archive.

public BcfTopic AddTopic(string title, string? description = null, string topicType = "Issue", string priority = "Normal")

Parameters

title string

description string?

topicType string

priority string

Returns

BcfTopic

FindTopicsByElement(string)

Finds all topics that reference or select a given building element by its IFC GlobalId.

public IReadOnlyList<BcfTopic> FindTopicsByElement(string ifcGuid)

Parameters

ifcGuid string

Returns

IReadOnlyList<BcfTopic>

FindTopicsByStatus(string)

Finds all topics matching a given status (e.g. "Open", "Resolved", "Closed").

public IReadOnlyList<BcfTopic> FindTopicsByStatus(string status)

Parameters

status string

Returns

IReadOnlyList<BcfTopic>

Open(string)

Opens and parses a BCF 2.1 (.bcfzip) file from disk.

public static BcfArchive Open(string path)

Parameters

path string

Returns

BcfArchive

Open(Stream)

Opens and parses a BCF 2.1 (.bcfzip) zip archive from a stream.

public static BcfArchive Open(Stream stream)

Parameters

stream Stream

Returns

BcfArchive

Save(string)

Saves all topics into a BCF 2.1 (.bcfzip) file on disk.

public void Save(string path)

Parameters

path string

Save(Stream)

Saves all topics into a stream as a BCF 2.1 (.bcfzip) zip archive.

public void Save(Stream stream)

Parameters

stream Stream