Fletchgen
The Fletcher Design Generator
Public Member Functions | Static Public Member Functions | List of all members
fletchgen::FletcherSchema Class Reference

#include <schema.h>

Public Member Functions

 FletcherSchema (const std::shared_ptr< arrow::Schema > &arrow_schema, const std::string &schema_name="")
 Construct a new Fletcher schema.
 
std::shared_ptr< arrow::Schema > arrow_schema () const
 Return the Arrow schema that this FletcherSchema was based on.
 
Mode mode () const
 Return the access mode of the RecordBatch this schema represents.
 
std::string name () const
 Return the name of this FletcherSchema.
 

Static Public Member Functions

static std::shared_ptr< FletcherSchemaMake (const std::shared_ptr< arrow::Schema > &arrow_schema, const std::string &schema_name="")
 Make a new FletcherSchema, returning a shared pointer to it. More...
 

Detailed Description

An Arrow schema augmented with Fletcher specific data and functions.

Definition at line 35 of file schema.h.

Member Function Documentation

◆ Make()

std::shared_ptr< FletcherSchema > fletchgen::FletcherSchema::Make ( const std::shared_ptr< arrow::Schema > &  arrow_schema,
const std::string &  schema_name = "" 
)
static

Make a new FletcherSchema, returning a shared pointer to it.

Parameters
arrow_schemaThe Arrow schema to derive this FletcherSchema from.
schema_nameThe name of the FletcherSchema.
Returns
A shared pointer to a new FletcherSchema.

Definition at line 156 of file schema.cc.


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