Bimspot.Bcf.Converter 0.0.1

dotnet add package Bimspot.Bcf.Converter --version 0.0.1
NuGet\Install-Package Bimspot.Bcf.Converter -Version 0.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Bimspot.Bcf.Converter" Version="0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Bimspot.Bcf.Converter --version 0.0.1
#r "nuget: Bimspot.Bcf.Converter, 0.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Bimspot.Bcf.Converter as a Cake Addin
#addin nuget:?package=Bimspot.Bcf.Converter&version=0.0.1

// Install Bimspot.Bcf.Converter as a Cake Tool
#tool nuget:?package=Bimspot.Bcf.Converter&version=0.0.1

This C# NuGet library allows you to easily build up and convert data into BCF files. It gives you a straightforward API to build your BCF objects exactly how you want in your order.

Installation

You can install the BcfConverter library via NuGet Package Manager or by adding it to your project's .csproj file.

nuget install BCFConverter

Usage

Creating BCF objects

To create a BCF Model, you can use the BuilderCreator class to obtain a builder object. Then, you can use various functions provided by the builder to fulfill the BCF model objects.

IMPORTANT: The builder always uses the latest (BCF 3.0) models.

Here's an example:

using BCFConverter;

// Create a markup builder
var markupBuilder = BuilderCreator.CreateMarkupBuilder();

// Build the BCF Markup
var bcfMarkup = markupBuilder
    .AddTitle("Simple title")
    .AddDescription("This is a description")
    .AddLabel("Architecture")
    .AddPriority("Critical")
    .AddTopicType("Clash")
    .AddTopicStatus("Active")
    .AddComment(c => c
        .AddComment("This is a comment")
        .AddDate(DateTime.Now)
        .AddAuthor("jimmy@page.com"))
    .AddViewPoint(v => v
        .AddPerspectiveCamera(pCam => pCam
            .AddCamera(cam => cam
                .AddViewPoint(10, 10, 10))),
        snapshotData) // Provide snapshot data here
    .Build();

// Create a project builder
var projectBuilder = BuilderCreator.CreateProjectBuilder();

// Build the BCF Project
var project = projectBuilder
    .AddProjectId("projectId")
    .AddProjectName("My project")
    .Build();
    
// Create a document builder
var documentBuilder = BuilderCreator.CreateDocumentBuilder();

// Build the BCF Document
var document = builder
    .AddDocument(d => d
    .AddFileName("document.pdf")
    .AddDescription("This is a document"))
    .Build();

// Create an extensions builder
var extBuilder = BuilderCreator.CreateExtensionsBuilder();

// Build the BCF Extensions
var extensions = builder
    .AddPriority("Critical")
    .AddPriority("Major")
    .AddPriority("Normal")
    .AddPriority("Minor")
    .AddTopicType("Issue")
    .AddTopicType("Fault")
    .AddTopicType("Clash")
    .AddTopicType("Remark")
    .AddTopicLabel("Architecture")
    .AddTopicLabel("Structure")
    .AddTopicLabel("MEP")
    .Build();
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.1 113 10/10/2023