Class CmdLineTool

Namespace

NOpenNLP.Tools.Cmdline

Assembly

nopennlp.dll

Base class for all command line tools.

public abstract class CmdLineTool

Inheritance

object

CmdLineTool

Derived

BasicCmdLineTool

TypedCmdLineTool

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

HasParams

Whether the tool has any command line parameters.

public virtual bool HasParams { get; }

Property Value

bool

Name

The name of the tool, used as the command. Must not contain white spaces.

public virtual string Name { get; }

Property Value

string

ShortDescription

A short description of what the tool does, shown in the usage listing.

public virtual string ShortDescription { get; }

Property Value

string

Methods

CreateCommand(string)

Builds the command that parses this tool's arguments and runs it.

public abstract Command CreateCommand(string commandName)

Parameters

commandName string

the name the user typed, which for a typed tool includes the .format suffix and so is not always Name

Returns

Command

GetHelp()

A description of how to use the tool.

public abstract string GetHelp()

Returns

string