named_timer.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Rene Schmieding
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MIO_TIMER_NAMED_TIMER_H
#define MIO_TIMER_NAMED_TIMER_H
 
#include "memilio/utils/mioomp.h"
#include "memilio/timer/basic_timer.h"
#include "memilio/timer/timer_registrar.h"
#include "memilio/utils/string_literal.h"
 
#include <string>
 
namespace mio
{
namespace timing
{
 
template <StringLiteral Name, StringLiteral Scope = "">
class NamedTimer : public BasicTimer
{
public:
    NamedTimer(NamedTimer&)  = delete;
    NamedTimer(NamedTimer&&) = delete;
 
    static std::string name()
    {
        return std::string(Name);
    }
 
    static std::string scope()
    {
        return std::string(Scope);
    }
 
    static NamedTimer& get_instance()
    {
        // create and return a timer
        // the constructor is only called the first time this function is used (for each thread)
        thread_local static NamedTimer t;
        return t;
    }
 
private:
    NamedTimer()
    {
        TimerRegistrar::get_instance().add_timer({name(), scope(), *this, mio::omp::get_thread_id(), 0});
    }
};
 
} // namespace timing
} // namespace mio
 
#endif // MIO_TIMER_NAMED_TIMER_H