vg
tools for working with variation graphs
Public Types | Public Member Functions | List of all members
vg::subcommand::RangeArgSpec< T, Receiver > Struct Template Reference

#include <options.hpp>

Inheritance diagram for vg::subcommand::RangeArgSpec< T, Receiver >:
vg::subcommand::ValueArgSpec< T, Receiver, Range< T > > vg::subcommand::ArgSpec< T, Receiver > vg::subcommand::BaseArgSpec< Receiver > vg::subcommand::TickChainLink

Public Types

using Holder = Range< T >
 

Public Member Functions

virtual ~RangeArgSpec ()=default
 
virtual TickChainLinkchain (TickChainLink &next)
 
- Public Member Functions inherited from vg::subcommand::ValueArgSpec< T, Receiver, Range< T > >
 ValueArgSpec (const std::string &option, char short_option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
 Make an option with a long and short option name. More...
 
 ValueArgSpec (const std::string &option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
 Make an option with a long option name only. More...
 
virtual ~ValueArgSpec ()=default
 
virtual void set_value (const T &replacement)
 Allow setting our stored value. More...
 
virtual T get_value () const
 And getting our current effective value. More...
 
virtual bool was_set () const
 Return true if a value has been set from parsing or a preset. More...
 
virtual void parse (const char *optarg)
 
virtual void apply (Receiver &receiver) const
 Apply the value to the right field of the given object. More...
 
virtual void print_metavar (ostream &out, const char *sep="") const
 Print value metavar placeholder to the given stream after the given separator. More...
 
virtual void print_value (ostream &out, const char *sep="") const
 Print value to the given stream after the given separator. More...
 
virtual void print_default (ostream &out) const
 Print default value to the given stream, if appropriate. More...
 
virtual struct option get_option_struct () const
 Get the getopt structure for this option. Option must outlive it and not move. More...
 
- Public Member Functions inherited from vg::subcommand::ArgSpec< T, Receiver >
 ArgSpec (const std::string &option, char short_option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
 Make an option with a long and short option name. More...
 
 ArgSpec (const std::string &option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
 Make an option with a long option name only. More...
 
virtual ~ArgSpec ()=default
 
virtual T get_value () const =0
 And getting our current effective value. More...
 
virtual bool was_set () const =0
 Return true if a value has been set from parsing or a preset. More...
 
virtual void preset (const BaseValuation &entry)
 
virtual void set (const BaseValuation &entry)
 
virtual void query (BaseValuation &entry) const
 
- Public Member Functions inherited from vg::subcommand::BaseArgSpec< Receiver >
 BaseArgSpec (const std::string &option, char short_option, const std::string &help)
 Make an option with a long and short option name. More...
 
 BaseArgSpec (const std::string &option, const std::string &help)
 Make an option with a long option name only. More...
 
virtual ~BaseArgSpec ()=default
 
virtual void print (ostream &out, const char *sep="", const char *after="", bool slug=false) const
 
virtual struct option get_option_struct () const =0
 Get the getopt structure for this option. Option must outlive it and not move. More...
 

Additional Inherited Members

- Public Attributes inherited from vg::subcommand::ValueArgSpec< T, Receiver, Range< T > >
Range< T > value
 
bool value_set
 
- Public Attributes inherited from vg::subcommand::ArgSpec< T, Receiver >
T Receiver::* dest
 Field in the receiving type we set. More...
 
default_value
 Original default value. More...
 
ValidatorFunction< T > validator
 Function to check value with. More...
 
- Public Attributes inherited from vg::subcommand::BaseArgSpec< Receiver >
std::string option
 Name of the option (long opt) More...
 
std::string help
 Help for the option. More...
 
char short_option
 Character of the option (short opt), or 0. More...
 
int option_id
 Int value to represent the option. More...
 

Detailed Description

template<typename T, typename Receiver>
struct vg::subcommand::RangeArgSpec< T, Receiver >

Definition structure for value-having options that can run through a range.

Member Typedef Documentation

◆ Holder

template<typename T , typename Receiver >
using vg::subcommand::RangeArgSpec< T, Receiver >::Holder = Range<T>

Constructor & Destructor Documentation

◆ ~RangeArgSpec()

template<typename T , typename Receiver >
virtual vg::subcommand::RangeArgSpec< T, Receiver >::~RangeArgSpec ( )
virtualdefault

Member Function Documentation

◆ chain()

template<typename T , typename Receiver >
virtual TickChainLink& vg::subcommand::RangeArgSpec< T, Receiver >::chain ( TickChainLink next)
inlinevirtual

Add a thing to the chain after us. Return that thing.

Reimplemented from vg::subcommand::TickChainLink.


The documentation for this struct was generated from the following file: