Click or drag to resize

CodeGenerationEngineBase Class

Abstract class for code generation engines, like the TDL engine and the .NET template engine.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.GeneratorCoreTaskPerformerBase
    SD.LLBLGen.Pro.GeneratorCoreCodeGenerationEngineBase

Namespace:  SD.LLBLGen.Pro.GeneratorCore
Assembly:  SD.LLBLGen.Pro.GeneratorCore (in SD.LLBLGen.Pro.GeneratorCore.dll) Version: 5.4.0.0 (5.4.0)
Syntax
public abstract class CodeGenerationEngineBase : TaskPerformerBase

The CodeGenerationEngineBase type exposes the following members.

Constructors
  NameDescription
Protected methodCodeGenerationEngineBase
Initializes a new instance of the CodeGenerationEngineBase class
Top
Properties
  NameDescription
Public propertyActiveTask
Gets or sets the active task to perform.
(Inherited from TaskPerformerBase.)
Protected propertyElementFilterToUse
Gets or sets the element filter to use, as it's specified in the task parameters.
Protected propertyEncodingToUse
Gets or sets the encoding to use.
(Inherited from TaskPerformerBase.)
Public propertyExecutingGenerator
Gets or sets the executing generator.
(Inherited from TaskPerformerBase.)
Public propertyLogLineHandlerToUse
The handler of the LogLineInApplicationOutputCallBack. Setting this property will allow the generator and any task or taskgroup to log text on the application output window.
(Inherited from TaskPerformerBase.)
Protected propertyOriginalFileContents
Gets or sets the original file contents.
Public propertyPerformResult
Reflects the result of the already executed Perform method. Should return false when Perform hasn't been called yet. Other tasks can use this property to check what the result was of a given task.
(Inherited from TaskPerformerBase.)
Top
Methods
  NameDescription
Protected methodAddNewLogNode
Adds a new log node.
(Inherited from TaskPerformerBase.)
Protected methodApplyFilterOnExecutingGenerator
Applies the filter specified on this task on the executing generator.
Protected methodCallTemplateEmitterTElement
Calls the template emitter logic to emit code for the template using the input.
Protected methodCheckIfTemplateFileContentsExists
Checks if the template file and contents exists for the templateid specified.
(Inherited from TaskPerformerBase.)
Protected methodCreateFilename(String, String)
Creates a new filename without path, using the filename format and the specified values
(Inherited from TaskPerformerBase.)
Protected methodCreateFilename(String, String, String)
Creates a new filename without path, using the filename format and the specified values
(Inherited from TaskPerformerBase.)
Protected methodCreateFilename(String, String, String, String)
Creates a new filename without path, using the filename format and the specified values
(Inherited from TaskPerformerBase.)
Protected methodEmitOutput
Emits the output for this run.
Protected methodEmitOutputForElementsTElement
Emits the output for elements.
Protected methodEmitOutputToFileTElement
Emits the output to a file. It calls the template emitter for the active task and passes the input specified.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetElementsToProcessTElement
Gets the elements to process. Applies the ElementFilterToUse, if it's specified.
Protected methodGetEmitTypeToPerform
Gets the emit type to perform.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetTaskPerformerName
Gets the name of the task performer.
(Inherited from TaskPerformerBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleDestinationFolder(String)
Handles the destination folder. It replaces the placeholders for dbgeneric/specific subfolder names with the contents passed in.
(Inherited from TaskPerformerBase.)
Protected methodHandleDestinationFolder(String, String, String)
Handles the destination folder. It replaces the placeholders for dbgeneric/specific subfolder names with the contents passed in.
(Inherited from TaskPerformerBase.)
Public methodLogLine(String, String)
Logs the line in LineToLog in the output window, no verbose specification, which means that the line is logged even when the verbose checkbox is disabled. Always appends a newline.
(Inherited from TaskPerformerBase.)
Public methodLogLine(String, String, Boolean)
Logs the line in LineToLog in the output window, based on the verbose setting isVerboseMessage, which means that the line is not logged when the verbose checkbox is disabled if isVerboseMessage is set to true. Always appends a newline.
(Inherited from TaskPerformerBase.)
Public methodLogLine(String, String, Boolean, Boolean)
Logs the given line to the output window. Based on the verbose checkbox and the VerboseMessage flag the message is logged or not. If the verbose checkbox is set, also lines with VerboseMessage=true will be logged, otherwise these messages will be surpressed. Appends a newline if AppendNewLine is set to true.
(Inherited from TaskPerformerBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPerform(IGenerator, ITask)
Executes the task which is performed by the implementor of ITaskPerformer. It assumes there are no parameters. The method's result should be stored locally and the property PerformResult should reflect the result of this method, when that property is called after the method.
(Inherited from TaskPerformerBase.)
Public methodPerform(IGenerator, ITask, DictionaryString, TaskParameter)
Executes the task which is performed by the implementor of ITaskPerformer. The method's result should be stored locally and the property PerformResult should reflect the result of this method, when that property is called after the method.
(Inherited from TaskPerformerBase.)
Protected methodPerformPreEmitTasks
Performs the pre emit tasks. The filename output will be written to is not yet placed in the task cache.
Protected methodReplaceDatabaseDriverShortNames
Replaces the database / driver short names in the format specified.
(Inherited from TaskPerformerBase.)
Protected methodSetOriginalFileContents
Sets the original file contents.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also