SettingsManager.h

Go to the documentation of this file.

/*
 *
 *                             C@@o         ____  _____   __ _
 *                        oC8@@@@@@@o      |___ \|  __ \ / _| |
 *                    o@@@@@@@@@@@@O         __) | |  | | |_| | _____      __
 *         O@O        8@@@@@@@@@O           |__ <| |  | |  _| |/ _ \ \ /\ / /
 *       o@@@@@@@O    OOOOOCo               ___) | |__| | | | | (_) \ V  V /
 *       C@@@@@@@@@@@@Oo                   |____/|_____/|_| |_|\___/ \_/\_/
 *          o8@@@@@@@@@@@@@@@@8OOCCCC
 *              oO@@@@@@@@@@@@@@@@@@@o          3Dflow s.r.l. - www.3dflow.net
 *                   oO8@@@@@@@@@@@@o           Copyright 2022
 *       oO88@@@@@@@@8OCo                       All Rights Reserved
 *  O@@@@@@@@@@@@@@@@@@@@@@@@@8OCCoooooooCCo
 *   @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@O
 *    @@@Oo            oO8@@@@@@@@@@@@@@@@8
 *
 */
 
#ifndef FLOWENGINESETTINGSMANAGERINTERFACE_H
#define FLOWENGINESETTINGSMANAGERINTERFACE_H
 
#pragma once
 
#include "CommonDef.h"
 
namespace FlowEngine
{
    class SettingsManager final
    {
        public:
 
            static FLE_DLL Index getValidCategoriesCount( ConstStringBuffer phase );
 
            static FLE_DLL Size getValidCategorySize( ConstStringBuffer phase, Index categoryIndex );
 
            static FLE_DLL Result getValidCategory( ConstStringBuffer phase, Index categoryIndex, StringBuffer outCategory );
 
            static FLE_DLL Index getValidPresetsCount( ConstStringBuffer phase, ConstStringBuffer category );
 
            static FLE_DLL Size getValidPresetSize( ConstStringBuffer phase, ConstStringBuffer category, Index presetIndex );
 
            static FLE_DLL Result getValidPreset( ConstStringBuffer phase, ConstStringBuffer category, Index presetIndex, StringBuffer outPreset );
 
        public:
 
            static FLE_DLL Index getValidKeyCount();
 
            static FLE_DLL Size getValidKeySize( Index idx );
 
            static FLE_DLL Result getValidKey( Index idx, StringBuffer outKey );
 
            static FLE_DLL bool isValidKey( ConstStringBuffer key );
 
            static FLE_DLL Result getKeyMinMax( ConstStringBuffer key, double &outMin, double &outMax );
 
            static FLE_DLL Result getKeyDefaultValue( ConstStringBuffer key, StringBuffer outDefaultValue );
 
            static FLE_DLL Size getKeyDefaultValueLength( ConstStringBuffer key );
 
            static FLE_DLL Result getKeyMinMaxValue( ConstStringBuffer key, StringBuffer outMinValue, StringBuffer outMaxValue );
 
            static FLE_DLL void getKeyMinMaxValueLength( ConstStringBuffer key, Size &outMinLength, Size &outMaxLength );
 
        public:
 
            static FLE_DLL Size joinCategoryNameSize( ConstStringBuffer category, ConstStringBuffer name );
 
            static FLE_DLL Result joinCategoryName( ConstStringBuffer category, ConstStringBuffer name, StringBuffer outKey );
 
        public:
 
            static FLE_DLL Size splitKeyCategorySize( ConstStringBuffer key );
 
            static FLE_DLL Size splitKeyNameSize( ConstStringBuffer key );
 
            static FLE_DLL Result splitKey( ConstStringBuffer key, StringBuffer outCategory, StringBuffer outName );
    };
}
 
#endif