NAP
Public Member Functions | List of all members
ParameterEnumBase Class Referenceabstract

#include <parameterenum.h>

Public Member Functions

 ParameterEnumBase (rtti::TypeInfo enumType)
 
virtual int getValue () const =0
 
virtual void setValue (int value)=0
 
const rtti::TypeInfogetEnumType () const
 
- Public Member Functions inherited from Parameter
virtual void setValue (const Parameter &value)=0
 
const std::string getDisplayName () const
 
- Public Member Functions inherited from Resource
 Resource ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual bool init (utility::ErrorState &errorState)
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 
- Public Attributes inherited from Parameter
std::string mName
 Property 'Name': The name of this property. The name is separate from the ID and doesn't have to be unique. More...
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 

Description

Base class for enum parameters. This base is used to offer generic support for editing enums, without having to be aware of the specific enum types

Inheritance diagram for ParameterEnumBase:
[legend]
Collaboration diagram for ParameterEnumBase:
[legend]

Constructor & Destructor Documentation

◆ ParameterEnumBase()

Member Function Documentation

◆ getEnumType()

const rtti::TypeInfo& getEnumType ( ) const

Get the RTTI type of the enum represented by this parameter

◆ getValue()

virtual int getValue ( ) const
pure virtual

Get the current value of this parameter as an int

Returns
Current value of this parameter as an int

Implemented in ParameterEnum< T >.

◆ setValue()

virtual void setValue ( int  value)
pure virtual

Set the value of this enum from an int

Parameters
valueThe value to set

Implemented in ParameterEnum< T >.