# Leonetienne/Hazelnupp: Hazelnp::ParamConstraint Struct Reference

Hazelnp::ParamConstraint Struct Reference

`#include <ParamConstraint.h>`

Collaboration diagram for Hazelnp::ParamConstraint:
[legend]

## Public Member Functions

| ParamConstraint ()=default
| Empty constructor. More...
ParamConstraint | AddRequire (const std::initializer_list< std::string > &defaultValue={}, bool required=true)
| Daisychain-method. More...
ParamConstraint | AddTypeSafety (DATA_TYPE requiredType, bool constrainType=true)
| Daisychain-method. More...
ParamConstraint | AddIncompatibilities (const std::string &incompatibleParameters)
| Daisychain-method. More...
ParamConstraint | AddIncompatibilities (const std::initializer_list< std::string > &incompatibleParameters)
| Daisychain-method. More...
| ParamConstraint (bool constrainType, DATA_TYPE requiredType, const std::initializer_list< std::string > &defaultValue, bool required, const std::initializer_list< std::string > &incompatibleParameters)
| Whole constructor. More...

## Static Public Member Functions

static ParamConstraint | Require (const std::initializer_list< std::string > &defaultValue={}, bool required=true)
| Constructs a require constraint. More...
static ParamConstraint | TypeSafety (DATA_TYPE requiredType, bool constrainType=true)
| Constructs a type-safety constraint. More...
static ParamConstraint | Incompatibility (const std::initializer_list< std::string > &incompatibleParameters)
| Constructs an incompatibility constraint. More...
static ParamConstraint | Incompatibility (const std::string &incompatibleParameters)
| Constructs an incompatibility constraint. More...

## Public Attributes

bool | constrainType = false
| Should this parameter be forced to be of a certain type? Remember to set `constrainTo` to the wanted type. More...
DATA_TYPE | requiredType = DATA_TYPE::VOID
| Constrain the parameter to this value. Requires `constrainType` to be set to true. More...
std::vector< std::string > | defaultValue
| The default value for this parameter. More...
bool | required = false
| If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user. More...
std::vector< std::string > | incompatibleParameters
| Parameters that are incompatible with this parameter. More...

## Friends

class | CmdArgsInterface

## Detailed Description

Definition at line 8 of file ParamConstraint.h.

## Constructor & Destructor Documentation

## ParamConstraint() [1/2]

Hazelnp::ParamConstraint::ParamConstraint | ( |  | ) |

default

Empty constructor.

## ParamConstraint() [2/2]

Hazelnp::ParamConstraint::ParamConstraint | ( | bool | constrainType,
|  | DATA_TYPE | requiredType,
|  | const std::initializer_list< std::string > & | defaultValue,
|  | bool | required,
|  | const std::initializer_list< std::string > & | incompatibleParameters
| ) |  |

inline

Whole constructor.

Definition at line 100 of file ParamConstraint.h.

:
constrainType{ constrainType },
requiredType{ requiredType },
defaultValue{ defaultValue },
required{ required },
incompatibleParameters{incompatibleParameters}
{
return;
}
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:121
Hazelnp::ParamConstraint::requiredType
DATA_TYPE requiredType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:116
Hazelnp::ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:113
Hazelnp::ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:125
Hazelnp::ParamConstraint::incompatibleParameters
std::vector< std::string > incompatibleParameters
Parameters that are incompatible with this parameter.
Definition: ParamConstraint.h:128

## Member Function Documentation

## AddIncompatibilities() [1/2]

ParamConstraint Hazelnp::ParamConstraint::AddIncompatibilities | ( | const std::initializer_list< std::string > & | incompatibleParameters | ) |

inline

Daisychain-method.

Will add a the "incompatiblity" aspect.
This means, that the following parameters are NOT compatible with this one and will throw an error if passed together.

Definition at line 91 of file ParamConstraint.h.

{
ParamConstraint pc = *this;
pc.incompatibleParameters = incompatibleParameters;
return pc;
}
Hazelnp::ParamConstraint::ParamConstraint
ParamConstraint()=default
Empty constructor.

## AddIncompatibilities() [2/2]

ParamConstraint Hazelnp::ParamConstraint::AddIncompatibilities | ( | const std::string & | incompatibleParameters | ) |

inline

Daisychain-method.

Will add a the "incompatiblity" aspect.
This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3

