In file FixedColumns.hh:

namespace events struct FixedColumns : public ColumnType

Fixed column management

static bool Add(const ColumnInfo& info)
Add a fixed column
static bool Add(const char* name, Enum type)
Add a fixed column
static const ColumnInfo* Get(const char*)
Get a fixed column
static const ColumnInfoList& List()
Get the fixed column list
static int VaryingNumber()
Get a varying column index
static int VaryingOffset()
Get a varying column offset

Documentation

Fixed column handling routines. A set of routines to add and query the list of fixed columns. The list of fixed columns is handled by the event factory. This is just the interface.

Fixed columns are stored before any additional event specific columns. They are stored in the order they are declared. A fixed column has a fixed column index and a fixed offset into the event data block. They are common to all events and can be accessed fast. Since they are common, fixed columns can only be added before the first event layout gets registered. Fixed columns cannot be removed once they have been added.

Predefined fixed columns are

    ColumnNumber - The number of columns within the event data block
    SubTypeId - Represents the event subtype identification number
    Time - Represents the event time
    Ifo - Represents the interferometer information (bit set)
    

static bool Add(const ColumnInfo& info)
Add a fixed column
Returns:
true if succesful
Parameters:
info - Column information record

static bool Add(const char* name, Enum type)
Add a fixed column
Returns:
true if succesful
Parameters:
name - Column name
type - Column type
csize - Array size for string type

static const ColumnInfo* Get(const char*)
Get a fixed column by name.
Returns:
pointer to column information record (0 if failed)
Parameters:
name - Column name

static const ColumnInfoList& List()
Get the fixed column list
Returns:
List of fixed columns

static int VaryingNumber()
Get a index of the first varying column. This is the first index available for event specific columns.
Returns:
Varying column index

static int VaryingOffset()
Get a byte offset of the first varying column. This is the first address available for event specific columns.
Returns:
Varying column offset

Author:
Written June 2001 by Masahiro Ito and Daniel Sigg
Version:
1.0

alphabetic index hierarchy of classes


Please send questions and comments to sigg_d@ligo-wa.caltech.edu


generated by doc++