nvneural::EnumParamTypeDesc Struct Reference

The EnumParamTypeDesc further describes a parameter for the plugin and is pointed to from the higher level parameter descriptor ParamDesc. More...

#include <nvneural/CoreTypes.h>

Public Attributes
BaseParamTypeDesc	baseDesc
	This is the base param desc struct which all xParamTypeDesc must have.
std::size_t	optionCount
	This is the amount of enum options contained in the memory block.
std::size_t	paramDependenciesCount
	This is the amount of parameter dependencies contained in the memory block.
const char *const *	pOptions
	This is the array of the enums with optionCount members. More...
const ParamDependencyDesc *	pParamDependencies
	This is the array of parameter dependency with paramDependenciesCount members. More...

Detailed Description

The EnumParamTypeDesc further describes a parameter for the plugin and is pointed to from the higher level parameter descriptor ParamDesc.

In this case, it describes an enumeration, using a count of enumerations and a char* array.

An example would be wanting an enumeration with "min" and "max". In this case, optionCount would be set to 2, and pOptions would point to a char array containing the strings of, "min" and "max". e.g.

const size_t enumNumOptions = 2; static const char* const enumOptions[enumNumOptions] = { "min", "max" };

Member Data Documentation

pOptions

const char* const* nvneural::EnumParamTypeDesc::pOptions

This is the array of the enums with optionCount members.

These members should be treated as UTF-8.

Example: "sum", "min", "max"

pParamDependencies

const ParamDependencyDesc* nvneural::EnumParamTypeDesc::pParamDependencies

This is the array of parameter dependency with paramDependenciesCount members.

Each dependency is treated as an AND in the final evaluation. If the same parameter name appears multiple time with different values then all its listed parameter value will be treated as an OR.

Examples: 1) pParamDependencies = [{"paramA", "valueA"}, {"paramB", "valueB"}] result in the following expression => (paramA with valueA) && (paramB with valueB) 2) pParamDependencies = [{"paramA", "valueA"}, {"paramA", "valueOpt"}, {"paramB", "valueB"}] result in the following expression => (paramA with valueA || paramA with valueOpt) && (paramB with valueB)

---

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

• Core/Inc/nvneural/CoreTypes.h