tim::component::craypat_flush_buffer Struct Reference

Writes all the recorded contents in the data buffer. Returns the number of bytes flushed. More...

#include "timemory/components/craypat/components.hpp"

Collaboration diagram for tim::component::craypat_flush_buffer:

Public Types
using	value_type = unsigned long
using	this_type = craypat_flush_buffer
using	base_type = base< this_type, value_type >
using	storage_type = empty_storage

Public Member Functions
double	get () const
auto	get_display () const
void	start ()
void	stop ()

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

Writes all the recorded contents in the data buffer. Returns the number of bytes flushed.

Definition at line 282 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::craypat_flush_buffer::base_type = base<this_type, value_type>

Definition at line 286 of file components.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

this_type

using tim::component::craypat_flush_buffer::this_type = craypat_flush_buffer

Definition at line 285 of file components.hpp.

value_type

using tim::component::craypat_flush_buffer::value_type = unsigned long

Definition at line 284 of file components.hpp.

Member Function Documentation

description()

static std::string tim::component::craypat_flush_buffer::description ( )

inlinestatic

Definition at line 289 of file components.hpp.

    {
        return "Writes all the recorded contents in the data buffer. Returns the number "
               "of bytes flushed";
    }

get()

double tim::component::craypat_flush_buffer::get ( ) const

inline

Definition at line 302 of file components.hpp.

{ return m_nbytes; }

Referenced by get_display().

get_display()

auto tim::component::craypat_flush_buffer::get_display ( ) const

inline

Definition at line 303 of file components.hpp.

{ return get(); }

References get().

get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args &&  ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

label()

static std::string tim::component::craypat_flush_buffer::label ( )

inlinestatic

Definition at line 288 of file components.hpp.

{ return "craypat_flush_buffer"; }

record()

static value_type tim::component::craypat_flush_buffer::record ( )

inlinestatic

Definition at line 295 of file components.hpp.

    {
        unsigned long _nbytes;
        backend::craypat::flush_buffer(&_nbytes);
        return _nbytes;
    }

Referenced by stop().

start()

void tim::component::craypat_flush_buffer::start ( )

inline

Definition at line 304 of file components.hpp.

{}

stop()

void tim::component::craypat_flush_buffer::stop ( )

inline

Definition at line 305 of file components.hpp.

    {
        value = record();
        accum += record();
    }

References record().

---

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

• timemory/components/craypat/components.hpp