Caffa  1.1.0
C++ Application Framework for Embedded Systems with introspection
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
caffa::AppInfo Struct Reference

Basic Application Information. More...

#include <cafApplication.h>

Public Types

enum  AppCapability : unsigned int { SERVER, CLIENT }
 Application capability Defines what type of application it is. These flags can be combined. I.e. a Console Server or GUI client.
 

Public Member Functions

bool hasCapability (AppCapability typeToCheck) const
 Check if the application has the specified capability. More...
 
std::string version_string () const
 Construct a full X.Y.Z version string with major, minor and patch version. More...
 

Static Public Member Functions

static nlohmann::json jsonSchema ()
 

Public Attributes

std::string name
 The name of the application.
 
int majorVersion
 Major version number.
 
int minorVersion
 Minor version number.
 
int patchVersion
 Patch version number.
 
unsigned int appType
 Application type. Can be CONSOLE, SERVER, CLIENT, GUI.
 
std::string description
 Application description.
 
std::string contactEmail
 Contact email.
 

Detailed Description

Basic Application Information.

Member Function Documentation

◆ hasCapability()

bool caffa::AppInfo::hasCapability ( AppCapability  typeToCheck) const
inline

Check if the application has the specified capability.

Parameters
typeToCheck
Returns
true
false

◆ version_string()

std::string caffa::AppInfo::version_string ( ) const
inline

Construct a full X.Y.Z version string with major, minor and patch version.

Returns
std::string

The documentation for this struct was generated from the following files: