Engage Engine API  1.243.9083
Loading...
Searching...
No Matches
AppConfigurationObjects::ExternalModule Class Reference

Base for a description of an external module. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions

void clear ()
 
- Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void initForDocumenting ()
 
virtual std::string toString ()
 
virtual bool isDocumenting () const
 

Public Attributes

std::string name
 Name.
 
std::string file
 File spec.
 
nlohmann::json configuration
 Optional free-form JSON configuration to be passed to the module.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Base for a description of an external module.

Helper C++ class to serialize and de-serialize ExternalModuleBase JSON

Example:

See also
engageInitialize, EnginePolicy

Definition at line 6929 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ ExternalModule()

AppConfigurationObjects::ExternalModule::ExternalModule ( )
inline

Definition at line 6944 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::ExternalModule::clear ( )
inline

Definition at line 6949 of file ConfigurationObjects.h.

Member Data Documentation

◆ configuration

nlohmann::json AppConfigurationObjects::ExternalModule::configuration

Optional free-form JSON configuration to be passed to the module.

Definition at line 6942 of file ConfigurationObjects.h.

◆ file

std::string AppConfigurationObjects::ExternalModule::file

File spec.

Definition at line 6939 of file ConfigurationObjects.h.

◆ name

std::string AppConfigurationObjects::ExternalModule::name

Name.

Definition at line 6936 of file ConfigurationObjects.h.


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