Awkward Array: Field< ENUM, BUILDER > Class Template Reference

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
Field< ENUM, BUILDER > Class Template Reference

Helper class for sending a pair of field names (as enum) and field type as template parameters in `Record`. More...

`#include <LayoutBuilder.h>`

## Public Types
using | Builder = BUILDER

## Public Member Functions
std::string | index_as_field () const
| Converts index as field string.

## Public Attributes
const std::size_t | index = ENUM
| The index of a Record field.
Builder | builder
| The content type of field in a Record.

## Detailed Description

template<std::size_t ENUM, typename BUILDER>
class awkward::LayoutBuilder::Field< ENUM, BUILDER >

Helper class for sending a pair of field names (as enum) and field type as template parameters in `Record`.

Template Parameters

  ENUM | Enumerated type which assigns index values to field names.
  BUILDER | The type of field.

## Member Typedef Documentation

## ◆ Builder

using Builder = BUILDER

## Member Function Documentation

## ◆ index_as_field()

std::string index_as_field | ( |  | ) | const
| inline

Converts index as field string.

## Member Data Documentation

## ◆ builder

Builder builder

The content type of field in a Record.

## ◆ index

const std::size_t index = ENUM

The index of a Record field.

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

- src/awkward/_v2/cpp-headers/awkward/LayoutBuilder.h