Skip to main content

LocalFileSystemCatalogOptions

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.ModelCatalogs

Options for the local file system construction kit catalog

public class LocalFileSystemCatalogOptions : CatalogOptions

Inheritance Object → CatalogOptions → LocalFileSystemCatalogOptions

Properties​

RootPath​

The local path where the CK models are stored

public string RootPath { get; set; }

Property Value​

String

IsEnabled​

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

public bool IsEnabled { get; set; }

Property Value​

Boolean

CacheFileName​

Get or sets the cache file name for GitHub catalog

public string CacheFileName { get; set; }

Property Value​

String

CacheDirectory​

Gets or sets the cache directory for model catalogs

public string CacheDirectory { get; set; }

Property Value​

String

Constructors​

LocalFileSystemCatalogOptions()​

Creates a new instance of LocalFileSystemCatalogOptions

public LocalFileSystemCatalogOptions()

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 models 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 catalog, e.g. from the OctoLocalCatalogRootPath MSBuild property