Defines an event information function
explicit | Info (const char* name) Constructor |
explicit | Info (const char* name, int index) Constructor |
explicit | Info (const std::string& name, int index) Constructor |
Info (const char* name, const Function& arg1) Constructor | |
virtual Info* | Copy () const Copy the event info |
bool | IsValid () const Is valid? |
bool | operator== (const Info& info) const Equality operator |
bool | operator!= (const Info& info) const Inequality operator |
virtual bool | InfoValue (const Event& event, Value& val) const Value of information item |
virtual bool | Evaluate (const Argument& arg, Value& val) const Value of information item |
virtual void | SetName (const char* name) Sets information item |
const char* | GetName () const Name of information item |
void | SetIndex (int index) Set event index |
int | GetIndex () const Get event index |
Event information access. Like column values, the information describing the event layout can be accessed through an event function. Rather than reading values from the event data block, this class accessed the event layout information.The event information is accessed by name. Recognized names are:
------------------------------------------------------------------- Name Return Description ------------------------------------------------------------------- Type String Event type name Name String Event name TypeId Int Event type identification number NameId Int Event name identification number Size Int Size of event data block in bytes RefCount Int Number of identical events ColumnNumber Int Number of columns Column(i)::Name String Column name Column(i)::Type String Column type name Column(i)::TypeId Int Column type identification number Column(i)::TypeSize Int Type size Column(i)::Fixed Int One if fixed column Column(i)::Index Int Column index Column(i)::Offset Int Column byte offset -------------------------------------------------------------------The column index i can be specified as a number or as a column name. The notation "m:n" can be used to specify that the index should be enumerated over indices m to n. If the second argumen is missing, i.e., "m:", the enumeration goes till the last column. When enumerating columns, the result is always returned as a string of comma separated values.
The special literal "dollar" can be used to represent a column index which is specified at run-time. For example,
Info ("Column($)::Name", Info ("ColumnNumber") - 1)can be used to get the name of the last column.If a information item is specified without an event index, the default is zero. An event index can be explicitly specified as part of the string or as a separate argument. Examples:
Info ("Type[1]") + Value("::") + Info ("Name", 1)constructs a type identifier string on the second event.As with the column class the information function can also access events stored as event columns. The same notation applies. For example:
Info ("Event(1).Type") Info ("Type(1)")to access the type inormation from the event stored in a column named "Event(1)".
name - full name
n - Number of events passed to method
val - Info value (return)
val - Column value (return)
alphabetic index hierarchy of classes
Please send questions and comments to sigg_d@ligo-wa.caltech.edu
generated by doc++