Skip to main content

LocalFileSystemBlueprintCatalogOptions

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.BlueprintCatalogs

Options for the local file system blueprint catalog

public class LocalFileSystemBlueprintCatalogOptions : BlueprintCatalogOptions

Inheritance Object → BlueprintCatalogOptions → LocalFileSystemBlueprintCatalogOptions

Properties​

RootPath​

The local path where the blueprints are stored

public string RootPath { get; set; }

Property Value​

String

IsEnabled​

When true, the local blueprint catalog in the file system is enabled.

public bool IsEnabled { get; set; }

Property Value​

Boolean

CacheFileName​

Gets or sets the cache file name for the blueprint catalog

public string CacheFileName { get; set; }

Property Value​

String

CacheDirectory​

Gets or sets the cache directory for blueprint catalogs

public string CacheDirectory { get; set; }

Property Value​

String

Constructors​

LocalFileSystemBlueprintCatalogOptions()​

Creates a new instance of LocalFileSystemBlueprintCatalogOptions

public LocalFileSystemBlueprintCatalogOptions()

Methods​

ApplyRootPath(String)​

Relocates the catalog to the given root path. The catalog cache always moves together with the catalog content — a cache pointing at a different root than the content would make one component read blueprints that another component never wrote (split-brain). Empty or whitespace values are ignored and the defaults remain in place.

public void ApplyRootPath(string rootPath)

Parameters​

rootPath String
Root path of the blueprint catalog, e.g. derived from the octo developer shell ROOTPATH