cvedia::rt::iface::Solution ¶

Inherits from std::enable_shared_from_this< Solution >

Public Functions ¶

	Name
	Solution() =default
virtual	~Solution() =default
	Solution(std::string const & solutionPath)
	Solution(Solution const & ) =delete
Solution &	operator=(Solution const & ) =delete
virtual NODISCARD expected< void >	initialize() =0
virtual NODISCARD expected< void >	linkInstance(std::weak_ptr< iface::Instance > instance) =0
virtual NODISCARD expected< void >	unlinkInstance(std::weak_ptr< iface::Instance > instance) =0
virtual NODISCARD std::unordered_set< Uuid >	getLinkedInstances() =0
virtual void	clearLinkedInstances() =0
virtual NODISCARD std::string	getVersion() =0
virtual NODISCARD expected< void >	runOnInitCallback() =0
virtual NODISCARD expected< void >	runOnInstanceCreationCallback() =0
virtual NODISCARD expected< pCValue >	callSolutionFunction(std::string const & functionName, pCValue const & args =nullptr) =0
virtual std::string const &	getName() =0
virtual std::string const &	getFileName() =0
virtual std::string const &	getId() =0
virtual std::string	getSolutionPath() =0
virtual std::string	getScriptFilePath() =0
virtual std::string	getInstancePath() =0
virtual NODISCARD expected< void >	hasValidSolutionPath() =0
virtual NODISCARD expected< void >	hasValidBaseConfig() =0
virtual expected< pCValue >	getBaseConfig() const =0
virtual uCVDictRoot	config() =0
virtual uCVDictRoot	config(std::string const & ) =0
virtual uCVDictRoot	state() =0
virtual uCVDictRoot	state(std::string const & ) =0
virtual ObjectRegistry< iface::Module > &	modules() =0
virtual bool	addConfigWindow(std::string name, std::string type, std::string key, ui::configMenuHandler handler) =0
virtual bool	removeConfigWindow(std::string name) =0
virtual std::vector< configEntry >	getConfigWindows() =0
virtual NODISCARD expected< iface::configEntry >	getConfigWindow(std::string name) =0
virtual bool	registerExportConfigCallback(std::function< void(void)> onExportConfig) =0
virtual bool	unregisterExportConfigCallback() =0
virtual std::function< void(void)>	getExportConfigCallback() =0
virtual iface::UiCallback &	uiCallback() =0
virtual NODISCARD expected< cmap >	getPresetConfig(std::string const & presetName) =0

Public Functions Documentation ¶

function Solution ¶

Solution() =default

function ~Solution ¶

virtual ~Solution() =default

function Solution ¶

Solution(
    std::string const & solutionPath
)

function Solution ¶

Solution(
    Solution const & 
) =delete

function operator=¶

Solution & operator=(
    Solution const & 
) =delete

function initialize ¶

virtual NODISCARD expected< void > initialize() =0

function linkInstance ¶

virtual NODISCARD expected< void > linkInstance(
    std::weak_ptr< iface::Instance > instance
) =0

function unlinkInstance ¶

virtual NODISCARD expected< void > unlinkInstance(
    std::weak_ptr< iface::Instance > instance
) =0

function getLinkedInstances ¶

virtual NODISCARD std::unordered_set< Uuid > getLinkedInstances() =0

function clearLinkedInstances ¶

virtual void clearLinkedInstances() =0

function getVersion ¶

virtual NODISCARD std::string getVersion() =0

function runOnInitCallback ¶

virtual NODISCARD expected< void > runOnInitCallback() =0

function runOnInstanceCreationCallback ¶

virtual NODISCARD expected< void > runOnInstanceCreationCallback() =0

function callSolutionFunction ¶

virtual NODISCARD expected< pCValue > callSolutionFunction(
    std::string const & functionName,
    pCValue const & args =nullptr
) =0

function getName ¶

virtual std::string const & getName() =0

function getFileName ¶

virtual std::string const & getFileName() =0

function getId ¶

virtual std::string const & getId() =0

function getSolutionPath ¶

virtual std::string getSolutionPath() =0

function getScriptFilePath ¶

virtual std::string getScriptFilePath() =0

function getInstancePath ¶

virtual std::string getInstancePath() =0

function hasValidSolutionPath ¶

virtual NODISCARD expected< void > hasValidSolutionPath() =0

function hasValidBaseConfig ¶

virtual NODISCARD expected< void > hasValidBaseConfig() =0

function getBaseConfig ¶

virtual expected< pCValue > getBaseConfig() const =0

function config ¶

virtual uCVDictRoot config() =0

function config ¶

virtual uCVDictRoot config(
    std::string const & 
) =0

function state ¶

virtual uCVDictRoot state() =0

function state ¶

virtual uCVDictRoot state(
    std::string const & 
) =0

function modules ¶

virtual ObjectRegistry< iface::Module > & modules() =0

function addConfigWindow ¶

virtual bool addConfigWindow(
    std::string name,
    std::string type,
    std::string key,
    ui::configMenuHandler handler
) =0

function removeConfigWindow ¶

virtual bool removeConfigWindow(
    std::string name
) =0

function getConfigWindows ¶

virtual std::vector< configEntry > getConfigWindows() =0

function getConfigWindow ¶

virtual NODISCARD expected< iface::configEntry > getConfigWindow(
    std::string name
) =0

function registerExportConfigCallback ¶

virtual bool registerExportConfigCallback(
    std::function< void(void)> onExportConfig
) =0

function unregisterExportConfigCallback ¶

virtual bool unregisterExportConfigCallback() =0

function getExportConfigCallback ¶

virtual std::function< void(void)> getExportConfigCallback() =0

function uiCallback ¶

virtual iface::UiCallback & uiCallback() =0

function getPresetConfig ¶

virtual NODISCARD expected< cmap > getPresetConfig(
    std::string const & presetName
) =0