STE-Industries: utilities testing
GraphicSpace::ParameterDescriptor Class Reference

#include "ParameterDescriptor.h"

Inheritance diagram for GraphicSpace::ParameterDescriptor:
Inheritance graph
Collaboration diagram for GraphicSpace::ParameterDescriptor:
Collaboration graph

Public Member Functions

virtual void Assign (const char *String, Bitmap::CorrectionParameters &Parameters) const noexcept(false) PURE_VIRTUAL
 
const char * GetName (void) const noexcept
 
virtual void PrintUsage (const Bitmap::CorrectionParameters &DefaultParameters) const noexcept(false) PURE_VIRTUAL
 

Static Public Attributes

static constexpr char EQUAL_CHARACTER = '='
 

Protected Member Functions

 ParameterDescriptor (const char *thisName) noexcept
 
virtual ~ParameterDescriptor (void) noexcept
 

Private Member Functions

 ParameterDescriptor (const ParameterDescriptor &Descriptor) noexcept=delete
 
 ParameterDescriptor (ParameterDescriptor &&Descriptor) noexcept=delete
 
void operator= (const ParameterDescriptor &Descriptor) noexcept=delete
 
void operator= (ParameterDescriptor &&Descriptor) noexcept=delete
 

Private Attributes

const char * Name
 

Detailed Description

The ParameterDescriptor abstract class represents the descriptor of a command line option.

Definition at line 31 of file ParameterDescriptor.h.

Constructor & Destructor Documentation

◆ ParameterDescriptor() [1/3]

GraphicSpace::ParameterDescriptor::ParameterDescriptor ( const ParameterDescriptor Descriptor)
privatedeletenoexcept

◆ ParameterDescriptor() [2/3]

GraphicSpace::ParameterDescriptor::ParameterDescriptor ( ParameterDescriptor &&  Descriptor)
privatedeletenoexcept

◆ ParameterDescriptor() [3/3]

GraphicSpace::ParameterDescriptor::ParameterDescriptor ( const char *  thisName)
inlineprotectednoexcept
Description:
Constructor.
Parameters
thisNamePointer to the string containing the name of the parameter.
Exceptions
None.
Returns
Not applicable.
Note
if thisName is not a valid pointer to a properly terminated string, the behavior is undefined.

Definition at line 34 of file ParameterDescriptor.inl.

◆ ~ParameterDescriptor()

GraphicSpace::ParameterDescriptor::~ParameterDescriptor ( void  )
inlineprotectedvirtualnoexcept
Description:
Destructor.
Exceptions
None.
Returns
Not applicable.

Definition at line 49 of file ParameterDescriptor.inl.

Member Function Documentation

◆ Assign()

◆ GetName()

const char * GraphicSpace::ParameterDescriptor::GetName ( void  ) const
inlinenoexcept
Description:
Get the name of the parameter.
Exceptions
None.
Returns
const char* Pointer to the name of the parameter.

Definition at line 64 of file ParameterDescriptor.inl.

◆ operator=() [1/2]

void GraphicSpace::ParameterDescriptor::operator= ( const ParameterDescriptor Descriptor)
privatedeletenoexcept

◆ operator=() [2/2]

void GraphicSpace::ParameterDescriptor::operator= ( ParameterDescriptor &&  Descriptor)
privatedeletenoexcept

◆ PrintUsage()

virtual void GraphicSpace::ParameterDescriptor::PrintUsage ( const Bitmap::CorrectionParameters DefaultParameters) const
virtualnoexcept

Member Data Documentation

◆ EQUAL_CHARACTER

GraphicSpace::ParameterDescriptor::EQUAL_CHARACTER = '='
staticconstexpr

Character representing the equal sign.

Definition at line 63 of file ParameterDescriptor.h.

Referenced by main().

◆ Name

GraphicSpace::ParameterDescriptor::Name
private

String used to identify the parameter.

Definition at line 38 of file ParameterDescriptor.h.


The documentation for this class was generated from the following files: