root

Documentation

Overview

Package root defines ROOT core interfaces.

Index

• Constants
• type Array
• type Collection
• type Double32
• type Float16
• type List
• type Merger
• type Named
• type ObjArray
• type ObjString
• type Object
• type ObjectFinder
• type SeqCollection
• type UIDer

Constants

const (
	Version = rvers.ROOT // ROOT version the groot library implements
)

Types

type Array

type Array interface {
	Len() int // number of array elements
	Get(i int) interface{}
	Set(i int, v interface{})
}

Array describes ROOT abstract array type.

type Collection

type Collection interface {
	Object

	// Name returns the name of the collection.
	Name() string

	// Last returns the last element index
	Last() int

	// At returns the element at index i
	At(i int) Object

	// Len returns the number of elements in the collection
	Len() int
}

Collection is a collection of ROOT Objects.

type Double32

type Double32 float64

Double32 is a float64 in memory, written as a float32 to disk.

type Float16

type Float16 float32

Float16 is a float32 in memory, written with a truncated mantissa.

type List

type List interface {
	SeqCollection
}

List is a list of ROOT Objects.

type Merger

type Merger interface {
	ROOTMerge(src Object) error
}

Merger is a ROOT object that can ingest data from another ROOT object.

type Named

type Named interface {
	Object

	// Name returns the name of this ROOT object
	Name() string

	// Title returns the title of this ROOT object
	Title() string
}

Named represents a ROOT TNamed object

type ObjArray

type ObjArray interface {
	SeqCollection
	LowerBound() int
}

ObjArray is an array of ROOT Objects.

type ObjString

type ObjString interface {
	Name() string
	String() string
}

ObjString is a ROOT string that implements ROOT TObject.

type Object

type Object interface {
	// Class returns the ROOT class of this object
	Class() string
}

Object represents a ROOT object

type ObjectFinder

type ObjectFinder interface {
	Keys() []string
	Get(name string) (Object, error)
}

ObjectFinder is the interface that wraps the (C++ equivalent) FindObject method.

type SeqCollection

type SeqCollection interface {
	Collection
}

SeqCollection is a sequential collection of ROOT Objects.

type UIDer

type UIDer interface {
	// UID returns the unique ID of this object
	UID() uint32
}

UIDer is the interface for objects that can be referenced.