xentara-plugin v2.0.4
The Xentara Plugin Framework
Loading...
Searching...
No Matches
xentara::io::Driver::Environment Class Referenceabstract

The actual skill (formerly called “driver environment”) More...

#include <xentara/io/Driver.hpp>

+ Inheritance diagram for xentara::io::Driver::Environment:

Public Member Functions

virtual auto createComponent (const ComponentClass &elementClass, plugin::SharedFactory< Component > &factory) -> std::shared_ptr< Component >=0
 Called by the framework to create a new top-level element.
 
virtual auto createIoBatch (const IoBatchClass &elementClass, plugin::SharedFactory< IoBatch > &factory) -> std::shared_ptr< IoBatch >
 Called by the framework to create a new top-level element.
 
Virtual Overrides for skill::Skill


auto createElement (const skill::Element::Class &elementClass, skill::ElementFactory &factory) -> std::shared_ptr< skill::Element > final
 Virtual overide for skill::Skill::createElement()
 
- Public Member Functions inherited from xentara::skill::Skill
virtual ~Skill ()=0
 Virtual destructor.
 
virtual auto loadConfig (utils::json::decoder::Object &jsonObject, config::Context &context) -> void
 Called by the framework to load the skill’s configuration from a JSON object.
 
- Public Member Functions inherited from xentara::utils::tools::DisableCopy
constexpr DisableCopy () noexcept=default
 
 DisableCopy (const DisableCopy &)=delete
 
DisableCopyoperator= (const DisableCopy &)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from xentara::skill::Skill
static auto persistentDataPath (const std::filesystem::path &skillSubdirectory, const std::filesystem::path &subPath) -> std::filesystem::path
 Makes a path suitable for storing persistent data for a skill.
 

Detailed Description

The actual skill (formerly called “driver environment”)

Member Function Documentation

◆ createComponent()

virtual auto xentara::io::Driver::Environment::createComponent ( const ComponentClass elementClass,
plugin::SharedFactory< Component > &  factory 
) -> std::shared_ptr< Component >
pure virtual

Called by the framework to create a new top-level element.

◆ createElement()

auto xentara::io::Driver::Environment::createElement ( const skill::Element::Class elementClass,
skill::ElementFactory factory 
) -> std::shared_ptr< skill::Element >
finalvirtual

Virtual overide for skill::Skill::createElement()

This function calls createComponent() or createIoBatch() if elementClass is derived from ComponentClass or IoBatchClass respectively, or returns nullptr otherwise.

Implements xentara::skill::Skill.

◆ createIoBatch()

virtual auto xentara::io::Driver::Environment::createIoBatch ( const IoBatchClass elementClass,
plugin::SharedFactory< IoBatch > &  factory 
) -> std::shared_ptr< IoBatch >
virtual

Called by the framework to create a new top-level element.