NvTweakVarBase Struct Reference

This is an abstract base class for indirectly referencing app variables. More...

#include <NvTweakVar.h>

Inheritance diagram for NvTweakVarBase:

List of all members.

Public Member Functions
const char *	getName ()
	Accessor to retrieve pointer to the name string.
const char *	getDesc ()
	Accessor to retrieve pointer to the description string.
uint32_t	getActionCode ()
	Accessor to retrieve the action code value.
Virtual methods for quick value tweaks to a variable.
virtual void	increment ()=0
virtual void	decrement ()=0
virtual void	reset ()=0
Virtual methods for testing equality against values without knowing our type.
virtual bool	equals (bool val)=0
virtual bool	equals (float val)=0
virtual bool	equals (uint32_t val)=0
Protected Member Functions
	NvTweakVarBase (const char *name, const char *description=NULL)
	Base constructor.
void	setActionCode (uint32_t code)
	Set the action code value for this variable.
Protected Attributes
const char *	mName
	A human-readable name/title of the variable.
const char *	mDesc
	An informative 'help' string for the variable.
uint32_t	mActionCode
	A unique value for signalling changes across systems.
Friends
class	NvTweakBar
class	NvTweakVarUI

---

Detailed Description

This is an abstract base class for indirectly referencing app variables.

---

Constructor & Destructor Documentation

NvTweakVarBase::NvTweakVarBase	(	const char *	name,
		const char *	description = NULL
	)			[inline, protected]

Base constructor.

Note that the base constructor defaults mActionCode to 0, expecting subclass constructors to set a meaningful, unique value afterward.

Parameters:

	name	A title for this variable.
	description	An OPTIONAL help string.

---

Member Function Documentation

uint32_t NvTweakVarBase::getActionCode

(

)

[inline]

Accessor to retrieve the action code value.

const char* NvTweakVarBase::getDesc

(

)

[inline]

Accessor to retrieve pointer to the description string.

const char* NvTweakVarBase::getName

(

)

[inline]

Accessor to retrieve pointer to the name string.

void NvTweakVarBase::setActionCode

(

uint32_t

code

)

[inline, protected]

Set the action code value for this variable.

---

Member Data Documentation

uint32_t NvTweakVarBase::mActionCode [protected]

A unique value for signalling changes across systems.

const char* NvTweakVarBase::mDesc [protected]

An informative 'help' string for the variable.

const char* NvTweakVarBase::mName [protected]

A human-readable name/title of the variable.

---

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

• NvTweakVar.h