From 93746d40cf03f6a41654ebaf78ac58ac409088e2 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Sun, 5 Sep 2021 12:24:50 +0200 Subject: [PATCH] Built docs --- docs/CmdArgsInterface_8cpp.html | 2 +- docs/CmdArgsInterface_8cpp_source.html | 463 +++++++++--------- docs/CmdArgsInterface_8h.html | 2 +- docs/CmdArgsInterface_8h_source.html | 26 +- docs/DataType_8h.html | 2 +- docs/DataType_8h_source.html | 2 +- ...lnupp_8vcxproj_8FileListAbsolute_8txt.html | 2 +- docs/FloatValue_8cpp.html | 2 +- docs/FloatValue_8cpp_source.html | 2 +- docs/FloatValue_8h.html | 2 +- docs/FloatValue_8h_source.html | 2 +- docs/HazelnuppException_8h.html | 2 +- docs/HazelnuppException_8h_source.html | 2 +- docs/IntValue_8cpp.html | 2 +- docs/IntValue_8cpp_source.html | 2 +- docs/IntValue_8h.html | 2 +- docs/IntValue_8h_source.html | 2 +- docs/ListValue_8cpp.html | 2 +- docs/ListValue_8cpp_source.html | 2 +- docs/ListValue_8h.html | 2 +- docs/ListValue_8h_source.html | 2 +- docs/ParamConstraint_8h.html | 2 +- docs/ParamConstraint_8h_source.html | 2 +- docs/Parameter_8cpp.html | 2 +- docs/Parameter_8cpp_source.html | 2 +- docs/Parameter_8h.html | 2 +- docs/Parameter_8h_source.html | 2 +- docs/Placeholders_8h.html | 2 +- docs/Placeholders_8h_source.html | 2 +- ...lnupp_8vcxproj_8FileListAbsolute_8txt.html | 2 +- docs/StringTools_8cpp.html | 2 +- docs/StringTools_8cpp_source.html | 2 +- docs/StringTools_8h.html | 2 +- docs/StringTools_8h_source.html | 2 +- docs/StringValue_8cpp.html | 2 +- docs/StringValue_8cpp_source.html | 2 +- docs/StringValue_8h.html | 2 +- docs/StringValue_8h_source.html | 2 +- docs/Value_8cpp.html | 2 +- docs/Value_8cpp_source.html | 2 +- docs/Value_8h.html | 2 +- docs/Value_8h_source.html | 2 +- docs/Version_8h.html | 6 +- docs/Version_8h_source.html | 4 +- docs/VoidValue_8cpp.html | 2 +- docs/VoidValue_8cpp_source.html | 2 +- docs/VoidValue_8h.html | 2 +- docs/VoidValue_8h_source.html | 2 +- docs/annotated.html | 2 +- ...ssHazelnp_1_1CmdArgsInterface-members.html | 2 +- docs/classHazelnp_1_1CmdArgsInterface.html | 337 +++++++------ docs/classHazelnp_1_1FloatValue-members.html | 2 +- docs/classHazelnp_1_1FloatValue.html | 2 +- ...1HazelnuppConstraintException-members.html | 2 +- ...zelnp_1_1HazelnuppConstraintException.html | 2 +- ...straintIncompatibleParameters-members.html | 2 +- ...lnuppConstraintIncompatibleParameters.html | 2 +- ...zelnuppConstraintMissingValue-members.html | 2 +- ...np_1_1HazelnuppConstraintMissingValue.html | 2 +- ...elnuppConstraintTypeMissmatch-members.html | 2 +- ...p_1_1HazelnuppConstraintTypeMissmatch.html | 2 +- ...Hazelnp_1_1HazelnuppException-members.html | 2 +- docs/classHazelnp_1_1HazelnuppException.html | 2 +- ...1HazelnuppInvalidKeyException-members.html | 2 +- ...zelnp_1_1HazelnuppInvalidKeyException.html | 2 +- ...pValueNotConvertibleException-members.html | 2 +- ...HazelnuppValueNotConvertibleException.html | 2 +- docs/classHazelnp_1_1IntValue-members.html | 2 +- docs/classHazelnp_1_1IntValue.html | 2 +- ...np_1_1Internal_1_1StringTools-members.html | 2 +- ...assHazelnp_1_1Internal_1_1StringTools.html | 2 +- docs/classHazelnp_1_1ListValue-members.html | 2 +- docs/classHazelnp_1_1ListValue.html | 2 +- docs/classHazelnp_1_1Parameter-members.html | 2 +- docs/classHazelnp_1_1Parameter.html | 2 +- docs/classHazelnp_1_1StringValue-members.html | 2 +- docs/classHazelnp_1_1StringValue.html | 2 +- docs/classHazelnp_1_1Value-members.html | 2 +- docs/classHazelnp_1_1Value.html | 2 +- docs/classHazelnp_1_1VoidValue-members.html | 2 +- docs/classHazelnp_1_1VoidValue.html | 2 +- docs/classes.html | 2 +- .../dir_0202e1e26df2e040f4dc3d434eecf04c.html | 2 +- .../dir_0cc5f59b28c403d42cc56800132eb975.html | 2 +- .../dir_1148ebc2b25b55095aebf6f4cbb6efca.html | 2 +- .../dir_a8cffda729361e9d9637effa362fcea9.html | 2 +- docs/files.html | 2 +- docs/functions.html | 2 +- docs/functions_func.html | 2 +- docs/functions_rela.html | 2 +- docs/functions_vars.html | 2 +- docs/globals.html | 2 +- docs/globals_defs.html | 2 +- docs/graph_legend.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 6 +- docs/index_8md.html | 2 +- docs/inherits.html | 2 +- docs/namespaceHazelnp.html | 2 +- docs/namespaceHazelnp_1_1Internal.html | 2 +- docs/namespaceHazelnp_1_1Placeholders.html | 2 +- docs/namespacemembers.html | 2 +- docs/namespacemembers_enum.html | 2 +- docs/namespacemembers_func.html | 2 +- docs/namespacemembers_vars.html | 2 +- docs/namespaces.html | 2 +- ...uctHazelnp_1_1ParamConstraint-members.html | 2 +- docs/structHazelnp_1_1ParamConstraint.html | 2 +- 108 files changed, 542 insertions(+), 504 deletions(-) diff --git a/docs/CmdArgsInterface_8cpp.html b/docs/CmdArgsInterface_8cpp.html index e3c1fc6..5a3d400 100644 --- a/docs/CmdArgsInterface_8cpp.html +++ b/docs/CmdArgsInterface_8cpp.html @@ -125,7 +125,7 @@ Include dependency graph for CmdArgsInterface.cpp:
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/CmdArgsInterface_8cpp_source.html b/docs/CmdArgsInterface_8cpp_source.html index cdec273..4002c61 100644 --- a/docs/CmdArgsInterface_8cpp_source.html +++ b/docs/CmdArgsInterface_8cpp_source.html @@ -519,248 +519,267 @@ $(function() {
439  bool required = false;
440  bool typeIsForced = false;
441  std::string defaultVal;
-
442  };
-
443  std::unordered_map<std::string, ParamDocEntry> paramInfos;
-
444 
-
445  // Collect descriptions
-
446  for (const auto& it : parameterDescriptions)
-
447  {
-
448  // Do we already have that param in the paramInfo set?
-
449  if (paramInfos.find(it.first) == paramInfos.end())
-
450  // No? Create it.
-
451  paramInfos[it.first] = ParamDocEntry();
-
452 
-
453  paramInfos[it.first].description = it.second;
-
454  }
-
455 
-
456  // Collect abbreviations
-
457  // first value is abbreviation, second is long form
-
458  for (const auto& it : parameterAbreviations)
-
459  {
-
460  // Do we already have that param in the paramInfo set?
-
461  if (paramInfos.find(it.second) == paramInfos.end())
-
462  // No? Create it.
-
463  paramInfos[it.second] = ParamDocEntry();
-
464 
-
465  paramInfos[it.second].abbreviation = it.first;
-
466  }
-
467 
-
468  // Collect constraints
-
469  for (const auto& it : parameterConstraints)
-
470  {
-
471  // Do we already have that param in the paramInfo set?
-
472  if (paramInfos.find(it.first) == paramInfos.end())
-
473  // No? Create it.
-
474  paramInfos[it.first] = ParamDocEntry();
-
475 
-
476  ParamDocEntry& cached = paramInfos[it.first];
-
477  cached.required = it.second.required;
-
478  cached.typeIsForced = it.second.constrainType;
-
479  cached.type = DataTypeToString(it.second.requiredType);
-
480 
-
481  std::stringstream defaultValueSs;
-
482  for (const std::string& s : it.second.defaultValue)
-
483  {
-
484  defaultValueSs << '\'' << s << '\'';
-
485 
-
486  // Add a space if we are not at the last entry
-
487  if ((void*)&s != (void*)&it.second.defaultValue.back())
-
488  defaultValueSs << " ";
-
489  }
-
490  cached.defaultVal = defaultValueSs.str();
-
491  }
-
492 
-
493  // Now generate the documentatino body
-
494  if (paramInfos.size() > 0)
-
495  {
-
496  ss << std::endl
-
497  << "==== AVAILABLE PARAMETERS ===="
-
498  << std::endl << std::endl;
-
499 
-
500  std::size_t counter = 0;
-
501  for (const auto& it : paramInfos)
-
502  {
-
503  const ParamDocEntry& pde = it.second;
-
504 
-
505  // Put name
-
506  ss << it.first << " ";
+
442  std::string incompatibilities;
+
443  };
+
444  std::unordered_map<std::string, ParamDocEntry> paramInfos;
+
445 
+
446  // Collect descriptions
+
447  for (const auto& it : parameterDescriptions)
+
448  {
+
449  // Do we already have that param in the paramInfo set?
+
450  if (paramInfos.find(it.first) == paramInfos.end())
+
451  // No? Create it.
+
452  paramInfos[it.first] = ParamDocEntry();
+
453 
+
454  paramInfos[it.first].description = it.second;
+
455  }
+
456 
+
457  // Collect abbreviations
+
458  // first value is abbreviation, second is long form
+
459  for (const auto& it : parameterAbreviations)
+
460  {
+
461  // Do we already have that param in the paramInfo set?
+
462  if (paramInfos.find(it.second) == paramInfos.end())
+
463  // No? Create it.
+
464  paramInfos[it.second] = ParamDocEntry();
+
465 
+
466  paramInfos[it.second].abbreviation = it.first;
+
467  }
+
468 
+
469  // Collect constraints
+
470  for (const auto& it : parameterConstraints)
+
471  {
+
472  // Do we already have that param in the paramInfo set?
+
473  if (paramInfos.find(it.first) == paramInfos.end())
+
474  // No? Create it.
+
475  paramInfos[it.first] = ParamDocEntry();
+
476 
+
477  ParamDocEntry& cached = paramInfos[it.first];
+
478  cached.required = it.second.required;
+
479  cached.typeIsForced = it.second.constrainType;
+
480  cached.type = DataTypeToString(it.second.requiredType);
+
481 
+
482  // Build default-value string
+
483  std::stringstream vec2str_ss;
+
484  for (const std::string& s : it.second.defaultValue)
+
485  {
+
486  vec2str_ss << '\'' << s << '\'';
+
487 
+
488  // Add a space if we are not at the last entry
+
489  if ((void*)&s != (void*)&it.second.defaultValue.back())
+
490  vec2str_ss << " ";
+
491  }
+
492  cached.defaultVal = vec2str_ss.str();
+
493 
+
494 
+
495  // Build incompatibilities string
+
496  vec2str_ss.str("");
+
497  for (const std::string& s : it.second.incompatibleParameters)
+
498  {
+
499  vec2str_ss << s;
+
500 
+
501  // Add a comma-space if we are not at the last entry
+
502  if ((void*)&s != (void*)&it.second.incompatibleParameters.back())
+
503  vec2str_ss << ", ";
+
504  }
+
505  cached.incompatibilities = vec2str_ss.str();
+
506  }
507 
-
508  // Put abbreviation
-
509  if (pde.abbreviation.length() > 0)
-
510  ss << pde.abbreviation << " ";
-
511 
-
512  // Put type
-
513  if (pde.typeIsForced)
-
514  ss << pde.type << " ";
-
515 
-
516  // Put default value
-
517  if (pde.defaultVal.length() > 0)
-
518  ss << "default=[" << pde.defaultVal << "] ";
+
508  // Now generate the documentation body
+
509  if (paramInfos.size() > 0)
+
510  {
+
511  ss << std::endl
+
512  << "==== AVAILABLE PARAMETERS ===="
+
513  << std::endl << std::endl;
+
514 
+
515  std::size_t counter = 0;
+
516  for (const auto& it : paramInfos)
+
517  {
+
518  const ParamDocEntry& pde = it.second;
519 
-
520  // Put required tag, but only if no default value
-
521  if ((pde.required) && (pde.defaultVal.length() == 0))
-
522  ss << "[[REQUIRED]] ";
-
523 
-
524  // Put brief description
-
525  if (pde.description.length() > 0)
-
526  ss << pde.description;
-
527 
-
528  // Omit linebreaks when we're on the last element
-
529  if (counter < paramInfos.size()-1)
-
530  ss << std::endl << std::endl;
-
531 
-
532  counter++;
-
533  }
-
534  }
-
535 
-
536  return ss.str();
-
537 }
+
520  // Put name
+
521  ss << it.first << " ";
+
522 
+
523  // Put abbreviation
+
524  if (pde.abbreviation.length() > 0)
+
525  ss << pde.abbreviation << " ";
+
526 
+
527  // Put type
+
528  if (pde.typeIsForced)
+
529  ss << pde.type << " ";
+
530 
+
531  // Put default value
+
532  if (pde.defaultVal.length() > 0)
+
533  ss << "default=[" << pde.defaultVal << "] ";
+
534 
+
535  // Put incompatibilities
+
536  if (pde.incompatibilities.length() > 0)
+
537  ss << "incompatibilities=[" << pde.incompatibilities << "] ";
538 
-
539 void CmdArgsInterface::ApplyConstraints()
-
540 {
-
541  // Enforce required parameters / default values
-
542  for (const auto& pc : parameterConstraints)
-
543  // Parameter in question is not supplied
-
544  if (!HasParam(pc.second.key))
-
545  {
-
546  // Do we have a default value?
-
547  if (pc.second.defaultValue.size() > 0)
-
548  {
-
549  // Then create it now, by its default value
-
550  Value* tmp = ParseValue(pc.second.defaultValue, &pc.second);
-
551  parameters.insert(std::pair<std::string, Parameter*>(
-
552  pc.second.key,
-
553  new Parameter(pc.second.key, tmp)
-
554  ));
-
555 
-
556  delete tmp;
-
557  tmp = nullptr;
-
558  }
-
559  // So we do not have a default value...
-
560  else
-
561  {
-
562  // Is it important to have the missing parameter?
-
563  if (pc.second.required)
-
564  // Throw an error message then
-
565  throw HazelnuppConstraintMissingValue(
-
566  pc.second.key,
-
567  GetDescription(pc.second.key)
-
568  );
-
569  }
-
570  }
-
571  // The parameter in question IS supplied
-
572  else
-
573  {
-
574  // Enforce parameter incompatibility
-
575 
-
576  // Is ANY parameter present listed as incompatible with our current one?
-
577  for (const std::string& incompatibility : pc.second.incompatibleParameters)
-
578  for (const std::pair<std::string, Parameter*>& otherParam : parameters)
-
579  {
-
580  if (otherParam.first == incompatibility)
-
581  throw HazelnuppConstraintIncompatibleParameters(pc.second.key, incompatibility);
-
582  }
-
583  }
-
584 
-
585  return;
-
586 }
-
587 
-
588 ParamConstraint CmdArgsInterface::GetConstraint(const std::string& parameter) const
-
589 {
-
590  return parameterConstraints.find(parameter)->second;
-
591 }
-
592 
-
593 void CmdArgsInterface::ClearConstraint(const std::string& parameter)
-
594 {
-
595  parameterConstraints.erase(parameter);
-
596  return;
-
597 }
-
598 
-
599 const std::string& CmdArgsInterface::GetExecutableName() const
-
600 {
-
601  return executableName;
-
602 }
+
539  // Put required tag, but only if no default value
+
540  if ((pde.required) && (pde.defaultVal.length() == 0))
+
541  ss << "[[REQUIRED]] ";
+
542 
+
543  // Put brief description
+
544  if (pde.description.length() > 0)
+
545  ss << pde.description;
+
546 
+
547  // Omit linebreaks when we're on the last element
+
548  if (counter < paramInfos.size()-1)
+
549  ss << std::endl << std::endl;
+
550 
+
551  counter++;
+
552  }
+
553  }
+
554 
+
555  return ss.str();
+
556 }
+
557 
+
558 void CmdArgsInterface::ApplyConstraints()
+
559 {
+
560  // Enforce required parameters / default values
+
561  for (const auto& pc : parameterConstraints)
+
562  // Parameter in question is not supplied
+
563  if (!HasParam(pc.second.key))
+
564  {
+
565  // Do we have a default value?
+
566  if (pc.second.defaultValue.size() > 0)
+
567  {
+
568  // Then create it now, by its default value
+
569  Value* tmp = ParseValue(pc.second.defaultValue, &pc.second);
+
570  parameters.insert(std::pair<std::string, Parameter*>(
+
571  pc.second.key,
+
572  new Parameter(pc.second.key, tmp)
+
573  ));
+
574 
+
575  delete tmp;
+
576  tmp = nullptr;
+
577  }
+
578  // So we do not have a default value...
+
579  else
+
580  {
+
581  // Is it important to have the missing parameter?
+
582  if (pc.second.required)
+
583  // Throw an error message then
+
584  throw HazelnuppConstraintMissingValue(
+
585  pc.second.key,
+
586  GetDescription(pc.second.key)
+
587  );
+
588  }
+
589  }
+
590  // The parameter in question IS supplied
+
591  else
+
592  {
+
593  // Enforce parameter incompatibility
+
594 
+
595  // Is ANY parameter present listed as incompatible with our current one?
+
596  for (const std::string& incompatibility : pc.second.incompatibleParameters)
+
597  for (const std::pair<std::string, Parameter*>& otherParam : parameters)
+
598  {
+
599  if (otherParam.first == incompatibility)
+
600  throw HazelnuppConstraintIncompatibleParameters(pc.second.key, incompatibility);
+
601  }
+
602  }
603 
-
604 const Value& CmdArgsInterface::operator[](const std::string& key) const
-
605 {
-
606  // Throw exception if param is unknown
-
607  if (!HasParam(key))
-
608  throw HazelnuppInvalidKeyException();
-
609 
-
610  return *parameters.find(key)->second->GetValue();
-
611 }
-
612 
-
613 void CmdArgsInterface::RegisterAbbreviation(const std::string& abbrev, const std::string& target)
-
614 {
-
615  parameterAbreviations.insert(std::pair<std::string, std::string>(abbrev, target));
-
616  return;
-
617 }
-
618 
-
619 const std::string& CmdArgsInterface::GetAbbreviation(const std::string& abbrev) const
-
620 {
-
621  if (!HasAbbreviation(abbrev))
-
622  return Placeholders::g_emptyString;
-
623 
-
624  return parameterAbreviations.find(abbrev)->second;
-
625 }
-
626 
-
627 bool CmdArgsInterface::HasAbbreviation(const std::string& abbrev) const
-
628 {
-
629  return parameterAbreviations.find(abbrev) != parameterAbreviations.end();
+
604  return;
+
605 }
+
606 
+
607 ParamConstraint CmdArgsInterface::GetConstraint(const std::string& parameter) const
+
608 {
+
609  return parameterConstraints.find(parameter)->second;
+
610 }
+
611 
+
612 void CmdArgsInterface::ClearConstraint(const std::string& parameter)
+
613 {
+
614  parameterConstraints.erase(parameter);
+
615  return;
+
616 }
+
617 
+
618 const std::string& CmdArgsInterface::GetExecutableName() const
+
619 {
+
620  return executableName;
+
621 }
+
622 
+
623 const Value& CmdArgsInterface::operator[](const std::string& key) const
+
624 {
+
625  // Throw exception if param is unknown
+
626  if (!HasParam(key))
+
627  throw HazelnuppInvalidKeyException();
+
628 
+
629  return *parameters.find(key)->second->GetValue();
630 }
631 
-
632 void CmdArgsInterface::ClearAbbreviation(const std::string& abbrevation)
+
632 void CmdArgsInterface::RegisterAbbreviation(const std::string& abbrev, const std::string& target)
633 {
-
634  parameterAbreviations.erase(abbrevation);
+
634  parameterAbreviations.insert(std::pair<std::string, std::string>(abbrev, target));
635  return;
636 }
637 
-
638 void CmdArgsInterface::ClearAbbreviations()
-
639 {
-
640  parameterAbreviations.clear();
-
641  return;
-
642 }
-
643 
-
644 void CmdArgsInterface::RegisterConstraint(const std::string& key, const ParamConstraint& constraint)
-
645 {
-
646  // Magic syntax, wooo
-
647  (parameterConstraints[key] = constraint).key = key;
-
648  return;
+
638 const std::string& CmdArgsInterface::GetAbbreviation(const std::string& abbrev) const
+
639 {
+
640  if (!HasAbbreviation(abbrev))
+
641  return Placeholders::g_emptyString;
+
642 
+
643  return parameterAbreviations.find(abbrev)->second;
+
644 }
+
645 
+
646 bool CmdArgsInterface::HasAbbreviation(const std::string& abbrev) const
+
647 {
+
648  return parameterAbreviations.find(abbrev) != parameterAbreviations.end();
649 }
650 
-
651 void CmdArgsInterface::ClearConstraints()
+
651 void CmdArgsInterface::ClearAbbreviation(const std::string& abbrevation)
652 {
-
653  parameterConstraints.clear();
+
653  parameterAbreviations.erase(abbrevation);
654  return;
655 }
656 
-
657 void CmdArgsInterface::SetCrashOnFail(bool crashOnFail)
+
657 void CmdArgsInterface::ClearAbbreviations()
658 {
-
659  this->crashOnFail = crashOnFail;
+
659  parameterAbreviations.clear();
660  return;
661 }
662 
-
663 const ParamConstraint* CmdArgsInterface::GetConstraintForKey(const std::string& key) const
-
664 {
-
665  const auto constraint = parameterConstraints.find(key);
-
666 
-
667  if (constraint == parameterConstraints.end())
-
668  return nullptr;
+
663 void CmdArgsInterface::RegisterConstraint(const std::string& key, const ParamConstraint& constraint)
+
664 {
+
665  // Magic syntax, wooo
+
666  (parameterConstraints[key] = constraint).key = key;
+
667  return;
+
668 }
669 
-
670  return &constraint->second;
-
671 }
+
670 void CmdArgsInterface::ClearConstraints()
+
671 {
+
672  parameterConstraints.clear();
+
673  return;
+
674 }
+
675 
+
676 void CmdArgsInterface::SetCrashOnFail(bool crashOnFail)
+
677 {
+
678  this->crashOnFail = crashOnFail;
+
679  return;
+
680 }
+
681 
+
682 const ParamConstraint* CmdArgsInterface::GetConstraintForKey(const std::string& key) const
+
683 {
+
684  const auto constraint = parameterConstraints.find(key);
+
685 
+
686  if (constraint == parameterConstraints.end())
+
687  return nullptr;
+
688 
+
689  return &constraint->second;
+
690 }
Hazelnp::CmdArgsInterface::GetCatchHelp
bool GetCatchHelp() const
Retruns whether the CmdArgsInterface should automatically catch the –help parameter,...
Definition: CmdArgsInterface.cpp:374
HazelnuppException.h
Hazelnp
Definition: CmdArgsInterface.h:9
Hazelnp::IntValue
Specializations for integer values (uses long long int)
Definition: IntValue.h:8
-
Hazelnp::CmdArgsInterface::GetConstraint
ParamConstraint GetConstraint(const std::string &parameter) const
Will return the constraint information for a specific parameter.
Definition: CmdArgsInterface.cpp:588
-
Hazelnp::CmdArgsInterface::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: CmdArgsInterface.cpp:638
+
Hazelnp::CmdArgsInterface::GetConstraint
ParamConstraint GetConstraint(const std::string &parameter) const
Will return the constraint information for a specific parameter.
Definition: CmdArgsInterface.cpp:607
+
Hazelnp::CmdArgsInterface::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: CmdArgsInterface.cpp:657
Hazelnp::HazelnuppConstraintIncompatibleParameters
Gets thrown when a parameter constrained to be incompatible with other parameters gets supplied along...
Definition: HazelnuppException.h:101
Hazelnp::CmdArgsInterface::SetCatchHelp
void SetCatchHelp(bool catchHelp)
Sets whether the CmdArgsInterface should automatically catch the –help parameter, print the parameter...
Definition: CmdArgsInterface.cpp:368
-
Hazelnp::CmdArgsInterface::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: CmdArgsInterface.cpp:627
+
Hazelnp::CmdArgsInterface::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: CmdArgsInterface.cpp:646
Hazelnp::HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:29
-
Hazelnp::CmdArgsInterface::RegisterConstraint
void RegisterConstraint(const std::string &key, const ParamConstraint &constraint)
Will register a constraint for a parameter.
Definition: CmdArgsInterface.cpp:644
+
Hazelnp::CmdArgsInterface::RegisterConstraint
void RegisterConstraint(const std::string &key, const ParamConstraint &constraint)
Will register a constraint for a parameter.
Definition: CmdArgsInterface.cpp:663
StringValue.h
CmdArgsInterface.h
Hazelnp::HazelnuppException::What
const std::string & What() const
Will return an error message.
Definition: HazelnuppException.h:18
@@ -768,14 +787,14 @@ $(function() {
Placeholders.h
Hazelnp::DATA_TYPE::VOID
@ VOID
Hazelnp::FloatValue
Specializations for floating point values (uses long double)
Definition: FloatValue.h:9
-
Hazelnp::CmdArgsInterface::ClearConstraint
void ClearConstraint(const std::string &parameter)
Will the constraint of a specific parameter.
Definition: CmdArgsInterface.cpp:593
+
Hazelnp::CmdArgsInterface::ClearConstraint
void ClearConstraint(const std::string &parameter)
Will the constraint of a specific parameter.
Definition: CmdArgsInterface.cpp:612
Hazelnp::ParamConstraint::requiredType
DATA_TYPE requiredType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:73
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
Hazelnp::HazelnuppConstraintException
Gets thrown something bad happens because of parameter constraints.
Definition: HazelnuppException.h:47
-
Hazelnp::CmdArgsInterface::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: CmdArgsInterface.cpp:613
+
Hazelnp::CmdArgsInterface::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: CmdArgsInterface.cpp:632
Hazelnp::CmdArgsInterface::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: CmdArgsInterface.cpp:199
Hazelnp::DATA_TYPE::LIST
@ LIST
-
Hazelnp::CmdArgsInterface::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: CmdArgsInterface.cpp:651
+
Hazelnp::CmdArgsInterface::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: CmdArgsInterface.cpp:670
Hazelnp::Parameter
Definition: Parameter.h:8
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
Hazelnp::Placeholders::g_emptyString
static const std::string g_emptyString
The only purpose of this is to provide the ability to return an empty string as an error for std::str...
Definition: Placeholders.h:9
@@ -788,13 +807,13 @@ $(function() {
Hazelnp::CmdArgsInterface::CmdArgsInterface
CmdArgsInterface()
Definition: CmdArgsInterface.cpp:15
Hazelnp::Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:21
Hazelnp::HazelnuppConstraintMissingValue
Gets thrown when a parameter constrained to be required is not provided, and has no default value set...
Definition: HazelnuppException.h:80
-
Hazelnp::CmdArgsInterface::ClearAbbreviation
void ClearAbbreviation(const std::string &abbrevation)
Will delete the abbreviation for a given parameter.
Definition: CmdArgsInterface.cpp:632
+
Hazelnp::CmdArgsInterface::ClearAbbreviation
void ClearAbbreviation(const std::string &abbrevation)
Will delete the abbreviation for a given parameter.
Definition: CmdArgsInterface.cpp:651
Hazelnp::HazelnuppConstraintTypeMissmatch
Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...
Definition: HazelnuppException.h:56
VoidValue.h
Hazelnp::CmdArgsInterface::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: CmdArgsInterface.cpp:36
Hazelnp::CmdArgsInterface::SetBriefDescription
void SetBriefDescription(const std::string &description)
Sets a brief description of the application to be automatically added to the documentation.
Definition: CmdArgsInterface.cpp:379
Hazelnp::CmdArgsInterface::GetBriefDescription
const std::string & GetBriefDescription()
Returns the brief description of the application to be automatically added to the documentation.
Definition: CmdArgsInterface.cpp:385
-
Hazelnp::CmdArgsInterface::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: CmdArgsInterface.cpp:604
+
Hazelnp::CmdArgsInterface::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: CmdArgsInterface.cpp:623
Hazelnp::CmdArgsInterface::ClearDescriptions
void ClearDescriptions()
Will delete all parameter descriptions.
Definition: CmdArgsInterface.cpp:419
Hazelnp::ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:33
Hazelnp::VoidValue
Specializations for void values.
Definition: VoidValue.h:8
@@ -806,19 +825,19 @@ $(function() {
Hazelnp::DATA_TYPE::INT
@ INT
FloatValue.h
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:8
-
Hazelnp::CmdArgsInterface::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f) Returns "" if no match is found.
Definition: CmdArgsInterface.cpp:619
+
Hazelnp::CmdArgsInterface::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f) Returns "" if no match is found.
Definition: CmdArgsInterface.cpp:638
Hazelnp::DATA_TYPE::STRING
@ STRING
-
Hazelnp::CmdArgsInterface::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: CmdArgsInterface.cpp:599
+
Hazelnp::CmdArgsInterface::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: CmdArgsInterface.cpp:618
Hazelnp::DataTypeToString
static std::string DataTypeToString(DATA_TYPE type)
Definition: DataType.h:17
Hazelnp::Internal::StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:56
-
Hazelnp::CmdArgsInterface::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: CmdArgsInterface.cpp:657
+
Hazelnp::CmdArgsInterface::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: CmdArgsInterface.cpp:676
Hazelnp::ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:9
Hazelnp::StringValue
Specializations for string values (uses std::string)
Definition: StringValue.h:9
StringTools.h
Hazelnp::CmdArgsInterface::~CmdArgsInterface
~CmdArgsInterface()
Definition: CmdArgsInterface.cpp:26
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/CmdArgsInterface_8h.html b/docs/CmdArgsInterface_8h.html index b077e53..b55bf8a 100644 --- a/docs/CmdArgsInterface_8h.html +++ b/docs/CmdArgsInterface_8h.html @@ -129,7 +129,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/CmdArgsInterface_8h_source.html b/docs/CmdArgsInterface_8h_source.html index 472a2d6..24584ea 100644 --- a/docs/CmdArgsInterface_8h_source.html +++ b/docs/CmdArgsInterface_8h_source.html @@ -230,17 +230,17 @@ $(function() {
Hazelnp::CmdArgsInterface::GetCatchHelp
bool GetCatchHelp() const
Retruns whether the CmdArgsInterface should automatically catch the –help parameter,...
Definition: CmdArgsInterface.cpp:374
Hazelnp
Definition: CmdArgsInterface.h:9
Hazelnp::CmdArgsInterface
The main class to interface with.
Definition: CmdArgsInterface.h:13
-
Hazelnp::CmdArgsInterface::GetConstraint
ParamConstraint GetConstraint(const std::string &parameter) const
Will return the constraint information for a specific parameter.
Definition: CmdArgsInterface.cpp:588
-
Hazelnp::CmdArgsInterface::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: CmdArgsInterface.cpp:638
+
Hazelnp::CmdArgsInterface::GetConstraint
ParamConstraint GetConstraint(const std::string &parameter) const
Will return the constraint information for a specific parameter.
Definition: CmdArgsInterface.cpp:607
+
Hazelnp::CmdArgsInterface::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: CmdArgsInterface.cpp:657
Hazelnp::CmdArgsInterface::SetCatchHelp
void SetCatchHelp(bool catchHelp)
Sets whether the CmdArgsInterface should automatically catch the –help parameter, print the parameter...
Definition: CmdArgsInterface.cpp:368
-
Hazelnp::CmdArgsInterface::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: CmdArgsInterface.cpp:627
-
Hazelnp::CmdArgsInterface::RegisterConstraint
void RegisterConstraint(const std::string &key, const ParamConstraint &constraint)
Will register a constraint for a parameter.
Definition: CmdArgsInterface.cpp:644
-
Hazelnp::CmdArgsInterface::ClearConstraint
void ClearConstraint(const std::string &parameter)
Will the constraint of a specific parameter.
Definition: CmdArgsInterface.cpp:593
+
Hazelnp::CmdArgsInterface::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: CmdArgsInterface.cpp:646
+
Hazelnp::CmdArgsInterface::RegisterConstraint
void RegisterConstraint(const std::string &key, const ParamConstraint &constraint)
Will register a constraint for a parameter.
Definition: CmdArgsInterface.cpp:663
+
Hazelnp::CmdArgsInterface::ClearConstraint
void ClearConstraint(const std::string &parameter)
Will the constraint of a specific parameter.
Definition: CmdArgsInterface.cpp:612
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
ParamConstraint.h
-
Hazelnp::CmdArgsInterface::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: CmdArgsInterface.cpp:613
+
Hazelnp::CmdArgsInterface::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: CmdArgsInterface.cpp:632
Hazelnp::CmdArgsInterface::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: CmdArgsInterface.cpp:199
-
Hazelnp::CmdArgsInterface::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: CmdArgsInterface.cpp:651
+
Hazelnp::CmdArgsInterface::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: CmdArgsInterface.cpp:670
Hazelnp::Parameter
Definition: Parameter.h:8
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
Version.h
@@ -248,23 +248,23 @@ $(function() {
Hazelnp::CmdArgsInterface::HasDescription
bool HasDescription(const std::string &parameter) const
Returns whether or not a given parameter has a registered description.
Definition: CmdArgsInterface.cpp:407
Hazelnp::CmdArgsInterface::ClearDescription
void ClearDescription(const std::string &parameter)
Will delete the description of a parameter if it exists.
Definition: CmdArgsInterface.cpp:412
Hazelnp::CmdArgsInterface::CmdArgsInterface
CmdArgsInterface()
Definition: CmdArgsInterface.cpp:15
-
Hazelnp::CmdArgsInterface::ClearAbbreviation
void ClearAbbreviation(const std::string &abbrevation)
Will delete the abbreviation for a given parameter.
Definition: CmdArgsInterface.cpp:632
+
Hazelnp::CmdArgsInterface::ClearAbbreviation
void ClearAbbreviation(const std::string &abbrevation)
Will delete the abbreviation for a given parameter.
Definition: CmdArgsInterface.cpp:651
Hazelnp::CmdArgsInterface::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: CmdArgsInterface.cpp:36
Hazelnp::CmdArgsInterface::SetBriefDescription
void SetBriefDescription(const std::string &description)
Sets a brief description of the application to be automatically added to the documentation.
Definition: CmdArgsInterface.cpp:379
Hazelnp::CmdArgsInterface::GetBriefDescription
const std::string & GetBriefDescription()
Returns the brief description of the application to be automatically added to the documentation.
Definition: CmdArgsInterface.cpp:385
-
Hazelnp::CmdArgsInterface::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: CmdArgsInterface.cpp:604
+
Hazelnp::CmdArgsInterface::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: CmdArgsInterface.cpp:623
Hazelnp::CmdArgsInterface::ClearDescriptions
void ClearDescriptions()
Will delete all parameter descriptions.
Definition: CmdArgsInterface.cpp:419
Parameter.h
Hazelnp::CmdArgsInterface::GenerateDocumentation
std::string GenerateDocumentation() const
Will generate a text-based documentation suited to show the user, for example on –help.
Definition: CmdArgsInterface.cpp:425
Hazelnp::CmdArgsInterface::RegisterDescription
void RegisterDescription(const std::string &parameter, const std::string &description)
Willl register a short description for a parameter.
Definition: CmdArgsInterface.cpp:390
Hazelnp::CmdArgsInterface::GetDescription
const std::string & GetDescription(const std::string &parameter) const
Will return a short description for a parameter, if it exists.
Definition: CmdArgsInterface.cpp:396
-
Hazelnp::CmdArgsInterface::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f) Returns "" if no match is found.
Definition: CmdArgsInterface.cpp:619
-
Hazelnp::CmdArgsInterface::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: CmdArgsInterface.cpp:599
-
Hazelnp::CmdArgsInterface::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: CmdArgsInterface.cpp:657
+
Hazelnp::CmdArgsInterface::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f) Returns "" if no match is found.
Definition: CmdArgsInterface.cpp:638
+
Hazelnp::CmdArgsInterface::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: CmdArgsInterface.cpp:618
+
Hazelnp::CmdArgsInterface::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: CmdArgsInterface.cpp:676
Hazelnp::CmdArgsInterface::~CmdArgsInterface
~CmdArgsInterface()
Definition: CmdArgsInterface.cpp:26
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/DataType_8h.html b/docs/DataType_8h.html index 6775d0e..3a856c5 100644 --- a/docs/DataType_8h.html +++ b/docs/DataType_8h.html @@ -148,7 +148,7 @@ Functions
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/DataType_8h_source.html b/docs/DataType_8h_source.html index e2a996d..b22f824 100644 --- a/docs/DataType_8h_source.html +++ b/docs/DataType_8h_source.html @@ -128,7 +128,7 @@ $(function() {
Hazelnp::DataTypeToString
static std::string DataTypeToString(DATA_TYPE type)
Definition: DataType.h:17
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index 5107001..f8ec55b 100644 --- a/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html +++ b/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html @@ -77,7 +77,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/FloatValue_8cpp.html b/docs/FloatValue_8cpp.html index c61a61e..0b2e649 100644 --- a/docs/FloatValue_8cpp.html +++ b/docs/FloatValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for FloatValue.cpp:
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/FloatValue_8cpp_source.html b/docs/FloatValue_8cpp_source.html index 20272e8..ae93689 100644 --- a/docs/FloatValue_8cpp_source.html +++ b/docs/FloatValue_8cpp_source.html @@ -173,7 +173,7 @@ $(function() {
Hazelnp::FloatValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:49
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/FloatValue_8h.html b/docs/FloatValue_8h.html index 00a31e6..097eaa2 100644 --- a/docs/FloatValue_8h.html +++ b/docs/FloatValue_8h.html @@ -123,7 +123,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/FloatValue_8h_source.html b/docs/FloatValue_8h_source.html index 31415bf..d0d50ef 100644 --- a/docs/FloatValue_8h_source.html +++ b/docs/FloatValue_8h_source.html @@ -142,7 +142,7 @@ $(function() {
Hazelnp::FloatValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:49
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/HazelnuppException_8h.html b/docs/HazelnuppException_8h.html index 07a0d5b..281e9ac 100644 --- a/docs/HazelnuppException_8h.html +++ b/docs/HazelnuppException_8h.html @@ -146,7 +146,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/HazelnuppException_8h_source.html b/docs/HazelnuppException_8h_source.html index 6928984..5f3693b 100644 --- a/docs/HazelnuppException_8h_source.html +++ b/docs/HazelnuppException_8h_source.html @@ -224,7 +224,7 @@ $(function() {
Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException
HazelnuppInvalidKeyException()
Definition: HazelnuppException.h:32
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/IntValue_8cpp.html b/docs/IntValue_8cpp.html index 453ed68..35689e7 100644 --- a/docs/IntValue_8cpp.html +++ b/docs/IntValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for IntValue.cpp:
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/IntValue_8cpp_source.html b/docs/IntValue_8cpp_source.html index 0d88ce1..2c6dcfb 100644 --- a/docs/IntValue_8cpp_source.html +++ b/docs/IntValue_8cpp_source.html @@ -173,7 +173,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/IntValue_8h.html b/docs/IntValue_8h.html index 0e2b3da..4e10232 100644 --- a/docs/IntValue_8h.html +++ b/docs/IntValue_8h.html @@ -122,7 +122,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/IntValue_8h_source.html b/docs/IntValue_8h_source.html index 4a91cd3..06d1bd7 100644 --- a/docs/IntValue_8h_source.html +++ b/docs/IntValue_8h_source.html @@ -142,7 +142,7 @@ $(function() {
Value.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/ListValue_8cpp.html b/docs/ListValue_8cpp.html index 19e9be7..4dd1fa6 100644 --- a/docs/ListValue_8cpp.html +++ b/docs/ListValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for ListValue.cpp:
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/ListValue_8cpp_source.html b/docs/ListValue_8cpp_source.html index b112bf6..77e2860 100644 --- a/docs/ListValue_8cpp_source.html +++ b/docs/ListValue_8cpp_source.html @@ -199,7 +199,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/ListValue_8h.html b/docs/ListValue_8h.html index 4bf111e..293c8cc 100644 --- a/docs/ListValue_8h.html +++ b/docs/ListValue_8h.html @@ -123,7 +123,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/ListValue_8h_source.html b/docs/ListValue_8h_source.html index 9939aac..b3cf8fd 100644 --- a/docs/ListValue_8h_source.html +++ b/docs/ListValue_8h_source.html @@ -145,7 +145,7 @@ $(function() {
Value.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/ParamConstraint_8h.html b/docs/ParamConstraint_8h.html index 54b1519..0e07d70 100644 --- a/docs/ParamConstraint_8h.html +++ b/docs/ParamConstraint_8h.html @@ -121,7 +121,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/ParamConstraint_8h_source.html b/docs/ParamConstraint_8h_source.html index e31dddb..e679d3b 100644 --- a/docs/ParamConstraint_8h_source.html +++ b/docs/ParamConstraint_8h_source.html @@ -192,7 +192,7 @@ $(function() {
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:78
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Parameter_8cpp.html b/docs/Parameter_8cpp.html index 6f99d7e..4cfdd7c 100644 --- a/docs/Parameter_8cpp.html +++ b/docs/Parameter_8cpp.html @@ -98,7 +98,7 @@ Include dependency graph for Parameter.cpp:
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Parameter_8cpp_source.html b/docs/Parameter_8cpp_source.html index 8cd13db..eaf4c65 100644 --- a/docs/Parameter_8cpp_source.html +++ b/docs/Parameter_8cpp_source.html @@ -116,7 +116,7 @@ $(function() {
Parameter.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Parameter_8h.html b/docs/Parameter_8h.html index f6479e5..bd8e1c7 100644 --- a/docs/Parameter_8h.html +++ b/docs/Parameter_8h.html @@ -124,7 +124,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Parameter_8h_source.html b/docs/Parameter_8h_source.html index 5cea65a..643d497 100644 --- a/docs/Parameter_8h_source.html +++ b/docs/Parameter_8h_source.html @@ -119,7 +119,7 @@ $(function() {
Value.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Placeholders_8h.html b/docs/Placeholders_8h.html index ceb7b7f..f28f0b9 100644 --- a/docs/Placeholders_8h.html +++ b/docs/Placeholders_8h.html @@ -119,7 +119,7 @@ Variables
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Placeholders_8h_source.html b/docs/Placeholders_8h_source.html index a8812ad..36aec61 100644 --- a/docs/Placeholders_8h_source.html +++ b/docs/Placeholders_8h_source.html @@ -94,7 +94,7 @@ $(function() {
Hazelnp::Placeholders::g_emptyString
static const std::string g_emptyString
The only purpose of this is to provide the ability to return an empty string as an error for std::str...
Definition: Placeholders.h:9
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index 31bfa75..069081b 100644 --- a/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html +++ b/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html @@ -77,7 +77,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringTools_8cpp.html b/docs/StringTools_8cpp.html index 704217c..6fdcc09 100644 --- a/docs/StringTools_8cpp.html +++ b/docs/StringTools_8cpp.html @@ -97,7 +97,7 @@ Include dependency graph for StringTools.cpp:
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringTools_8cpp_source.html b/docs/StringTools_8cpp_source.html index 8004039..6976dca 100644 --- a/docs/StringTools_8cpp_source.html +++ b/docs/StringTools_8cpp_source.html @@ -275,7 +275,7 @@ $(function() {
StringTools.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringTools_8h.html b/docs/StringTools_8h.html index 97941f8..b23a22d 100644 --- a/docs/StringTools_8h.html +++ b/docs/StringTools_8h.html @@ -126,7 +126,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringTools_8h_source.html b/docs/StringTools_8h_source.html index ef0eba9..415291d 100644 --- a/docs/StringTools_8h_source.html +++ b/docs/StringTools_8h_source.html @@ -133,7 +133,7 @@ $(function() {
Hazelnp::Internal::StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:56
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringValue_8cpp.html b/docs/StringValue_8cpp.html index bde395a..42d321f 100644 --- a/docs/StringValue_8cpp.html +++ b/docs/StringValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for StringValue.cpp:
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringValue_8cpp_source.html b/docs/StringValue_8cpp_source.html index 55a29de..b229d2a 100644 --- a/docs/StringValue_8cpp_source.html +++ b/docs/StringValue_8cpp_source.html @@ -165,7 +165,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringValue_8h.html b/docs/StringValue_8h.html index ab48635..392b184 100644 --- a/docs/StringValue_8h.html +++ b/docs/StringValue_8h.html @@ -123,7 +123,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/StringValue_8h_source.html b/docs/StringValue_8h_source.html index df058a6..c1e21f0 100644 --- a/docs/StringValue_8h_source.html +++ b/docs/StringValue_8h_source.html @@ -141,7 +141,7 @@ $(function() {
Value.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Value_8cpp.html b/docs/Value_8cpp.html index 8874cb2..b229703 100644 --- a/docs/Value_8cpp.html +++ b/docs/Value_8cpp.html @@ -97,7 +97,7 @@ Include dependency graph for Value.cpp:
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Value_8cpp_source.html b/docs/Value_8cpp_source.html index b163d91..1f6813b 100644 --- a/docs/Value_8cpp_source.html +++ b/docs/Value_8cpp_source.html @@ -102,7 +102,7 @@ $(function() {
Value.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Value_8h.html b/docs/Value_8h.html index 6287b61..9a40655 100644 --- a/docs/Value_8h.html +++ b/docs/Value_8h.html @@ -136,7 +136,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Value_8h_source.html b/docs/Value_8h_source.html index cb69dae..5646720 100644 --- a/docs/Value_8h_source.html +++ b/docs/Value_8h_source.html @@ -148,7 +148,7 @@ $(function() {
Hazelnp::Value::GetFloat64
virtual long double GetFloat64() const =0
Will attempt to return the floating-point data (long double)
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Version_8h.html b/docs/Version_8h.html index 88eb5c0..a8eff47 100644 --- a/docs/Version_8h.html +++ b/docs/Version_8h.html @@ -95,7 +95,7 @@ This graph shows which files directly or indirectly include this file: - +

Macros

#define HAZELNUPP_VERSION   (1.1)
#define HAZELNUPP_VERSION   (1.11)
 

Macro Definition Documentation

@@ -106,7 +106,7 @@ Macros
- +
#define HAZELNUPP_VERSION   (1.1)#define HAZELNUPP_VERSION   (1.11)
@@ -118,7 +118,7 @@ Macros
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/Version_8h_source.html b/docs/Version_8h_source.html index ed9aadc..5d14a35 100644 --- a/docs/Version_8h_source.html +++ b/docs/Version_8h_source.html @@ -79,11 +79,11 @@ $(function() {
Go to the documentation of this file.
1 #pragma once
-
2 #define HAZELNUPP_VERSION (1.1)
+
2 #define HAZELNUPP_VERSION (1.11)
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/VoidValue_8cpp.html b/docs/VoidValue_8cpp.html index b08eaba..afa2919 100644 --- a/docs/VoidValue_8cpp.html +++ b/docs/VoidValue_8cpp.html @@ -102,7 +102,7 @@ Include dependency graph for VoidValue.cpp:
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/VoidValue_8cpp_source.html b/docs/VoidValue_8cpp_source.html index ff2e019..6338699 100644 --- a/docs/VoidValue_8cpp_source.html +++ b/docs/VoidValue_8cpp_source.html @@ -151,7 +151,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/VoidValue_8h.html b/docs/VoidValue_8h.html index 9782ef7..b5d7760 100644 --- a/docs/VoidValue_8h.html +++ b/docs/VoidValue_8h.html @@ -122,7 +122,7 @@ Namespaces
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/VoidValue_8h_source.html b/docs/VoidValue_8h_source.html index 7f8c44b..b3f76df 100644 --- a/docs/VoidValue_8h_source.html +++ b/docs/VoidValue_8h_source.html @@ -131,7 +131,7 @@ $(function() {
Value.h
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/annotated.html b/docs/annotated.html index b160b04..632b194 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -100,7 +100,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1CmdArgsInterface-members.html b/docs/classHazelnp_1_1CmdArgsInterface-members.html index d81f960..7abfe7b 100644 --- a/docs/classHazelnp_1_1CmdArgsInterface-members.html +++ b/docs/classHazelnp_1_1CmdArgsInterface-members.html @@ -112,7 +112,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1CmdArgsInterface.html b/docs/classHazelnp_1_1CmdArgsInterface.html index d3025f7..10a8177 100644 --- a/docs/classHazelnp_1_1CmdArgsInterface.html +++ b/docs/classHazelnp_1_1CmdArgsInterface.html @@ -281,11 +281,11 @@ Public Member Functions


IMPORTANT: This parameter is the abbreviation! Not the long form!

-

Definition at line 632 of file CmdArgsInterface.cpp.

-
633 {
-
634  parameterAbreviations.erase(abbrevation);
-
635  return;
-
636 }
+

Definition at line 651 of file CmdArgsInterface.cpp.

+
652 {
+
653  parameterAbreviations.erase(abbrevation);
+
654  return;
+
655 }
@@ -306,11 +306,11 @@ Public Member Functions

Will delete all abbreviations.

-

Definition at line 638 of file CmdArgsInterface.cpp.

-
639 {
-
640  parameterAbreviations.clear();
-
641  return;
-
642 }
+

Definition at line 657 of file CmdArgsInterface.cpp.

+
658 {
+
659  parameterAbreviations.clear();
+
660  return;
+
661 }
@@ -332,11 +332,11 @@ Public Member Functions

Will the constraint of a specific parameter.

-

Definition at line 593 of file CmdArgsInterface.cpp.

-
594 {
-
595  parameterConstraints.erase(parameter);
-
596  return;
-
597 }
+

Definition at line 612 of file CmdArgsInterface.cpp.

+
613 {
+
614  parameterConstraints.erase(parameter);
+
615  return;
+
616 }
@@ -357,11 +357,11 @@ Public Member Functions

Will delete all constraints.

-

Definition at line 651 of file CmdArgsInterface.cpp.

-
652 {
-
653  parameterConstraints.clear();
-
654  return;
-
655 }
+

Definition at line 670 of file CmdArgsInterface.cpp.

+
671 {
+
672  parameterConstraints.clear();
+
673  return;
+
674 }
@@ -451,102 +451,121 @@ Public Member Functions
439  bool required = false;
440  bool typeIsForced = false;
441  std::string defaultVal;
-
442  };
-
443  std::unordered_map<std::string, ParamDocEntry> paramInfos;
-
444 
-
445  // Collect descriptions
-
446  for (const auto& it : parameterDescriptions)
-
447  {
-
448  // Do we already have that param in the paramInfo set?
-
449  if (paramInfos.find(it.first) == paramInfos.end())
-
450  // No? Create it.
-
451  paramInfos[it.first] = ParamDocEntry();
-
452 
-
453  paramInfos[it.first].description = it.second;
-
454  }
-
455 
-
456  // Collect abbreviations
-
457  // first value is abbreviation, second is long form
-
458  for (const auto& it : parameterAbreviations)
-
459  {
-
460  // Do we already have that param in the paramInfo set?
-
461  if (paramInfos.find(it.second) == paramInfos.end())
-
462  // No? Create it.
-
463  paramInfos[it.second] = ParamDocEntry();
-
464 
-
465  paramInfos[it.second].abbreviation = it.first;
-
466  }
-
467 
-
468  // Collect constraints
-
469  for (const auto& it : parameterConstraints)
-
470  {
-
471  // Do we already have that param in the paramInfo set?
-
472  if (paramInfos.find(it.first) == paramInfos.end())
-
473  // No? Create it.
-
474  paramInfos[it.first] = ParamDocEntry();
-
475 
-
476  ParamDocEntry& cached = paramInfos[it.first];
-
477  cached.required = it.second.required;
-
478  cached.typeIsForced = it.second.constrainType;
-
479  cached.type = DataTypeToString(it.second.requiredType);
-
480 
-
481  std::stringstream defaultValueSs;
-
482  for (const std::string& s : it.second.defaultValue)
-
483  {
-
484  defaultValueSs << '\'' << s << '\'';
-
485 
-
486  // Add a space if we are not at the last entry
-
487  if ((void*)&s != (void*)&it.second.defaultValue.back())
-
488  defaultValueSs << " ";
-
489  }
-
490  cached.defaultVal = defaultValueSs.str();
-
491  }
-
492 
-
493  // Now generate the documentatino body
-
494  if (paramInfos.size() > 0)
-
495  {
-
496  ss << std::endl
-
497  << "==== AVAILABLE PARAMETERS ===="
-
498  << std::endl << std::endl;
-
499 
-
500  std::size_t counter = 0;
-
501  for (const auto& it : paramInfos)
-
502  {
-
503  const ParamDocEntry& pde = it.second;
-
504 
-
505  // Put name
-
506  ss << it.first << " ";
+
442  std::string incompatibilities;
+
443  };
+
444  std::unordered_map<std::string, ParamDocEntry> paramInfos;
+
445 
+
446  // Collect descriptions
+
447  for (const auto& it : parameterDescriptions)
+
448  {
+
449  // Do we already have that param in the paramInfo set?
+
450  if (paramInfos.find(it.first) == paramInfos.end())
+
451  // No? Create it.
+
452  paramInfos[it.first] = ParamDocEntry();
+
453 
+
454  paramInfos[it.first].description = it.second;
+
455  }
+
456 
+
457  // Collect abbreviations
+
458  // first value is abbreviation, second is long form
+
459  for (const auto& it : parameterAbreviations)
+
460  {
+
461  // Do we already have that param in the paramInfo set?
+
462  if (paramInfos.find(it.second) == paramInfos.end())
+
463  // No? Create it.
+
464  paramInfos[it.second] = ParamDocEntry();
+
465 
+
466  paramInfos[it.second].abbreviation = it.first;
+
467  }
+
468 
+
469  // Collect constraints
+
470  for (const auto& it : parameterConstraints)
+
471  {
+
472  // Do we already have that param in the paramInfo set?
+
473  if (paramInfos.find(it.first) == paramInfos.end())
+
474  // No? Create it.
+
475  paramInfos[it.first] = ParamDocEntry();
+
476 
+
477  ParamDocEntry& cached = paramInfos[it.first];
+
478  cached.required = it.second.required;
+
479  cached.typeIsForced = it.second.constrainType;
+
480  cached.type = DataTypeToString(it.second.requiredType);
+
481 
+
482  // Build default-value string
+
483  std::stringstream vec2str_ss;
+
484  for (const std::string& s : it.second.defaultValue)
+
485  {
+
486  vec2str_ss << '\'' << s << '\'';
+
487 
+
488  // Add a space if we are not at the last entry
+
489  if ((void*)&s != (void*)&it.second.defaultValue.back())
+
490  vec2str_ss << " ";
+
491  }
+
492  cached.defaultVal = vec2str_ss.str();
+
493 
+
494 
+
495  // Build incompatibilities string
+
496  vec2str_ss.str("");
+
497  for (const std::string& s : it.second.incompatibleParameters)
+
498  {
+
499  vec2str_ss << s;
+
500 
+
501  // Add a comma-space if we are not at the last entry
+
502  if ((void*)&s != (void*)&it.second.incompatibleParameters.back())
+
503  vec2str_ss << ", ";
+
504  }
+
505  cached.incompatibilities = vec2str_ss.str();
+
506  }
507 
-
508  // Put abbreviation
-
509  if (pde.abbreviation.length() > 0)
-
510  ss << pde.abbreviation << " ";
-
511 
-
512  // Put type
-
513  if (pde.typeIsForced)
-
514  ss << pde.type << " ";
-
515 
-
516  // Put default value
-
517  if (pde.defaultVal.length() > 0)
-
518  ss << "default=[" << pde.defaultVal << "] ";
+
508  // Now generate the documentation body
+
509  if (paramInfos.size() > 0)
+
510  {
+
511  ss << std::endl
+
512  << "==== AVAILABLE PARAMETERS ===="
+
513  << std::endl << std::endl;
+
514 
+
515  std::size_t counter = 0;
+
516  for (const auto& it : paramInfos)
+
517  {
+
518  const ParamDocEntry& pde = it.second;
519 
-
520  // Put required tag, but only if no default value
-
521  if ((pde.required) && (pde.defaultVal.length() == 0))
-
522  ss << "[[REQUIRED]] ";
-
523 
-
524  // Put brief description
-
525  if (pde.description.length() > 0)
-
526  ss << pde.description;
-
527 
-
528  // Omit linebreaks when we're on the last element
-
529  if (counter < paramInfos.size()-1)
-
530  ss << std::endl << std::endl;
-
531 
-
532  counter++;
-
533  }
-
534  }
-
535 
-
536  return ss.str();
-
537 }
+
520  // Put name
+
521  ss << it.first << " ";
+
522 
+
523  // Put abbreviation
+
524  if (pde.abbreviation.length() > 0)
+
525  ss << pde.abbreviation << " ";
+
526 
+
527  // Put type
+
528  if (pde.typeIsForced)
+
529  ss << pde.type << " ";
+
530 
+
531  // Put default value
+
532  if (pde.defaultVal.length() > 0)
+
533  ss << "default=[" << pde.defaultVal << "] ";
+
534 
+
535  // Put incompatibilities
+
536  if (pde.incompatibilities.length() > 0)
+
537  ss << "incompatibilities=[" << pde.incompatibilities << "] ";
+
538 
+
539  // Put required tag, but only if no default value
+
540  if ((pde.required) && (pde.defaultVal.length() == 0))
+
541  ss << "[[REQUIRED]] ";
+
542 
+
543  // Put brief description
+
544  if (pde.description.length() > 0)
+
545  ss << pde.description;
+
546 
+
547  // Omit linebreaks when we're on the last element
+
548  if (counter < paramInfos.size()-1)
+
549  ss << std::endl << std::endl;
+
550 
+
551  counter++;
+
552  }
+
553  }
+
554 
+
555  return ss.str();
+
556 }
@@ -569,13 +588,13 @@ Public Member Functions

Will return the long form of an abbreviation (like –force for -f)
Returns "" if no match is found.

-

Definition at line 619 of file CmdArgsInterface.cpp.

-
620 {
-
621  if (!HasAbbreviation(abbrev))
-
622  return Placeholders::g_emptyString;
-
623 
-
624  return parameterAbreviations.find(abbrev)->second;
-
625 }
+

Definition at line 638 of file CmdArgsInterface.cpp.

+
639 {
+
640  if (!HasAbbreviation(abbrev))
+
641  return Placeholders::g_emptyString;
+
642 
+
643  return parameterAbreviations.find(abbrev)->second;
+
644 }
@@ -645,10 +664,10 @@ Public Member Functions

Will return the constraint information for a specific parameter.

-

Definition at line 588 of file CmdArgsInterface.cpp.

-
589 {
-
590  return parameterConstraints.find(parameter)->second;
-
591 }
+

Definition at line 607 of file CmdArgsInterface.cpp.

+
608 {
+
609  return parameterConstraints.find(parameter)->second;
+
610 }
@@ -726,10 +745,10 @@ Public Member Functions

Will return argv[0], the name of the executable.

-

Definition at line 599 of file CmdArgsInterface.cpp.

-
600 {
-
601  return executableName;
-
602 }
+

Definition at line 618 of file CmdArgsInterface.cpp.

+
619 {
+
620  return executableName;
+
621 }
@@ -751,10 +770,10 @@ Public Member Functions

Will check wether or not an abbreviation is registered.

-

Definition at line 627 of file CmdArgsInterface.cpp.

-
628 {
-
629  return parameterAbreviations.find(abbrev) != parameterAbreviations.end();
-
630 }
+

Definition at line 646 of file CmdArgsInterface.cpp.

+
647 {
+
648  return parameterAbreviations.find(abbrev) != parameterAbreviations.end();
+
649 }
@@ -826,14 +845,14 @@ Public Member Functions

Will return the value given a key.

-

Definition at line 604 of file CmdArgsInterface.cpp.

-
605 {
-
606  // Throw exception if param is unknown
-
607  if (!HasParam(key))
-
608  throw HazelnuppInvalidKeyException();
-
609 
-
610  return *parameters.find(key)->second->GetValue();
-
611 }
+

Definition at line 623 of file CmdArgsInterface.cpp.

+
624 {
+
625  // Throw exception if param is unknown
+
626  if (!HasParam(key))
+
627  throw HazelnuppInvalidKeyException();
+
628 
+
629  return *parameters.find(key)->second->GetValue();
+
630 }
@@ -994,11 +1013,11 @@ Public Member Functions

Will register an abbreviation (like -f for –force)

-

Definition at line 613 of file CmdArgsInterface.cpp.

-
614 {
-
615  parameterAbreviations.insert(std::pair<std::string, std::string>(abbrev, target));
-
616  return;
-
617 }
+

Definition at line 632 of file CmdArgsInterface.cpp.

+
633 {
+
634  parameterAbreviations.insert(std::pair<std::string, std::string>(abbrev, target));
+
635  return;
+
636 }
@@ -1031,12 +1050,12 @@ Public Member Functions

Will register a constraint for a parameter.

IMPORTANT: Any parameter can only have ONE constraint. Applying a new one will overwrite the old one! Construct the ParamConstraint struct yourself to combine Require, TypeSafety and Incompatibilities! You can also use the ParamConstraint constructor!

-

Definition at line 644 of file CmdArgsInterface.cpp.

-
645 {
-
646  // Magic syntax, wooo
-
647  (parameterConstraints[key] = constraint).key = key;
-
648  return;
-
649 }
+

Definition at line 663 of file CmdArgsInterface.cpp.

+
664 {
+
665  // Magic syntax, wooo
+
666  (parameterConstraints[key] = constraint).key = key;
+
667  return;
+
668 }
@@ -1148,11 +1167,11 @@ Public Member Functions

Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsing, or not.

-

Definition at line 657 of file CmdArgsInterface.cpp.

-
658 {
-
659  this->crashOnFail = crashOnFail;
-
660  return;
-
661 }
+

Definition at line 676 of file CmdArgsInterface.cpp.

+
677 {
+
678  this->crashOnFail = crashOnFail;
+
679  return;
+
680 }
@@ -1162,7 +1181,7 @@ Public Member Functions
Hazelnp::HazelnuppConstraintIncompatibleParameters
Gets thrown when a parameter constrained to be incompatible with other parameters gets supplied along...
Definition: HazelnuppException.h:101
-
Hazelnp::CmdArgsInterface::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: CmdArgsInterface.cpp:627
+
Hazelnp::CmdArgsInterface::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: CmdArgsInterface.cpp:646
Hazelnp::HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:29
Hazelnp::HazelnuppException::What
const std::string & What() const
Will return an error message.
Definition: HazelnuppException.h:18
Hazelnp::HazelnuppConstraintException
Gets thrown something bad happens because of parameter constraints.
Definition: HazelnuppException.h:47
@@ -1179,7 +1198,7 @@ Public Member Functions
Hazelnp::DataTypeToString
static std::string DataTypeToString(DATA_TYPE type)
Definition: DataType.h:17
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1FloatValue-members.html b/docs/classHazelnp_1_1FloatValue-members.html index a2822fa..d12b7d5 100644 --- a/docs/classHazelnp_1_1FloatValue-members.html +++ b/docs/classHazelnp_1_1FloatValue-members.html @@ -101,7 +101,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1FloatValue.html b/docs/classHazelnp_1_1FloatValue.html index 8977d18..1ca4c1e 100644 --- a/docs/classHazelnp_1_1FloatValue.html +++ b/docs/classHazelnp_1_1FloatValue.html @@ -574,7 +574,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException-members.html b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html index 9d79ff1..f21f515 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintException-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html @@ -90,7 +90,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException.html b/docs/classHazelnp_1_1HazelnuppConstraintException.html index 037af04..e6a4755 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintException.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintException.html @@ -202,7 +202,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:14
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters-members.html b/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters-members.html index 3b79b2b..d7a92c0 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters-members.html @@ -92,7 +92,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html b/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html index b94b0dc..34db4b2 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html @@ -224,7 +224,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::message
std::string message
Definition: HazelnuppException.h:24
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html index 8da631e..f4aa47c 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html @@ -92,7 +92,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html index 566f7d6..e9c2b7d 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html @@ -228,7 +228,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::message
std::string message
Definition: HazelnuppException.h:24
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html index 691acca..db7320c 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html @@ -93,7 +93,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html index 9a33e23..97d1f9b 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html @@ -273,7 +273,7 @@ Additional Inherited Members
Hazelnp::DataTypeToString
static std::string DataTypeToString(DATA_TYPE type)
Definition: DataType.h:17
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppException-members.html b/docs/classHazelnp_1_1HazelnuppException-members.html index 55574d7..47a845d 100644 --- a/docs/classHazelnp_1_1HazelnuppException-members.html +++ b/docs/classHazelnp_1_1HazelnuppException-members.html @@ -88,7 +88,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppException.html b/docs/classHazelnp_1_1HazelnuppException.html index caf92d2..51764e9 100644 --- a/docs/classHazelnp_1_1HazelnuppException.html +++ b/docs/classHazelnp_1_1HazelnuppException.html @@ -256,7 +256,7 @@ Protected Attributes
Hazelnp::HazelnuppException::message
std::string message
Definition: HazelnuppException.h:24
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html index c42b673..48c40c7 100644 --- a/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html @@ -90,7 +90,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html index b93359c..360b96f 100644 --- a/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html @@ -199,7 +199,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:14
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html index 374f8f6..3c80dd0 100644 --- a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html @@ -90,7 +90,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html index a4181b3..7d1f46c 100644 --- a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html @@ -199,7 +199,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:14
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1IntValue-members.html b/docs/classHazelnp_1_1IntValue-members.html index ca99408..aceb6e5 100644 --- a/docs/classHazelnp_1_1IntValue-members.html +++ b/docs/classHazelnp_1_1IntValue-members.html @@ -101,7 +101,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1IntValue.html b/docs/classHazelnp_1_1IntValue.html index 93bf8a3..a315449 100644 --- a/docs/classHazelnp_1_1IntValue.html +++ b/docs/classHazelnp_1_1IntValue.html @@ -574,7 +574,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1Internal_1_1StringTools-members.html b/docs/classHazelnp_1_1Internal_1_1StringTools-members.html index 2a44f5b..b4c163d 100644 --- a/docs/classHazelnp_1_1Internal_1_1StringTools-members.html +++ b/docs/classHazelnp_1_1Internal_1_1StringTools-members.html @@ -92,7 +92,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1Internal_1_1StringTools.html b/docs/classHazelnp_1_1Internal_1_1StringTools.html index 041fcff..d9134bf 100644 --- a/docs/classHazelnp_1_1Internal_1_1StringTools.html +++ b/docs/classHazelnp_1_1Internal_1_1StringTools.html @@ -626,7 +626,7 @@ Static Public Member Functions
Hazelnp::Internal::StringTools::SplitString
static std::vector< std::string > SplitString(const std::string &str, const char delimiter)
Will split a string by a delimiter char. The delimiter will be excluded!
Definition: StringTools.cpp:125
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1ListValue-members.html b/docs/classHazelnp_1_1ListValue-members.html index d10bb6c..cdb7e6f 100644 --- a/docs/classHazelnp_1_1ListValue-members.html +++ b/docs/classHazelnp_1_1ListValue-members.html @@ -101,7 +101,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1ListValue.html b/docs/classHazelnp_1_1ListValue.html index 8bdc99c..ce45532 100644 --- a/docs/classHazelnp_1_1ListValue.html +++ b/docs/classHazelnp_1_1ListValue.html @@ -601,7 +601,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1Parameter-members.html b/docs/classHazelnp_1_1Parameter-members.html index 83491d1..95e434d 100644 --- a/docs/classHazelnp_1_1Parameter-members.html +++ b/docs/classHazelnp_1_1Parameter-members.html @@ -89,7 +89,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1Parameter.html b/docs/classHazelnp_1_1Parameter.html index adef864..218d369 100644 --- a/docs/classHazelnp_1_1Parameter.html +++ b/docs/classHazelnp_1_1Parameter.html @@ -275,7 +275,7 @@ Friends
Hazelnp::Value::Deepcopy
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1StringValue-members.html b/docs/classHazelnp_1_1StringValue-members.html index 531a8f9..43421b3 100644 --- a/docs/classHazelnp_1_1StringValue-members.html +++ b/docs/classHazelnp_1_1StringValue-members.html @@ -100,7 +100,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1StringValue.html b/docs/classHazelnp_1_1StringValue.html index 02a9406..e6911b3 100644 --- a/docs/classHazelnp_1_1StringValue.html +++ b/docs/classHazelnp_1_1StringValue.html @@ -547,7 +547,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1Value-members.html b/docs/classHazelnp_1_1Value-members.html index 0eedf6a..567c4ee 100644 --- a/docs/classHazelnp_1_1Value-members.html +++ b/docs/classHazelnp_1_1Value-members.html @@ -97,7 +97,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1Value.html b/docs/classHazelnp_1_1Value.html index 9b20c1d..6bbd5b7 100644 --- a/docs/classHazelnp_1_1Value.html +++ b/docs/classHazelnp_1_1Value.html @@ -548,7 +548,7 @@ Friends
Hazelnp::Value::type
DATA_TYPE type
Definition: Value.h:48
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1VoidValue-members.html b/docs/classHazelnp_1_1VoidValue-members.html index 0499f22..391d0c1 100644 --- a/docs/classHazelnp_1_1VoidValue-members.html +++ b/docs/classHazelnp_1_1VoidValue-members.html @@ -98,7 +98,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classHazelnp_1_1VoidValue.html b/docs/classHazelnp_1_1VoidValue.html index c751f81..7d344f7 100644 --- a/docs/classHazelnp_1_1VoidValue.html +++ b/docs/classHazelnp_1_1VoidValue.html @@ -494,7 +494,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:38
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/classes.html b/docs/classes.html index 2a0e0c9..e0f8d52 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -124,7 +124,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html b/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html index 8363b5e..13ce84f 100644 --- a/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html +++ b/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html @@ -138,7 +138,7 @@ Files
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/dir_0cc5f59b28c403d42cc56800132eb975.html b/docs/dir_0cc5f59b28c403d42cc56800132eb975.html index 7c7fab5..53000f1 100644 --- a/docs/dir_0cc5f59b28c403d42cc56800132eb975.html +++ b/docs/dir_0cc5f59b28c403d42cc56800132eb975.html @@ -81,7 +81,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html b/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html index ff43e43..3cf21f1 100644 --- a/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html +++ b/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html @@ -81,7 +81,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/dir_a8cffda729361e9d9637effa362fcea9.html b/docs/dir_a8cffda729361e9d9637effa362fcea9.html index e2ff909..8011cfd 100644 --- a/docs/dir_a8cffda729361e9d9637effa362fcea9.html +++ b/docs/dir_a8cffda729361e9d9637effa362fcea9.html @@ -81,7 +81,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/files.html b/docs/files.html index d9cc59d..9820b82 100644 --- a/docs/files.html +++ b/docs/files.html @@ -108,7 +108,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:52 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:41 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/functions.html b/docs/functions.html index 676a4e8..632132f 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -446,7 +446,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:41 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/functions_func.html b/docs/functions_func.html index 5b7a7a1..ca98f75 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -416,7 +416,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:52 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:41 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/functions_rela.html b/docs/functions_rela.html index ddb58dc..070581c 100644 --- a/docs/functions_rela.html +++ b/docs/functions_rela.html @@ -82,7 +82,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:52 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:41 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/functions_vars.html b/docs/functions_vars.html index bb0627c..0dbfdbd 100644 --- a/docs/functions_vars.html +++ b/docs/functions_vars.html @@ -96,7 +96,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:52 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:41 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/globals.html b/docs/globals.html index 8c2cff5..c1b0cb7 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -78,7 +78,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:52 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:41 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/globals_defs.html b/docs/globals_defs.html index d650884..f39c57e 100644 --- a/docs/globals_defs.html +++ b/docs/globals_defs.html @@ -78,7 +78,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:52 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:41 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/graph_legend.html b/docs/graph_legend.html index 0a8e1d8..e48700b 100644 --- a/docs/graph_legend.html +++ b/docs/graph_legend.html @@ -137,7 +137,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 9602ae8..f048ffd 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -101,7 +101,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically:
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/index.html b/docs/index.html index 8d317d7..408ca13 100644 --- a/docs/index.html +++ b/docs/index.html @@ -427,15 +427,15 @@ LICENSE
Hazelnp::ParamConstraint::Incompatibility
static ParamConstraint Incompatibility(const std::initializer_list< std::string > &incompatibleParameters)
Constructs an incompatibility constraint.
Definition: ParamConstraint.h:37
Hazelnp::CmdArgsInterface::SetCatchHelp
void SetCatchHelp(bool catchHelp)
Sets whether the CmdArgsInterface should automatically catch the –help parameter, print the parameter...
Definition: CmdArgsInterface.cpp:368
Hazelnp::HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:29
-
Hazelnp::CmdArgsInterface::RegisterConstraint
void RegisterConstraint(const std::string &key, const ParamConstraint &constraint)
Will register a constraint for a parameter.
Definition: CmdArgsInterface.cpp:644
-
Hazelnp::CmdArgsInterface::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: CmdArgsInterface.cpp:613
+
Hazelnp::CmdArgsInterface::RegisterConstraint
void RegisterConstraint(const std::string &key, const ParamConstraint &constraint)
Will register a constraint for a parameter.
Definition: CmdArgsInterface.cpp:663
+
Hazelnp::CmdArgsInterface::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: CmdArgsInterface.cpp:632
Hazelnp::CmdArgsInterface::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: CmdArgsInterface.cpp:199
Hazelnp::CmdArgsInterface::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: CmdArgsInterface.cpp:36
Hazelnp::ParamConstraint::TypeSafety
static ParamConstraint TypeSafety(DATA_TYPE requiredType, bool constrainType=true)
Constructs a type-safety constraint.
Definition: ParamConstraint.h:26
Hazelnp::DATA_TYPE::INT
@ INT
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/index_8md.html b/docs/index_8md.html index 05c1c76..9d3d178 100644 --- a/docs/index_8md.html +++ b/docs/index_8md.html @@ -77,7 +77,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:50 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/inherits.html b/docs/inherits.html index 1a22fed..cbad597 100644 --- a/docs/inherits.html +++ b/docs/inherits.html @@ -123,7 +123,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespaceHazelnp.html b/docs/namespaceHazelnp.html index 9ab20dc..2599fcd 100644 --- a/docs/namespaceHazelnp.html +++ b/docs/namespaceHazelnp.html @@ -254,7 +254,7 @@ Functions
Hazelnp::DATA_TYPE::STRING
@ STRING
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespaceHazelnp_1_1Internal.html b/docs/namespaceHazelnp_1_1Internal.html index 285f776..aef0d22 100644 --- a/docs/namespaceHazelnp_1_1Internal.html +++ b/docs/namespaceHazelnp_1_1Internal.html @@ -90,7 +90,7 @@ Classes
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespaceHazelnp_1_1Placeholders.html b/docs/namespaceHazelnp_1_1Placeholders.html index 838e44d..e9d94a5 100644 --- a/docs/namespaceHazelnp_1_1Placeholders.html +++ b/docs/namespaceHazelnp_1_1Placeholders.html @@ -117,7 +117,7 @@ Variables
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespacemembers.html b/docs/namespacemembers.html index 2caf7e4..2b8ce37 100644 --- a/docs/namespacemembers.html +++ b/docs/namespacemembers.html @@ -84,7 +84,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespacemembers_enum.html b/docs/namespacemembers_enum.html index be263c7..1900f67 100644 --- a/docs/namespacemembers_enum.html +++ b/docs/namespacemembers_enum.html @@ -78,7 +78,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespacemembers_func.html b/docs/namespacemembers_func.html index 43b4d92..88e178c 100644 --- a/docs/namespacemembers_func.html +++ b/docs/namespacemembers_func.html @@ -78,7 +78,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespacemembers_vars.html b/docs/namespacemembers_vars.html index d17fdcd..809d2ff 100644 --- a/docs/namespacemembers_vars.html +++ b/docs/namespacemembers_vars.html @@ -78,7 +78,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/namespaces.html b/docs/namespaces.html index 8603c0f..9402376 100644 --- a/docs/namespaces.html +++ b/docs/namespaces.html @@ -84,7 +84,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/structHazelnp_1_1ParamConstraint-members.html b/docs/structHazelnp_1_1ParamConstraint-members.html index 697a467..4e80110 100644 --- a/docs/structHazelnp_1_1ParamConstraint-members.html +++ b/docs/structHazelnp_1_1ParamConstraint-members.html @@ -96,7 +96,7 @@ $(function() {
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17
diff --git a/docs/structHazelnp_1_1ParamConstraint.html b/docs/structHazelnp_1_1ParamConstraint.html index c1a70f7..fc41366 100644 --- a/docs/structHazelnp_1_1ParamConstraint.html +++ b/docs/structHazelnp_1_1ParamConstraint.html @@ -548,7 +548,7 @@ Friends
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:78
-Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by   +Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by   doxygen 1.8.17