memory.h

/*
** Copyright 2007-2024, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#ifndef __ANTARES_LIBS_MEMORY_MEMORY_H__
#define __ANTARES_LIBS_MEMORY_MEMORY_H__
 
#include <yuni/yuni.h>
#include <yuni/core/bit/array.h>
#include <yuni/core/string.h>
 
namespace Antares
{
class Memory final: public Yuni::Policy::ObjectLevelLockable<Memory>
{
public:
    template<class T>
    struct Stored final
    {
        using Type = T*;
        using ReturnType = T*;
        using ConstReturnType = const T*;
 
        static const T* NullValue()
        {
            return nullptr;
        }
    };
 
    template<class U>
    static U* RawPointer(U* array);
 
    template<class U>
    static void Zero(uint count, U* array);
 
    template<class U>
    static void Assign(uint count, U* array, const U& value);
 
    template<class T>
    static void Allocate(T*& out, size_t size);
 
    template<class T>
    static bool Null(const T* out);
 
    template<class T>
    static bool StrictNull(const T* out);
 
    template<class T>
    static void Release(T*& pointer);
 
 
 
    Memory() = default;
    ~Memory() = default;
 
    bool initializeTemporaryFolder();
 
 
    const Yuni::String& cacheFolder() const;
    void cacheFolder(const AnyString& folder);
 
    uint64_t processID() const;
 
 
 
 
    void displayInfo() const;
 
private:
    Yuni::String pCacheFolder;
    bool pAllowedToChangeCacheFolder;
 
    uint64_t pProcessID;
 
    bool pAlreadyInitialized = false;
 
    // Friend
    template<class T>
    friend class Array;
 
}; // class Memory
 
extern Memory memory;
 
} // namespace Antares
 
#include "memory.hxx"
 
#endif // __ANTARES_LIBS_MEMORY_MEMORY_H__