Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::Source Class Reference

Options for Source. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions

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

Public Attributes

std::string nodeId
 [Optional] A node ID
 
uint8_t _internal_binary_nodeId [ENGAGE_MAX_NODE_ID_SIZE]
 
std::string alias
 [Optional] An alias
 
uint8_t _internal_binary_alias [ENGAGE_MAX_ALIAS_SIZE]
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Options for Source.

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

TODO: Complete this Class

Example:

See also
Group

Definition at line 4594 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Source()

AppConfigurationObjects::Source::Source ( )
inline

Definition at line 4612 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Source::clear ( )
inline

Definition at line 4617 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::Source::initForDocumenting ( )
inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 4626 of file ConfigurationObjects.h.

Member Data Documentation

◆ _internal_binary_alias

uint8_t AppConfigurationObjects::Source::_internal_binary_alias[ENGAGE_MAX_ALIAS_SIZE]

Definition at line 4610 of file ConfigurationObjects.h.

◆ _internal_binary_nodeId

uint8_t AppConfigurationObjects::Source::_internal_binary_nodeId[ENGAGE_MAX_NODE_ID_SIZE]

Definition at line 4604 of file ConfigurationObjects.h.

◆ alias

std::string AppConfigurationObjects::Source::alias

[Optional] An alias

Definition at line 4607 of file ConfigurationObjects.h.

◆ nodeId

std::string AppConfigurationObjects::Source::nodeId

[Optional] A node ID

Definition at line 4601 of file ConfigurationObjects.h.


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