Loading...
Searching...
No Matches
FormBuilder< T, I > Class Template Referenceabstract

Abstract base class for nodes within a LayoutBuilder Every builder will have an output buffer based on the key_format="part{partition}-{form_key}-{attribute}". More...

#include <FormBuilder.h>

Inheritance diagram for FormBuilder< T, I >:
BitMaskedArrayBuilder< T, I > ByteMaskedArrayBuilder< T, I > EmptyArrayBuilder< T, I > IndexedArrayBuilder< T, I > IndexedOptionArrayBuilder< T, I > ListArrayBuilder< T, I > ListOffsetArrayBuilder< T, I > NumpyArrayBuilder< T, I > RecordArrayBuilder< T, I > RegularArrayBuilder< T, I > UnionArrayBuilder< T, I > UnmaskedArrayBuilder< T, I >

Public Member Functions

virtual ~FormBuilder ()
 Virtual destructor acts as a first non-inline virtual function that determines a specific translation unit in which vtable shall be emitted. More...
 
virtual const std::string classname () const =0
 User-friendly name of this class. More...
 
virtual const std::string to_buffers (BuffersContainer &container, const ForthOutputBufferMap &outputs) const =0
 Copy the current snapshot into the BuffersContainer and return a Form as a std::string (JSON). More...
 
virtual ssize_t len (const ForthOutputBufferMap &outputs) const =0
 The builder's output buffer length. More...
 
virtual bool is_complex () const
 
virtual const std::string vm_output () const =0
 AwkwardForth virtual machine instructions of the data outputs. More...
 
virtual const std::string vm_output_data () const =0
 AwkwardForth virtual machine data output key. More...
 
virtual const std::string vm_func () const =0
 AwkwardForth virtual machine instructions of the array builder function. More...
 
virtual const std::string vm_func_name () const =0
 The array builder VM function name. More...
 
virtual const std::string vm_func_type () const =0
 The array builder VM function type. More...
 
virtual const std::string vm_from_stack () const =0
 AwkwardForth virtual machine instructions to retrieve the data from the VM stack. More...
 
virtual const std::string vm_error () const =0
 Error messages in the AwkwardForth virtual machine instructions. More...
 
virtual void tag (int8_t x)
 Adds an integer value x to the accumulated data. More...
 
virtual void boolean (bool x, LayoutBuilderPtr< T, I > builder)
 Adds a boolean value x to the accumulated data. More...
 
virtual void int64 (int64_t x, LayoutBuilderPtr< T, I > builder)
 Adds an integer value x to the accumulated data. More...
 
virtual void float64 (double x, LayoutBuilderPtr< T, I > builder)
 Adds a real value x to the accumulated data. More...
 
virtual void complex (std::complex< double > x, LayoutBuilderPtr< T, I > builder)
 Adds a complex value x to the accumulated data. More...
 
virtual void bytestring (const std::string &x, LayoutBuilderPtr< T, I > builder)
 Adds an unencoded bytestring x in STL format to the accumulated data. More...
 
virtual void string (const std::string &x, LayoutBuilderPtr< T, I > builder)
 Adds a UTF-8 encoded bytestring x in STL format to the accumulated data. More...
 
virtual void begin_list (LayoutBuilderPtr< T, I > builder)
 Begins building a nested list. More...
 
virtual void end_list (LayoutBuilderPtr< T, I > builder)
 Ends a nested list. More...
 
virtual bool active ()
 If true, this node has started but has not finished a multi-step command (e.g. begin_list ... end_list). More...
 
virtual std::string parameters_as_string (const util::Parameters &parameters) const
 FIXME: find if it's already implemented in utils. More...
 

Detailed Description

template<typename T, typename I>
class awkward::FormBuilder< T, I >

Abstract base class for nodes within a LayoutBuilder Every builder will have an output buffer based on the key_format="part{partition}-{form_key}-{attribute}".

Constructor & Destructor Documentation

◆ ~FormBuilder()

virtual ~FormBuilder ( )
virtual

Virtual destructor acts as a first non-inline virtual function that determines a specific translation unit in which vtable shall be emitted.

Member Function Documentation

◆ active()

virtual bool active ( )
inlinevirtual

If true, this node has started but has not finished a multi-step command (e.g. begin_list ... end_list).

Reimplemented in ListArrayBuilder< T, I >, ListOffsetArrayBuilder< T, I >, and RecordArrayBuilder< T, I >.

◆ begin_list()

◆ boolean()

◆ bytestring()

◆ classname()

◆ complex()

◆ end_list()

◆ float64()

◆ int64()

◆ is_complex()

virtual bool is_complex ( ) const
inlinevirtual

Reimplemented in NumpyArrayBuilder< T, I >.

◆ len()

◆ parameters_as_string()

virtual std::string parameters_as_string ( const util::Parameters parameters) const
inlinevirtual

FIXME: find if it's already implemented in utils.

◆ string()

◆ tag()

virtual void tag ( int8_t  x)
inlinevirtual

Adds an integer value x to the accumulated data.

Reimplemented in UnionArrayBuilder< T, I >.

◆ to_buffers()

◆ vm_error()

◆ vm_from_stack()

◆ vm_func()

◆ vm_func_name()

◆ vm_func_type()

◆ vm_output()

◆ vm_output_data()


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