AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface
drama::gitarg Namespace Reference

Detailed Description

Namespace containing the GIT Argument reading classes.

Author
Tony Farrell, AAO $Revision$ $Date$

Classes

class  ArgFlags
 This class is used to check for the existence of one or more flags in an SDS structure. More...
 
struct  ArgFlagVal
 Type used to specify arg/flag relationships to ArgFlags class. More...
 
class  Bool
 A class which reads Boolean values from SDS argument structures. More...
 
class  Enum
 A class which reads Enumerated values from a SDS argument structures. More...
 
class  EnumLookupClass
 An interface for the lookup class template arguments to drama::gitarg::Enum. More...
 
class  Filename
 A class which reads a file name from an SDS Command argument structures. More...
 
class  Id
 A class which reads an SDS structure from DRAMA SDS Command argument structures. More...
 
class  Int
 A class which reads integer values from an SDS argument structure. More...
 
class  Real
 A class which reads real values from an SDS argument structure. More...
 
class  String
 A class which reads a string item from an SDS structure. More...
 

Typedefs

using ArgFlagValVector = std::vector< ArgFlagVal >
 Declare a vector for ArgFlagVal items.
 

Enumerations

enum class  Flags {
  NoFlagSet =0 , Upper =GIT_M_ARG_UPPER , Lower =GIT_M_ARG_LOWER , KeepErr =GIT_M_ARG_KEEPERR ,
  Abbrev = GIT_M_ARG_ABBREV , LastBit =GIT_M_ARG_LASTBIT , KeepValErr =GIT_M_ARG_KEEPVALERR
}
 The various flags used in GIT operations. More...
 

Functions

auto format_as (const Filename &f)
 Support formatting a gitarg::Filename as per std::string.
 
template<typename LookupClass , typename EnumType >
auto format_as (const gitarg::Enum< LookupClass, EnumType > &e)
 Support formatting a gitarg::Enum as per std::string.
 
auto format_as (const String &s)
 Support formatting a gitarg::String as per std::string.
 
auto format_as (gitarg::Bool b)
 Support formatting a gitarg::Bool as per bool/.
 
template<long int MinVal = LONG_MIN, long int MaxVal = LONG_MAX, long int DefaultVal = 0>
auto format_as (Int< MinVal, MaxVal, DefaultVal > i)
 Support formatting a gitarg::Int as per a long int type.
 
template<long int MinVal = LONG_MIN, long int MaxVal = LONG_MAX, long int DefaultVal = 0>
auto format_as (Real< MinVal, MaxVal, DefaultVal > r)
 Support formatting a gitarg::Real as per a double type.
 
bool IsFlagSet (const Flags f1, const Flags f2)
 Operator to allow determination of if a Flag enum value set.
 
constexpr Flags operator| (Flags f1, Flags f2)
 Operator to allow Flags values to be or-ed.