nx_metadata_sdk  1.0
Metadata SDK
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
nx::sdk::ISettingsResponse Class Referenceabstract

#include <i_settings_response.h>

Inheritance diagram for nx::sdk::ISettingsResponse:
nx::sdk::Interface< ISettingsResponse, ISettingsResponse0 > nx::sdk::ISettingsResponse0 nx::sdk::Interface< ISettingsResponse0 > nx::sdk::IRefCountable nx::sdk::RefCountable< ISettingsResponse > nx::sdk::SettingsResponse

Public Member Functions

Ptr< IStringmodel () const
 
- Public Member Functions inherited from nx::sdk::Interface< ISettingsResponse, ISettingsResponse0 >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< InterfacequeryInterface ()
 
Ptr< const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::ISettingsResponse0
Ptr< IStringMapvalues () const
 
Ptr< IStringMaperrors () const
 
- Public Member Functions inherited from nx::sdk::Interface< ISettingsResponse0 >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< InterfacequeryInterface ()
 
Ptr< const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class Interface >
Ptr< InterfacequeryInterface ()
 
template<class Interface >
Ptr< const InterfacequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 
int refCountThreadUnsafe () const
 

Static Public Member Functions

static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::ISettingsResponse0
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Protected Member Functions

virtual IStringgetModel () const =0
 
- Protected Member Functions inherited from nx::sdk::Interface< ISettingsResponse, ISettingsResponse0 >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Protected Member Functions inherited from nx::sdk::ISettingsResponse0
virtual IStringMapgetValues () const =0
 
virtual IStringMapgetErrors () const =0
 
- Protected Member Functions inherited from nx::sdk::Interface< ISettingsResponse0 >
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 

Additional Inherited Members

- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 

Detailed Description

The data to be returned from the plugin describing the desired settings.

A combination of optional individual setting errors, optional new setting values in case they were adjusted, and an optional new Settings Model.

Member Function Documentation

◆ getModel()

virtual IString* nx::sdk::ISettingsResponse::getModel ( ) const
protectedpure virtual

Called by model()

Implemented in nx::sdk::SettingsResponse.

◆ model()

Ptr<IString> nx::sdk::ISettingsResponse::model ( ) const
inline
Returns
New Settings Model, overriding the one from the parent object's Manifest, in case the Model has been changed e.g. because its parts depend on some setting values. Can be null if the Model has not been changed.

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