nx_metadata_sdk  1.0
Metadata SDK
Public Member Functions | Protected Member Functions | List of all members
nx::sdk::SettingsResponse Class Reference
Inheritance diagram for nx::sdk::SettingsResponse:
nx::sdk::RefCountable< ISettingsResponse > nx::sdk::ISettingsResponse nx::sdk::Interface< ISettingsResponse > nx::sdk::IRefCountable

Public Member Functions

 SettingsResponse (Ptr< StringMap > values, Ptr< StringMap > errors=nullptr)
 
void setValue (std::string key, std::string value)
 
void setError (std::string key, std::string value)
 
void setValues (Ptr< StringMap > values)
 
void setErrors (Ptr< StringMap > errors)
 
- Public Member Functions inherited from nx::sdk::RefCountable< ISettingsResponse >
 RefCountable (const RefCountable &)=delete
 
 RefCountable (RefCountable &&)=delete
 
RefCountableoperator= (const RefCountable &)=delete
 
RefCountableoperator= (RefCountable &&)=delete
 
virtual int addRef () const override
 
virtual int releaseRef () const override
 
int refCount () const
 
- Public Member Functions inherited from nx::sdk::ISettingsResponse
Ptr< IStringMapvalues () const
 
Ptr< IStringMaperrors () const
 
- Public Member Functions inherited from nx::sdk::Interface< ISettingsResponse >
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
 
int refCountThreadUnsafe () const
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from nx::sdk::ISettingsResponse
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 
- 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])
 

Member Function Documentation

◆ getErrors()

IStringMap * nx::sdk::SettingsResponse::getErrors ( ) const
overrideprotectedvirtual
Returns
Map of errors that happened while obtaining setting values, indexed by setting ids. Each value must be a human-readable error message in English.

Implements nx::sdk::ISettingsResponse.

◆ getValues()

IStringMap * nx::sdk::SettingsResponse::getValues ( ) const
overrideprotectedvirtual
Returns
Map of setting values, indexed by setting ids.

Implements nx::sdk::ISettingsResponse.


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