Rumba C++ SDK
maquina::DescBuild Class Reference

#include <NodeDelegateVirtualPlug.h>

Public Member Functions

 DescBuild (const maquina::Node &n)
 
void addPlug (const std::string &plug_name, const std::string &display_name)
 
void addPlugs (const maquina::Array &plugs, const std::string &parent_path)
 
void setRefreshPlug (const std::string &plug_name)
 
std::string closeDescription ()
 

Detailed Description

A helper class to assemble a node's description, containing an ordered & structured "plugs" list.

Usage:

class SomeNodeClassNodePlugin : public maquina::NodePlugin, public maquina::VirtualAttributesStore { std::shared_ptr<maquina::NodeDelegate> node_delegate() const { auto n = node(); if (VirtualAttributesStore::needsRebuild()) { maquina::DescBuild desc_build(n); _addAttribute("VirtualAttr1", "Group Name/My Virtual Attr", "default_val", [](const maquina::Plug& plug) { printf("created"); }, [](const maquina::Plug& plug) { printf("deleted"); }, "{\"nice_name":"My Virtual Attr"}", desc_build); // add other virtual attributes _setDescription(desc_build.closeDescription()); } } };

Constructor & Destructor Documentation

◆ DescBuild()

maquina::DescBuild::DescBuild ( const maquina::Node n)

Member Function Documentation

◆ addPlug()

void maquina::DescBuild::addPlug ( const std::string &  plug_name,
const std::string &  display_name 
)

◆ addPlugs()

void maquina::DescBuild::addPlugs ( const maquina::Array plugs,
const std::string &  parent_path 
)

◆ closeDescription()

std::string maquina::DescBuild::closeDescription ( )

◆ setRefreshPlug()

void maquina::DescBuild::setRefreshPlug ( const std::string &  plug_name)

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