Definition at line 81 of file ParamConstraint.h.

{
ParamConstraint pc = *this;
pc.incompatibleParameters = { incompatibleParameters };
return pc;
}

## AddRequire()

ParamConstraint Hazelnp::ParamConstraint::AddRequire | ( | const std::initializer_list< std::string > & | defaultValue = `{}`,
|  | bool | required = `true`
| ) |  |

inline

Daisychain-method.

Will add a the "required-argument" aspect.
Think of the default value like of a list ofparameters. Like {"--width", "800"}

Definition at line 27 of file ParamConstraint.h.

{}, bool required = true)
{
ParamConstraint pc = *this;
pc.defaultValue = defaultValue;
pc.required = required;
return pc;
}

## AddTypeSafety()

ParamConstraint Hazelnp::ParamConstraint::AddTypeSafety | ( | DATA_TYPE | requiredType,
|  | bool | constrainType = `true`
| ) |  |

inline

Daisychain-method.

Will add a the "type-safety" aspect.
Constructs a type-safety constraint

Definition at line 48 of file ParamConstraint.h.

{
ParamConstraint pc = *this;
pc.constrainType = constrainType;
pc.requiredType = requiredType;
return pc;
}

## Incompatibility() [1/2]

static ParamConstraint Hazelnp::ParamConstraint::Incompatibility | ( | const std::initializer_list< std::string > & | incompatibleParameters | ) |

inlinestatic

Constructs an incompatibility constraint.

This means, that the following parameters are NOT compatible with this one and will throw an error if passed together

Definition at line 59 of file ParamConstraint.h.

{
ParamConstraint pc;
pc.incompatibleParameters = incompatibleParameters;
return pc;
}

## Incompatibility() [2/2]

static ParamConstraint Hazelnp::ParamConstraint::Incompatibility | ( | const std::string & | incompatibleParameters | ) |

inlinestatic

Constructs an incompatibility constraint.

This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3

Definition at line 70 of file ParamConstraint.h.

{
ParamConstraint pc;
pc.incompatibleParameters = { incompatibleParameters };
return pc;
}

## Require()

static ParamConstraint Hazelnp::ParamConstraint::Require | ( | const std::initializer_list< std::string > & | defaultValue = `{}`,
|  | bool | required = `true`
| ) |  |

inlinestatic

Constructs a require constraint.

Think of the default value like of a list ofparameters. Like {"--width", "800"}

Definition at line 16 of file ParamConstraint.h.

{}, bool required = true)
{
ParamConstraint pc;
pc.defaultValue = defaultValue;
pc.required = required;
return pc;
}

## TypeSafety()

static ParamConstraint Hazelnp::ParamConstraint::TypeSafety | ( | DATA_TYPE | requiredType,
|  | bool | constrainType = `true`
| ) |  |

inlinestatic

Constructs a type-safety constraint.

Definition at line 37 of file ParamConstraint.h.

{
ParamConstraint pc;
pc.constrainType = constrainType;
pc.requiredType = requiredType;
return pc;
}

## Friends And Related Function Documentation

## CmdArgsInterface

friend class CmdArgsInterface

friend

Definition at line 135 of file ParamConstraint.h.

## Member Data Documentation

## constrainType

bool Hazelnp::ParamConstraint::constrainType = false

Should this parameter be forced to be of a certain type?
Remember to set `constrainTo` to the wanted type.

Definition at line 113 of file ParamConstraint.h.

## defaultValue

std::vector<std::string> Hazelnp::ParamConstraint::defaultValue

The default value for this parameter.

Gets applied if this parameter was not given.
Think of this like a list of parameters. Like {"--width", "800"}

Definition at line 121 of file ParamConstraint.h.

## incompatibleParameters

std::vector<std::string> Hazelnp::ParamConstraint::incompatibleParameters

Parameters that are incompatible with this parameter.

Definition at line 128 of file ParamConstraint.h.

## required

bool Hazelnp::ParamConstraint::required = false

If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user.

Definition at line 125 of file ParamConstraint.h.

## requiredType

DATA_TYPE Hazelnp::ParamConstraint::requiredType = DATA_TYPE::VOID

Constrain the parameter to this value. Requires `constrainType` to be set to true.

Definition at line 116 of file ParamConstraint.h.

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

- include/Hazelnupp/ParamConstraint.h