Switchboard Extension SDK
Toggle main menu visibility
Loading...
Searching...
No Matches
Extension.hpp
1
//
2
// Extension.hpp
3
// SwitchboardSDK
4
//
5
// Created by Balazs Kiss on 30/08/2024.
6
//
7
8
#pragma once
9
10
#include <switchboard/export.h>
11
#include <switchboard_core/NodeFactory.hpp>
12
#include <switchboard_core/SwitchboardObject.hpp>
13
14
#include <string>
15
16
namespace
switchboard {
17
21
class
SWITCHBOARDSDK_EXPORT
Extension
:
public
SwitchboardObject
{
22
public
:
23
29
static
SBAnyMap
getObjectTypeInfo
() {
30
return
{};
31
}
32
37
Extension
() :
SwitchboardObject
(
SwitchboardObjectType
::EXTENSION) {}
38
42
virtual
~Extension
() =
default
;
43
51
virtual
Result<void>
initialize
(
const
SBAnyMap& config) {
52
return
makeSuccess();
53
}
54
60
virtual
Result<void>
deinitialize
() {
61
return
makeSuccess();
62
}
63
69
virtual
std::string
getName
() = 0;
70
76
virtual
std::string
getDescription
() = 0;
77
84
virtual
std::shared_ptr<NodeFactory>
getNodeFactory
() = 0;
85
};
86
87
}
switchboard::Extension::getObjectTypeInfo
static SBAnyMap getObjectTypeInfo()
Static type-info fragment for the abstract Extension base. Empty by design — Extension itself contrib...
Definition
Extension.hpp:29
switchboard::Extension::getNodeFactory
virtual std::shared_ptr< NodeFactory > getNodeFactory()=0
Gets the NodeFactory object of the extension.
switchboard::Extension::getName
virtual std::string getName()=0
Gets the name of the extension.
switchboard::Extension::~Extension
virtual ~Extension()=default
Destructor.
switchboard::Extension::initialize
virtual Result< void > initialize(const SBAnyMap &config)
Initializes the extension.
Definition
Extension.hpp:51
switchboard::Extension::Extension
Extension()
Constructor for the Extension class.
Definition
Extension.hpp:37
switchboard::Extension::deinitialize
virtual Result< void > deinitialize()
Deinitializes the extension.
Definition
Extension.hpp:60
switchboard::Extension::getDescription
virtual std::string getDescription()=0
Gets a human-readable description of the extension.
switchboard::SwitchboardObject::SwitchboardObject
SwitchboardObject(const std::string &objectType)
SwitchboardObject constructor.
switchboard::SwitchboardObjectType
Identifiers for the kind of Switchboard object.
Definition
ObjectTypeInfo.hpp:14
SwitchboardSDK
include
switchboard_core
Extension.hpp
Generated by
1.17.0