Click or drag to resize

TaskPerformerBase Class

Abstract base class for Task performers.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.GeneratorCore
Assembly:  SD.LLBLGen.Pro.GeneratorCore (in SD.LLBLGen.Pro.GeneratorCore.dll) Version: 5.9.0.0 (5.9.0)
Syntax
public abstract class TaskPerformerBase : ITaskPerformer

The TaskPerformerBase type exposes the following members.

Constructors
  NameDescription
Protected methodTaskPerformerBase
CTor
Top
Properties
  NameDescription
Public propertyActiveTask
Gets or sets the active task to perform.
Protected propertyEncodingToUse
Gets or sets the encoding to use.
Public propertyExecutingGenerator
Gets or sets the executing generator.
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.
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.
Top
Methods
  NameDescription
Protected methodAddNewLogNode
Adds a new log node.
Protected methodStatic memberCheckIfFileCanBeCreated
Checks if file can be created. This isn't the case if one or more folders are missing.
Protected methodCheckIfTemplateFileContentsExists
Checks if the template file and contents exists for the templateid specified.
Protected methodCreateFilename(String, String)
Creates a new filename without path, using the filename format and the specified values
Protected methodCreateFilename(String, String, String)
Creates a new filename without path, using the filename format and the specified values
Protected methodCreateFilename(String, String, String, String)
Creates a new filename without path, using the filename format and the specified values
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.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetTaskPerformerName
Gets the name of the task performer.
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.
Protected methodHandleDestinationFolder(String, String, String)
Handles the destination folder. It replaces the placeholders for dbgeneric/specific subfolder names with the contents passed in.
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.
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.
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.
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.
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.
Protected methodReplaceDatabaseDriverShortNames
Replaces the database / driver short names in the format specified.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also