ML Reference
ml::ApplicationProperties Class Reference

Static class that defines an interface to access properties of the host application. More...

#include <mlApplicationProperties.h>

Static Public Member Functions

static std::string getString (const char *propertyName, const std::string &defaultValue=std::string())
 Get string property, returns given defaultValue if property is unknown (or if propertyName is NULL).
 
static MLint32 getInt (const char *propertyName, MLint32 defaultValue=0)
 Get int property, returns given defaultValue if property is unknown (or if propertyName is NULL).
 
static bool getBool (const char *propertyName, bool defaultValue=false)
 Get bool property, returns given defaultValue if property is unknown (or if propertyName is NULL).
 
static double getDouble (const char *propertyName, double defaultValue=0)
 Get double property, returns given defaultValue if property is unknown (or if propertyName is NULL).
 
static bool hasProperty (const char *propertyName)
 Returns true if the property exists, false otherwise (or if propertyName is NULL).
 

Detailed Description

Static class that defines an interface to access properties of the host application.

Thread-safety: This class is not thread-safe.

Definition at line 26 of file mlApplicationProperties.h.

Member Function Documentation

◆ getBool()

static bool ml::ApplicationProperties::getBool ( const char * propertyName,
bool defaultValue = false )
static

Get bool property, returns given defaultValue if property is unknown (or if propertyName is NULL).

◆ getDouble()

static double ml::ApplicationProperties::getDouble ( const char * propertyName,
double defaultValue = 0 )
static

Get double property, returns given defaultValue if property is unknown (or if propertyName is NULL).

◆ getInt()

static MLint32 ml::ApplicationProperties::getInt ( const char * propertyName,
MLint32 defaultValue = 0 )
static

Get int property, returns given defaultValue if property is unknown (or if propertyName is NULL).

◆ getString()

static std::string ml::ApplicationProperties::getString ( const char * propertyName,
const std::string & defaultValue = std::string() )
static

Get string property, returns given defaultValue if property is unknown (or if propertyName is NULL).

◆ hasProperty()

static bool ml::ApplicationProperties::hasProperty ( const char * propertyName)
static

Returns true if the property exists, false otherwise (or if propertyName is NULL).


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