PortalItemSimple< T > Class Template Reference

#include </opt/build/repo/nap/system_modules/napportal/src/portalitemsimple.h>

Public Member Functions
virtual bool	init (utility::ErrorState &error) override
virtual void	onDestroy () override
virtual bool	processUpdate (const APIEvent &event, utility::ErrorState &error) override
virtual APIEventPtr	getDescriptor () const override
virtual APIEventPtr	getValue () const override
virtual void	onParameterUpdate (T value)
Public Member Functions inherited from Resource
	Resource ()
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
Slot< T >	mParameterUpdateSlot = { this, &PortalItemSimple::onParameterUpdate }
ResourcePtr< ParameterSimple< T > >	mParameter
	Property: 'Parameter' the parameter linked to this portal item. More...
Public Attributes inherited from PortalItem
Signal< const PortalItem & >	updateSignal
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)

Description

template<typename T>
class nap::PortalItemSimple< T >

Represents any simple item in a NAP portal.

Inheritance diagram for PortalItemSimple< T >:

Collaboration diagram for PortalItemSimple< T >:

Member Function Documentation

getDescriptor()

APIEventPtr getDescriptor

overridevirtual

Returns

the descriptor of the portal item as an API event

Implements PortalItem.

getValue()

APIEventPtr getValue

overridevirtual

Returns

the current value of the portal item as an API event

Implements PortalItem.

init()

bool init ( utility::ErrorState &  error )

overridevirtual

Subscribes to the parameter changed signal

Parameters

error

contains the error message when initialization fails

Returns

if initialization succeeded.

Reimplemented from Object.

onDestroy()

void onDestroy

overridevirtual

Unsubscribes from the parameter changed signal

Reimplemented from Object.

onParameterUpdate()

void onParameterUpdate ( T  value )

virtual

Called when the parameter value changes, sends the update as an API event

Parameters

value

the updated value of the parameter

processUpdate()

bool processUpdate ( const APIEvent &  event, utility::ErrorState &  error  )

overridevirtual

Processes an update type API event.

Parameters

event	The event to be processed
error	contains information when processing fails

Returns

if the event was processed successfully

Implements PortalItem.

Member Data Documentation

mParameter

ResourcePtr<ParameterSimple<T> > mParameter

Property: 'Parameter' the parameter linked to this portal item.

mParameterUpdateSlot

Slot<T> mParameterUpdateSlot = { this, &PortalItemSimple::onParameterUpdate }

Slot which is called when the parameter value changes