Module: SciYAG::Backends::Descriptions::DescriptionInclude

Included in:
Filter
Defined in:
lib/SciYAG/Backends/descriptions.rb

Overview

This module should be used with include to provide the class with descriptions functionnalities. You also need to extend DescriptionExtend

Instance Method Summary collapse

Instance Method Details

#description ⇒ Object

Returns the description associated with the backend object. Actually returns the one associated with the class.



285
286
287
 
# File 'lib/SciYAG/Backends/descriptions.rb', line 285

def description
  return self.class.description
end

#fill_parser(parser, uniquify = true) ⇒ Object

Fills an OptionParser with their parameters. Most probably, the default implementation should do for most cases. uniquify asks if we should try to make the command-line options as unique as reasonable to do ?



293
294
295
 
# File 'lib/SciYAG/Backends/descriptions.rb', line 293

def fill_parser(parser, uniquify = true)
  description.fill_parser(self, parser, uniquify)
end

#long_name ⇒ Object

Returns the long name of the backend:



306
307
308
 
# File 'lib/SciYAG/Backends/descriptions.rb', line 306

def long_name
  return description.long_name
end

#parser_banner(parser) ⇒ Object 



297
298
299
 
# File 'lib/SciYAG/Backends/descriptions.rb', line 297

def parser_banner(parser)
  description.parser_banner(self,parser)
end

#parser_options(parser, uniquify = true) ⇒ Object 



301
302
303
 
# File 'lib/SciYAG/Backends/descriptions.rb', line 301

def parser_options(parser, uniquify = true)
  description.parser_options(self,parser, uniquify)
end