#include <ParamConstraint.h>

Collaboration diagram for Hazelnp::ParamConstraint:

[legend]

Public Member Functions
	ParamConstraint ()=default
	Empty constructor. More...

	ParamConstraint (bool constrainType, DATA_TYPE requiredType, const std::vector< std::string > &defaultValue, bool required)
	Whole constructor. More...

Static Public Member Functions
static ParamConstraint	Require (const std::vector< 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...

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...

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::vector< std::string > &	defaultValue,
		bool	required
	)

inline

Whole constructor.

Definition at line 36 of file ParamConstraint.h.

             :
             constrainType{ constrainType },
             requiredType{ requiredType },
             defaultValue{ defaultValue },
             required{ required }
         {
             return;
         }

Member Function Documentation

◆ Require()

static ParamConstraint Hazelnp::ParamConstraint::Require	(	const std::vector< 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 26 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 67 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 48 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 56 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 60 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 51 of file ParamConstraint.h.

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

Hazelnupp/ParamConstraint.h

Public Member Functions

Static Public Member Functions

Public Attributes

Friends