Engine Class

Summary

The engine is the primary entry point for the generation process.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Execution
Interfaces
Base Types
  • Object
graph TD Base0["Object"]-->Type Interface0["IEngine"]-.->Type click Interface0 "/api/Wyam.Common.Execution/IEngine" Interface1["IDisposable"]-.->Type Type["Engine"] class Type type-node

Syntax

public class Engine : IEngine, IDisposable

Constructors

Name Summary
Engine() Creates the engine.

Properties

Name Value Summary
ApplicationInput string
Gets or sets the application input.
ContentStreamFactory IContentStreamFactory
The factory that should provide content streams for documents.
DocumentFactory IDocumentFactory
Gets or sets the document factory.
Documents IDocumentCollection
Gets the documents.
DynamicAssemblies IRawAssemblyCollection
Gets a collection of all the raw assemblies that should be referenced by modules that support dynamic compilation (such as configuration assemblies).
FileSystem IFileSystem
Gets the file system.
Namespaces INamespacesCollection
Gets the namespaces that should be brought in scope by modules that support dynamic compilation.
Pipelines IPipelineCollection
Gets the pipelines.
Settings ISettings
Gets the settings.
Version string
Gets the version of Wyam currently being used.
static

Methods

Name Value Summary
CleanOutputPath() void
Deletes the output path and all files it contains.
CleanTempPath() void
Deletes the temp path and all files it contains.
Dispose() void
Execute() void
Executes the engine. This is the primary method that kicks off generation.
ResetJsEngines() void
Resets the JavaScript Engine pool and clears the JavaScript Engine Switcher to an empty list of engine factories and default engine. Useful on configuration change where we might have a new configuration.
static
GitHub