Detailed Description

Command-line option class for processing time strings. This class is allows the programmer to add command-line options to an application that can parse strings containing representations of time. The programmer must specify the format to be accepted. Refer to each TimeTag class' getDefaultFormat() for details on the formatting specifications.

Definition at line 62 of file CommandOptionWithCommonTimeArg.hpp.

#include <CommandOptionWithCommonTimeArg.hpp>

Inheritance diagram for gnsstk::CommandOptionWithCommonTimeArg:

[legend]

Public Member Functions
virtual std::string	checkArguments ()
	Validate arguments passed using this option (and store them). More...

	CommandOptionWithCommonTimeArg (const char shOpt, const std::string &loOpt, const std::string &timeFormat, const std::string &desc, const bool required=false)

virtual std::string	getArgString () const

const std::vector< CommonTime > &	getTime () const
	Return the times scanned in from the command line. More...

virtual	~CommandOptionWithCommonTimeArg ()
	Destructor. More...

Public Member Functions inherited from gnsstk::CommandOptionWithAnyArg
	CommandOptionWithAnyArg (const char shOpt, const std::string &loOpt, const std::string &desc, const bool required=false)
	Constructor. More...

virtual	~CommandOptionWithAnyArg ()
	Destructor. More...

Public Member Functions inherited from gnsstk::CommandOptionWithArg
	CommandOptionWithArg (const CommandOptionType ot, const char shOpt, const std::string &loOpt, const std::string &desc, const bool required=false)
	Constructor. More...

virtual	~CommandOptionWithArg ()
	Destructor. More...

Public Member Functions inherited from gnsstk::CommandOption
	CommandOption (const CommandOptionFlag of, const CommandOptionType ot, const char shOpt, const std::string &loOpt, const std::string &desc, const bool req=false, CommandOptionVec &optVectorList=defaultCommandOptionList)

std::ostream &	dumpValue (std::ostream &out) const
	Displays this->value to the stream `out`. More...

virtual unsigned long	getCount () const

std::string	getDescription () const
	Returns a formatted string with the description of this option. More...

std::string	getFullOptionString () const

virtual std::string	getOptionString () const

unsigned long	getOrder (unsigned long idx=-1) const

const std::vector< std::string > &	getValue () const

void	setDescription (const std::string &desc)

CommandOption &	setMaxCount (const unsigned long l)

struct option	toGetoptLongOption () const
	Returns a struct option for use with getopt_long. More...

std::string	toGetoptShortOption () const
	Returns a string for use with getopt. More...

virtual	~CommandOption ()
	Destructor. More...

Protected Member Functions
	CommandOptionWithCommonTimeArg ()
	Default Constructor. More...

Protected Member Functions inherited from gnsstk::CommandOptionWithAnyArg
	CommandOptionWithAnyArg ()
	Default Constructor. More...

Protected Member Functions inherited from gnsstk::CommandOptionWithArg
	CommandOptionWithArg ()
	Default Constructor. More...

Protected Member Functions inherited from gnsstk::CommandOption
	CommandOption ()
	Default Constructor. More...

Protected Attributes
std::vector< CommonTime >	times
	Collection of times scanned in from the command line. More...

std::string	timeSpec
	Format used to scan times in. More...

Protected Attributes inherited from gnsstk::CommandOption
unsigned long	count

std::string	description
	The description for the help text. More...

std::string	longOpt
	The string for the long option (for example, "--foo"). More...

unsigned long	maxCount

CommandOptionFlag	optFlag
	Flag for determining whether this option has an argument or not. More...

CommandOptionType	optType

std::vector< unsigned long >	order
	The order in which this option was encountered on the command line. More...

CommandOptionParser *	parser

bool	required
	Whether or not this is a required command line option. More...

char	shortOpt
	The character for the short option (for example, '-f'). More...

std::vector< std::string >	value
	Any arguments passed with this option get put in here. More...

Additional Inherited Members
Public Types inherited from gnsstk::CommandOption
enum	CommandOptionFlag { noArgument = 0, hasArgument = 1 }

enum	CommandOptionType { trailingType, stdType, metaType }

Constructor & Destructor Documentation

◆ CommandOptionWithCommonTimeArg() [1/2]

gnsstk::CommandOptionWithCommonTimeArg::CommandOptionWithCommonTimeArg	(	const char	shOpt,
		const std::string &	loOpt,
		const std::string &	timeFormat,
		const std::string &	desc,
		const bool	required = `false`
	)

inline

Constructor

Parameters

shOpt	The one character command line option. Set to 0 if unused.
loOpt	The long command option. Set to std::string() if unused.
timeFormat	format for scanning argument into a CommonTime (