ICompilerService
Namespace: Meshmakers.Octo.ConstructionKit.Contracts.Services
Interface for the compiler service. That is the service that is responsible for compiling and managing the construction kit model.
public interface ICompilerService
Methods
CreateNewAsync(String)
Creates a new construction kit model.
Task CreateNewAsync(string rootPath)
Parameters
rootPath String
Local root path where the construction kit model is to be crated.
Returns
CompileAsync(String, String, String)
Compiles the construction kit model.
Task<CompileResult> CompileAsync(string rootPath, string outputPath, string createCacheFilePath)
Parameters
rootPath String
Local root path where the construction kit model exists.
outputPath String
Output path of compiled construction kit
createCacheFilePath String
When defined, a cache file is created at the defined path containing all
dependencies
Returns
Task<CompileResult>
An object with files created by compiler.
CompileAsync(String, String, String, OperationResult)
Compiles the construction kit model.
Task<CompileResult> CompileAsync(string rootPath, string outputPath, string createCacheFilePath, OperationResult operationResult)
Parameters
rootPath String
Local root path where the construction kit model exists.
outputPath String
Output path of compiled construction kit
createCacheFilePath String
When defined, a cache file is created at the defined path containing all
dependencies
operationResult OperationResult
Operation result
Returns
Task<CompileResult>
An object with files created by compiler.
CompileInMemoryAsync(String, OperationResult)
Compiles the construction kit model fully in-memory without writing any output files.
Task<CkCompiledModelRoot> CompileInMemoryAsync(string rootPath, OperationResult operationResult)
Parameters
rootPath String
Local root path where the construction kit model exists.
operationResult OperationResult
Operation result
Returns
Task<CkCompiledModelRoot>
The compiled, canonically sorted model root.