#include <ParamConstraint.h>

Collaboration diagram for Hazelnp::ParamConstraint:

[legend]

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

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

Static Public Member Functions
static ParamConstraint	Require (const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)
	Constructs a require constraint. More...

static ParamConstraint	TypeSafety (const std::string &key, DATA_TYPE wantedType, bool constrainType=true)
	Constructs a type-safety constraint. More...

Public Attributes
std::string	key
	The key of the parameter to constrain. More...

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

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	(	const std::string &	key,
		bool	constrainType,
		DATA_TYPE	wantedType,
		const std::vector< std::string > &	defaultValue,
		bool	required
	)

inline

Whole constructor.

Definition at line 38 of file ParamConstraint.h.

             :
             key{ key },
             constrainType{ constrainType },
             wantedType{ wantedType },
             defaultValue{ defaultValue },
             required{ required }
         {
             return;
         }

Member Function Documentation

◆ Require()

static ParamConstraint Hazelnp::ParamConstraint::Require	(	const std::string &	key,
		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.key = key;
             pc.defaultValue = defaultValue;
             pc.required = required;
  
             return pc;
         }

◆ TypeSafety()

static ParamConstraint Hazelnp::ParamConstraint::TypeSafety	(	const std::string &	key,
		DATA_TYPE	wantedType,
		bool	constrainType = `true`
	)

inlinestatic

Constructs a type-safety constraint.

Definition at line 27 of file ParamConstraint.h.

         {
             ParamConstraint pc;
             pc.key = key;
             pc.constrainType = constrainType;
             pc.wantedType = wantedType;
  
             return pc;
         }

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 54 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 62 of file ParamConstraint.h.

◆ key

std::string Hazelnp::ParamConstraint::key

The key of the parameter to constrain.

Definition at line 50 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 66 of file ParamConstraint.h.

◆ wantedType

DATA_TYPE Hazelnp::ParamConstraint::wantedType = DATA_TYPE::VOID

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

Definition at line 57 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