tcspc::processor_info Class Reference

Description

Value type representing metadata of a processor.

Each processor (or source, sink) implements a member function auto introspect_node() const -> processor_info that returns an object of this type. The same result can also be obtained from tcspc::processor_graph::node_info().

Public Member Functions
template<typename Processor>
	processor_info (Processor const *processor, std::string name)
	Construct with pointer to processor and name.
auto	address () const -> std::uintptr_t
	Return the address of the processor.
auto	name () const -> std::string
	Return the simple name of the processor.
auto	type_name () const -> std::string
	Return the C++ type name of the processor.

Friends
auto	operator== (processor_info const &lhs, processor_info const &rhs) -> bool=default
	Equality comparison operator.

Constructor & Destructor Documentation

processor_info()

template<typename Processor>

tcspc::processor_info::processor_info ( Processor const * processor, std::string name )

inlineexplicit

Construct with pointer to processor and name.

Template Parameters

Processor

the processor type (usually deduced)

Parameters

processor	pointer to the processor
name	name of the processor (by convention, usually the unqualified name of the class or class template, without a template argument list)

Member Function Documentation

address()

auto tcspc::processor_info::address ( ) const -> std::uintptr_t

inlinenodiscard

Return the address of the processor.

This is for debugging or disambiguating purposes, not intended to be used as a pointer.

Returns

address of processor

name()

auto tcspc::processor_info::name ( ) const -> std::string

inlinenodiscard

Return the simple name of the processor.

Returns

name of processor

type_name()

auto tcspc::processor_info::type_name ( ) const -> std::string

inlinenodiscard

Return the C++ type name of the processor.

Where possible, the demangled C++ type name is returned; otherwise the returned name is whatever the platform's std::type_info::name() returns.

Processor type names can be quite long when they have more than a few downstream processors.

Returns

name of processor class

---

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

• libtcspc/introspect.hpp