Documentation ¶
Overview ¶
groot is a native implementation of the core of ROOT in Go.
Index ¶
- Variables
- type Basket
- type Branch
- type BranchElement
- type Buffer
- type Class
- type ClassFactory
- type Directory
- type FactoryFct
- type File
- type FileSetter
- type Key
- type LeafB
- type LeafC
- type LeafD
- type LeafElement
- type LeafF
- type LeafI
- type LeafL
- type LeafO
- type LeafS
- type List
- type Member
- type Object
- type ROOTStreamer
- type StreamerBase
- func (se *StreamerBase) ArrDim() int
- func (se *StreamerBase) ArrLen() int
- func (se *StreamerBase) Class() string
- func (se *StreamerBase) MaxIdx() []int32
- func (se *StreamerBase) Name() string
- func (se *StreamerBase) Offset() int
- func (se *StreamerBase) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerBase) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerBase) Size() int
- func (se *StreamerBase) Title() string
- func (se *StreamerBase) Type() int
- func (se *StreamerBase) TypeName() string
- type StreamerBasicPointer
- func (se *StreamerBasicPointer) ArrDim() int
- func (se *StreamerBasicPointer) ArrLen() int
- func (se *StreamerBasicPointer) Class() string
- func (se *StreamerBasicPointer) MaxIdx() []int32
- func (se *StreamerBasicPointer) Name() string
- func (se *StreamerBasicPointer) Offset() int
- func (se *StreamerBasicPointer) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerBasicPointer) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerBasicPointer) Size() int
- func (se *StreamerBasicPointer) Title() string
- func (se *StreamerBasicPointer) Type() int
- func (se *StreamerBasicPointer) TypeName() string
- type StreamerBasicType
- func (se *StreamerBasicType) ArrDim() int
- func (se *StreamerBasicType) ArrLen() int
- func (se *StreamerBasicType) Class() string
- func (se *StreamerBasicType) MaxIdx() []int32
- func (se *StreamerBasicType) Name() string
- func (se *StreamerBasicType) Offset() int
- func (se *StreamerBasicType) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerBasicType) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerBasicType) Size() int
- func (se *StreamerBasicType) Title() string
- func (se *StreamerBasicType) Type() int
- func (se *StreamerBasicType) TypeName() string
- type StreamerElement
- type StreamerInfo
- type StreamerObject
- func (se *StreamerObject) ArrDim() int
- func (se *StreamerObject) ArrLen() int
- func (se *StreamerObject) Class() string
- func (se *StreamerObject) MaxIdx() []int32
- func (se *StreamerObject) Name() string
- func (se *StreamerObject) Offset() int
- func (se *StreamerObject) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerObject) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerObject) Size() int
- func (se *StreamerObject) Title() string
- func (se *StreamerObject) Type() int
- func (se *StreamerObject) TypeName() string
- type StreamerObjectAny
- func (se *StreamerObjectAny) ArrDim() int
- func (se *StreamerObjectAny) ArrLen() int
- func (se *StreamerObjectAny) Class() string
- func (se *StreamerObjectAny) MaxIdx() []int32
- func (se *StreamerObjectAny) Name() string
- func (se *StreamerObjectAny) Offset() int
- func (se *StreamerObjectAny) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerObjectAny) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerObjectAny) Size() int
- func (se *StreamerObjectAny) Title() string
- func (se *StreamerObjectAny) Type() int
- func (se *StreamerObjectAny) TypeName() string
- type StreamerObjectPointer
- func (se *StreamerObjectPointer) ArrDim() int
- func (se *StreamerObjectPointer) ArrLen() int
- func (se *StreamerObjectPointer) Class() string
- func (se *StreamerObjectPointer) MaxIdx() []int32
- func (se *StreamerObjectPointer) Name() string
- func (se *StreamerObjectPointer) Offset() int
- func (se *StreamerObjectPointer) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerObjectPointer) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerObjectPointer) Size() int
- func (se *StreamerObjectPointer) Title() string
- func (se *StreamerObjectPointer) Type() int
- func (se *StreamerObjectPointer) TypeName() string
- type StreamerSTL
- func (se *StreamerSTL) ArrDim() int
- func (se *StreamerSTL) ArrLen() int
- func (se *StreamerSTL) Class() string
- func (se *StreamerSTL) MaxIdx() []int32
- func (se *StreamerSTL) Name() string
- func (se *StreamerSTL) Offset() int
- func (se *StreamerSTL) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerSTL) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerSTL) Size() int
- func (se *StreamerSTL) Title() string
- func (se *StreamerSTL) Type() int
- func (se *StreamerSTL) TypeName() string
- type StreamerSTLstring
- func (se *StreamerSTLstring) ArrDim() int
- func (se *StreamerSTLstring) ArrLen() int
- func (se *StreamerSTLstring) Class() string
- func (se *StreamerSTLstring) MaxIdx() []int32
- func (se *StreamerSTLstring) Name() string
- func (se *StreamerSTLstring) Offset() int
- func (se *StreamerSTLstring) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerSTLstring) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerSTLstring) Size() int
- func (se *StreamerSTLstring) Title() string
- func (se *StreamerSTLstring) Type() int
- func (se *StreamerSTLstring) TypeName() string
- type StreamerString
- func (se *StreamerString) ArrDim() int
- func (se *StreamerString) ArrLen() int
- func (se *StreamerString) Class() string
- func (se *StreamerString) MaxIdx() []int32
- func (se *StreamerString) Name() string
- func (se *StreamerString) Offset() int
- func (se *StreamerString) ROOTDecode(b *Buffer) (err error)
- func (se *StreamerString) ROOTEncode(b *Buffer) (err error)
- func (se *StreamerString) Size() int
- func (se *StreamerString) Title() string
- func (se *StreamerString) Type() int
- func (se *StreamerString) TypeName() string
- type Tree
- func (tree *Tree) Branches() []Branch
- func (tree *Tree) Class() string
- func (tree *Tree) Entries() uint64
- func (tree *Tree) Name() string
- func (tree *Tree) ROOTDecode(b *Buffer) (err error)
- func (tree *Tree) ROOTEncode(b *Buffer) (err error)
- func (tree *Tree) SetFile(f *File) (err error)
- func (tree *Tree) Title() string
Constants ¶
This section is empty.
Variables ¶
var Factory factory = factory{ // contains filtered or unexported fields }
the registry of all factory functions, by class name
Functions ¶
This section is empty.
Types ¶
type Basket ¶
type Basket struct {
// contains filtered or unexported fields
}
func (*Basket) ROOTDecode ¶
func (*Basket) ROOTEncode ¶
type Branch ¶
type Branch struct {
// contains filtered or unexported fields
}
func (*Branch) ROOTDecode ¶
func (*Branch) ROOTEncode ¶
type BranchElement ¶
type BranchElement struct {
// contains filtered or unexported fields
}
func (*BranchElement) Class ¶
func (be *BranchElement) Class() string
func (*BranchElement) Name ¶
func (be *BranchElement) Name() string
func (*BranchElement) ROOTDecode ¶
func (be *BranchElement) ROOTDecode(b *Buffer) (err error)
func (*BranchElement) ROOTEncode ¶
func (be *BranchElement) ROOTEncode(b *Buffer) (err error)
func (*BranchElement) Title ¶
func (be *BranchElement) Title() string
type Buffer ¶
type Buffer struct {
// contains filtered or unexported fields
}
func NewBufferFromKey ¶
type Class ¶
type Class interface { // Members returns the list of members for this ROOT class Members() []Member // Version returns the version number for this ROOT class Version() int // Name returns the ROOT class name for this ROOT class Name() string }
Class represents a ROOT class. Class instances are created by a ClassFactory.
type ClassFactory ¶
ClassFactory creates ROOT classes
type Directory ¶
type Directory struct {
// contains filtered or unexported fields
}
Directory is a directory inside a ROOT file
func (*Directory) ROOTDecode ¶
func (*Directory) ROOTEncode ¶
type FactoryFct ¶
type FileSetter ¶
FileSetter is the interface allowing to reset the ownership of a ROOT object w.r.t a given file
type Key ¶
type Key struct {
// contains filtered or unexported fields
}
Key is a key (a label) in a ROOT file
The Key class includes functions to book space on a file, to create I/O buffers, to fill these buffers to compress/uncompress data buffers. Before saving (making persistent) an object on a file, a key must be created. The key structure contains all the information to uniquely identify a persistent object on a file. fNbytes = number of bytes for the compressed object+key version of the Key class fObjlen = Length of uncompressed object fDatime = Date/Time when the object was written fKeylen = number of bytes for the key structure fCycle = cycle number of the object fSeekKey = Address of the object on file (points to fNbytes) This is a redundant information used to cross-check the data base integrity. fSeekPdir = Pointer to the directory supporting this object fClassName = Object class name fName = name of the object fTitle = title of the object The Key class is used by ROOT to: - to write an object in the Current Directory - to write a new ntuple buffer
type LeafB ¶
type LeafB struct {
// contains filtered or unexported fields
}
func (*LeafB) ROOTDecode ¶
func (*LeafB) ROOTEncode ¶
type LeafC ¶
type LeafC struct {
// contains filtered or unexported fields
}
func (*LeafC) ROOTDecode ¶
func (*LeafC) ROOTEncode ¶
type LeafD ¶
type LeafD struct {
// contains filtered or unexported fields
}
func (*LeafD) ROOTDecode ¶
func (*LeafD) ROOTEncode ¶
type LeafElement ¶
type LeafElement struct {
// contains filtered or unexported fields
}
func (*LeafElement) Class ¶
func (le *LeafElement) Class() string
func (*LeafElement) Name ¶
func (le *LeafElement) Name() string
func (*LeafElement) ROOTDecode ¶
func (le *LeafElement) ROOTDecode(b *Buffer) (err error)
func (*LeafElement) ROOTEncode ¶
func (le *LeafElement) ROOTEncode(b *Buffer) (err error)
func (*LeafElement) Title ¶
func (le *LeafElement) Title() string
type LeafF ¶
type LeafF struct {
// contains filtered or unexported fields
}
func (*LeafF) ROOTDecode ¶
func (*LeafF) ROOTEncode ¶
type LeafI ¶
type LeafI struct {
// contains filtered or unexported fields
}
func (*LeafI) ROOTDecode ¶
func (*LeafI) ROOTEncode ¶
type LeafL ¶
type LeafL struct {
// contains filtered or unexported fields
}
func (*LeafL) ROOTDecode ¶
func (*LeafL) ROOTEncode ¶
type LeafO ¶
type LeafO struct {
// contains filtered or unexported fields
}
func (*LeafO) ROOTDecode ¶
func (*LeafO) ROOTEncode ¶
type LeafS ¶
type LeafS struct {
// contains filtered or unexported fields
}
func (*LeafS) ROOTDecode ¶
func (*LeafS) ROOTEncode ¶
type List ¶
type List struct {
// contains filtered or unexported fields
}
func (*List) ROOTDecode ¶
func (*List) ROOTEncode ¶
type Member ¶
type Member interface { // GetArrayDim returns the dimension of the array (if any) ArrayDim() int // GetComment returns the comment associated with this member Comment() string // Name returns the name of this member Name() string // Type returns the class of this member Type() Class }
Member represents a single member of a ROOT class
type Object ¶
type Object interface { // Class returns the ROOT class of this object Class() string // Name returns the name of this ROOT object Name() string // Title returns the title of this ROOT object Title() string }
Object represents a ROOT object
type ROOTStreamer ¶
type ROOTStreamer interface { // de-serialize into the current value using 'buf' as input ROOTDecode(buf *Buffer) error // serialize the current value using 'buf' as output ROOTEncode(buf *Buffer) error }
ROOTStreamer is the interface describing data that provides its own routine for encoding and decoding transmitted values sent to a ROOT file.
type StreamerBase ¶
type StreamerBase struct {
// contains filtered or unexported fields
}
StreamerBase is a streamer element for a base class
func (*StreamerBase) Class ¶
func (se *StreamerBase) Class() string
func (*StreamerBase) ROOTDecode ¶
func (se *StreamerBase) ROOTDecode(b *Buffer) (err error)
func (*StreamerBase) ROOTEncode ¶
func (se *StreamerBase) ROOTEncode(b *Buffer) (err error)
type StreamerBasicPointer ¶
type StreamerBasicPointer struct {
// contains filtered or unexported fields
}
StreamerBasicPointer is a streamer element for a pointer to a builtin type
func (*StreamerBasicPointer) Class ¶
func (se *StreamerBasicPointer) Class() string
func (*StreamerBasicPointer) ROOTDecode ¶
func (se *StreamerBasicPointer) ROOTDecode(b *Buffer) (err error)
func (*StreamerBasicPointer) ROOTEncode ¶
func (se *StreamerBasicPointer) ROOTEncode(b *Buffer) (err error)
type StreamerBasicType ¶
type StreamerBasicType struct {
// contains filtered or unexported fields
}
StreamerBasicType is a streamer element for a builtin type
func (*StreamerBasicType) Class ¶
func (se *StreamerBasicType) Class() string
func (*StreamerBasicType) ROOTDecode ¶
func (se *StreamerBasicType) ROOTDecode(b *Buffer) (err error)
func (*StreamerBasicType) ROOTEncode ¶
func (se *StreamerBasicType) ROOTEncode(b *Buffer) (err error)
type StreamerElement ¶
type StreamerElement interface { Name() string Title() string Type() int // element type Size() int // sizeof element ArrLen() int // cumulative size of all array dims ArrDim() int // number of array dimensions MaxIdx() []int32 // maximum array index for array dimension "dim" Offset() int // element offset in class //IsNewType() int // new element type when reading TypeName() string // data type name of data member }
type StreamerInfo ¶
type StreamerInfo struct {
// contains filtered or unexported fields
}
func (*StreamerInfo) Class ¶
func (si *StreamerInfo) Class() string
func (*StreamerInfo) Name ¶
func (si *StreamerInfo) Name() string
func (*StreamerInfo) ROOTDecode ¶
func (si *StreamerInfo) ROOTDecode(b *Buffer) (err error)
func (*StreamerInfo) ROOTEncode ¶
func (si *StreamerInfo) ROOTEncode(b *Buffer) (err error)
func (*StreamerInfo) Title ¶
func (si *StreamerInfo) Title() string
type StreamerObject ¶
type StreamerObject struct {
// contains filtered or unexported fields
}
StreamerObject is a streamer element for an object
func NewStreamerObject ¶
func NewStreamerObject(name, title string, offset int, typename string) *StreamerObject
func (*StreamerObject) Class ¶
func (se *StreamerObject) Class() string
func (*StreamerObject) ROOTDecode ¶
func (se *StreamerObject) ROOTDecode(b *Buffer) (err error)
func (*StreamerObject) ROOTEncode ¶
func (se *StreamerObject) ROOTEncode(b *Buffer) (err error)
type StreamerObjectAny ¶
type StreamerObjectAny struct {
// contains filtered or unexported fields
}
StreamerObjectAny is a streamer element for any object
func (*StreamerObjectAny) Class ¶
func (se *StreamerObjectAny) Class() string
func (*StreamerObjectAny) ROOTDecode ¶
func (se *StreamerObjectAny) ROOTDecode(b *Buffer) (err error)
func (*StreamerObjectAny) ROOTEncode ¶
func (se *StreamerObjectAny) ROOTEncode(b *Buffer) (err error)
type StreamerObjectPointer ¶
type StreamerObjectPointer struct {
// contains filtered or unexported fields
}
StreamerObjectPointer is a streamer element for a pointer to an object
func (*StreamerObjectPointer) Class ¶
func (se *StreamerObjectPointer) Class() string
func (*StreamerObjectPointer) ROOTDecode ¶
func (se *StreamerObjectPointer) ROOTDecode(b *Buffer) (err error)
func (*StreamerObjectPointer) ROOTEncode ¶
func (se *StreamerObjectPointer) ROOTEncode(b *Buffer) (err error)
type StreamerSTL ¶
type StreamerSTL struct {
// contains filtered or unexported fields
}
StreamerSTL is a streamer element for STL containers
func (*StreamerSTL) Class ¶
func (se *StreamerSTL) Class() string
func (*StreamerSTL) ROOTDecode ¶
func (se *StreamerSTL) ROOTDecode(b *Buffer) (err error)
func (*StreamerSTL) ROOTEncode ¶
func (se *StreamerSTL) ROOTEncode(b *Buffer) (err error)
type StreamerSTLstring ¶
type StreamerSTLstring struct {
StreamerSTL
}
StreamerSTLstring is a streamer element for std::string
func (*StreamerSTLstring) Class ¶
func (se *StreamerSTLstring) Class() string
func (*StreamerSTLstring) ROOTDecode ¶
func (se *StreamerSTLstring) ROOTDecode(b *Buffer) (err error)
func (*StreamerSTLstring) ROOTEncode ¶
func (se *StreamerSTLstring) ROOTEncode(b *Buffer) (err error)
type StreamerString ¶
type StreamerString struct {
// contains filtered or unexported fields
}
StreamerString is a streamer element for a string
func (*StreamerString) Class ¶
func (se *StreamerString) Class() string
func (*StreamerString) ROOTDecode ¶
func (se *StreamerString) ROOTDecode(b *Buffer) (err error)
func (*StreamerString) ROOTEncode ¶
func (se *StreamerString) ROOTEncode(b *Buffer) (err error)
type Tree ¶
type Tree struct {
// contains filtered or unexported fields
}