cvedia::rt::iface::InstanceController¶
Inherits from std::enable_shared_from_this< InstanceController >
Public Functions¶
| Name | |
|---|---|
| virtual | ~InstanceController() =default |
| virtual expected< std::shared_ptr< iface::Instance > > | loadInstance() =0 |
| virtual expected< void > | loadInstanceAsync() =0 |
| virtual expected< void > | unloadInstance() =0 |
| virtual bool | isInstanceLoaded() =0 |
| virtual bool | isInstanceRunning() =0 |
| virtual bool | isInstancePaused() =0 |
| virtual expected< void > | startInstance() =0 |
| virtual expected< void > | stopInstance(bool allowRestart) =0 |
| virtual expected< void > | stopInstanceIfCurrent(std::weak_ptr< Instance > const & expectedInstance, bool allowRestart) =0 |
| virtual expected< void > | restartInstance() =0 |
| virtual NODISCARD expected< void > | reloadConfigFromDisk() =0 |
| virtual uCVDictRoot | config() =0 |
| virtual NODISCARD expected< void > | setConfig(pCValue && config) =0 |
| virtual NODISCARD expected< pCValue > | getConfigChanges() const =0 |
| virtual expected< pCValue > | getConfig() =0 |
| virtual NODISCARD expected< void > | initializeFromExternalFile(std::string const & configFile) =0 |
| virtual NODISCARD expected< void > | initializeFromFile(std::string const & configFile) =0 |
| virtual NODISCARD expected< void > | initializeFromMemory(pCValue config) =0 |
| virtual Uuid const & | getInstanceId() =0 |
| virtual expected< void > | setInstanceUuid(Uuid const & id) =0 |
| virtual std::string | getDisplayName() const =0 |
| virtual std::string const & | getGroupName() =0 |
| virtual cmap | getOriginatorInfo() const =0 |
| virtual std::string const & | getConfigFile() =0 |
| virtual expected< void > | setDisplayName(std::string const & name) =0 |
| virtual expected< void > | setGroupName(std::string const & name) =0 |
| virtual expected< void > | setOriginatorInfo(cmap const & info) =0 |
| virtual expected< std::weak_ptr< iface::Solution > > | getSolution() =0 |
| virtual expected< std::weak_ptr< Instance > > | getInstance() =0 |
| virtual bool | getAutoStart() const =0 |
| virtual bool | getAutoRestart() const =0 |
| virtual NODISCARD expected< void > | setAutoStart(bool autoStart) =0 |
| virtual NODISCARD expected< void > | setAutoRestart(bool autoRestart) =0 |
| virtual bool | getReadOnly() const =0 |
| virtual NODISCARD expected< void > | setReadOnly(bool readOnly) =0 |
| virtual bool | isSystemInstance() const =0 |
| virtual void | setSystemInstance(bool systemInstance) =0 |
| virtual expected< void > | setSolution(std::weak_ptr< iface::Solution > const & solution) =0 |
| virtual bool | isPersistent() const =0 |
| virtual expected< void > | setPersistent(bool persistent) =0 |
| virtual expected< void > | enableSolutionManager(bool fallbackToDefault =true) =0 |
| virtual expected< std::shared_ptr< iface::SolutionManager > > | getSolutionManager() const =0 |
| virtual expected< std::shared_ptr< iface::SolutionManager > > | getSolutionManagerOrCreate(bool fallbackToDefault =true) =0 |
| virtual NODISCARD expected< void > | save() =0 |
| virtual void | touchActivity() =0 |
| virtual bool | isIdleExpired() const =0 |
| virtual void | setIdleTimeoutSeconds(int seconds) =0 |
Public Functions Documentation¶
function ~InstanceController¶
virtual ~InstanceController() =default
function loadInstance¶
virtual expected< std::shared_ptr< iface::Instance > > loadInstance() =0
function loadInstanceAsync¶
virtual expected< void > loadInstanceAsync() =0
Launch an asynchronous load while retaining shared ownership of this controller. Returns RTErrc::OperationFailed when the controller is owned uniquely (for example, when created with Factory::createUnique()).
function unloadInstance¶
virtual expected< void > unloadInstance() =0
function isInstanceLoaded¶
virtual bool isInstanceLoaded() =0
function isInstanceRunning¶
virtual bool isInstanceRunning() =0
function isInstancePaused¶
virtual bool isInstancePaused() =0
function startInstance¶
virtual expected< void > startInstance() =0
function stopInstance¶
virtual expected< void > stopInstance(
bool allowRestart
) =0
function stopInstanceIfCurrent¶
virtual expected< void > stopInstanceIfCurrent(
std::weak_ptr< Instance > const & expectedInstance,
bool allowRestart
) =0
function restartInstance¶
virtual expected< void > restartInstance() =0
function reloadConfigFromDisk¶
virtual NODISCARD expected< void > reloadConfigFromDisk() =0
function config¶
virtual uCVDictRoot config() =0
function setConfig¶
virtual NODISCARD expected< void > setConfig(
pCValue && config
) =0
function getConfigChanges¶
virtual NODISCARD expected< pCValue > getConfigChanges() const =0
function getConfig¶
virtual expected< pCValue > getConfig() =0
function initializeFromExternalFile¶
virtual NODISCARD expected< void > initializeFromExternalFile(
std::string const & configFile
) =0
function initializeFromFile¶
virtual NODISCARD expected< void > initializeFromFile(
std::string const & configFile
) =0
function initializeFromMemory¶
virtual NODISCARD expected< void > initializeFromMemory(
pCValue config
) =0
function getInstanceId¶
virtual Uuid const & getInstanceId() =0
function setInstanceUuid¶
virtual expected< void > setInstanceUuid(
Uuid const & id
) =0
function getDisplayName¶
virtual std::string getDisplayName() const =0
function getGroupName¶
virtual std::string const & getGroupName() =0
function getOriginatorInfo¶
virtual cmap getOriginatorInfo() const =0
function getConfigFile¶
virtual std::string const & getConfigFile() =0
function setDisplayName¶
virtual expected< void > setDisplayName(
std::string const & name
) =0
function setGroupName¶
virtual expected< void > setGroupName(
std::string const & name
) =0
function setOriginatorInfo¶
virtual expected< void > setOriginatorInfo(
cmap const & info
) =0
function getSolution¶
virtual expected< std::weak_ptr< iface::Solution > > getSolution() =0
function getInstance¶
virtual expected< std::weak_ptr< Instance > > getInstance() =0
function getAutoStart¶
virtual bool getAutoStart() const =0
function getAutoRestart¶
virtual bool getAutoRestart() const =0
function setAutoStart¶
virtual NODISCARD expected< void > setAutoStart(
bool autoStart
) =0
function setAutoRestart¶
virtual NODISCARD expected< void > setAutoRestart(
bool autoRestart
) =0
function getReadOnly¶
virtual bool getReadOnly() const =0
function setReadOnly¶
virtual NODISCARD expected< void > setReadOnly(
bool readOnly
) =0
function isSystemInstance¶
virtual bool isSystemInstance() const =0
function setSystemInstance¶
virtual void setSystemInstance(
bool systemInstance
) =0
function setSolution¶
virtual expected< void > setSolution(
std::weak_ptr< iface::Solution > const & solution
) =0
function isPersistent¶
virtual bool isPersistent() const =0
function setPersistent¶
virtual expected< void > setPersistent(
bool persistent
) =0
function enableSolutionManager¶
virtual expected< void > enableSolutionManager(
bool fallbackToDefault =true
) =0
function getSolutionManager¶
virtual expected< std::shared_ptr< iface::SolutionManager > > getSolutionManager() const =0
function getSolutionManagerOrCreate¶
virtual expected< std::shared_ptr< iface::SolutionManager > > getSolutionManagerOrCreate(
bool fallbackToDefault =true
) =0
function save¶
virtual NODISCARD expected< void > save() =0
function touchActivity¶
virtual void touchActivity() =0
function isIdleExpired¶
virtual bool isIdleExpired() const =0
function setIdleTimeoutSeconds¶
virtual void setIdleTimeoutSeconds(
int seconds
) =0