nvneural::StringParamTypeDesc Struct Reference

The StringParamTypeDesc 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	paramDependenciesCount
	This is the amount of parameter dependencies contained in the memory block.
const ParamDependencyDesc *	pParamDependencies
	This is the array of parameter dependency with paramDependenciesCount members. More...
bool	supportsMultilineTextbox
	This is a UI hint for the size of the text box of the string. More...

Detailed Description

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

In this case, it describes string input. The only parameter is whether to use a multiline text box, otherwise a single line text box is used.

Member Data Documentation

pParamDependencies

const ParamDependencyDesc* nvneural::StringParamTypeDesc::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)

supportsMultilineTextbox

bool nvneural::StringParamTypeDesc::supportsMultilineTextbox

This is a UI hint for the size of the text box of the string.

Think single-line box versus multi-line.

---

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

• Core/Inc/nvneural/CoreTypes.h