module CTioga2::Commands

This module contains the real core of ctioga2: a set of classes that implement the concept of commands. Each command translates into an action (of any kind).

Commands can be specified using several ways: either using command-line options/arguments or through a commands file.

Constants

AxisType

Something meant to be fed to PlotStyle#get_axis_style

BooleanType
CmdType
ColorMapType

A color map

CommandLineHelpCommand

Display help on the command-line

CommandLineHelpOptions
CommandsType

Commands

DataPointType

Data-point. Unlike other types, this one needs to be processed afterwards, actually, since an access to a plotmaker object is necessary.

DatasetType

A series of datasets

DebugLogging

Write debugging information.

todo this should be the place where a lot of customization of the debug output could go - including channels or things like that. To be seen later on…

EchoCmd

Prints the command-line used

EvalCommand

Evaluate a series of commands.

FileType

A file name.

FloatList
FloatOrFalseType
FloatRangeType
FloatType
FuncEval
FuncPoint

dataset functions

GeneralGroup

General scope commands.

HelpOnCommand

Display help on the command-line

IntegerList
IntegerType
LaTeXFontType

A LaTeX font

LabelType

Something meant to be fed to PlotStyle#get_label_style

NameValidationRE

A CommandGroup#id or Command#name should match this regular expression.

PartialFloatRangeType
Pause
PrintInstructionsCmd

Writes down the list of instruction run so far

PrintVersion

Prints the version of ctioga2 used

RunCommandFile

Includes a file

RunRubyFile

Runs a ruby file

SetCommand

Evaluate a series of commands.

Stats
StoredDatasetType

A stored dataset.

StringOrRegexp
TextList
TextType

Plain text

VerboseLogging

Increases verbosity

Public Class Methods

make_alias_for_option(cmd_name, option, new_name, deprecated = false) click to toggle source
# File lib/ctioga2/commands/interpreter.rb, line 281
def self.make_alias_for_option(cmd_name, option, 
                               new_name, deprecated = false)
  cmd = Interpreter.command(cmd_name)
  if ! cmd
    raise "Impossible to find command #{cmd_name}"
  end
  new_opt = cmd.optional_arguments[option]
  if ! new_opt
    raise "No #{option} option to command #{cmd_name}"
  end
  new_opt = new_opt.dup
  new_opt.option_deprecated = deprecated
  new_opt.option_target = option
  cmd.optional_arguments[new_name] = new_opt
end