In file Type.hh:

class Type

Defines an event type

Inheritance:


Public Methods

Type ()
Default constructor
explicit Type (const char* name)
Default constructor
explicit Type (const std::string& name)
Default constructor
Type (const Type& type)
Copy constructor
~Type ()
Destructor
Type& operator= (const Type& type)
Assignment operator
bool SetType (const char* name)
Set type
const char* GetName () const
Get event type
int GetId () const
Get event ID
const TypeInfo* GetTypeInfo () const
Get type information
const LayoutInfo* GetLayout () const
Get layout information
bool operator== (const Type& t) const
Equality operator
bool operator!= (const Type& t) const
Inequality operator
bool operator< (const Type& t) const
Smaller than operator
static bool Test (const char* name)
Test type
bool Match (const char* pat) const
Match operator
static bool CheckName (const char* name)
Check name
static void DumpAll (std::ostream& os)
Dump all registered types.
static void DumpAll ()
Dump all registered types.

Documentation

Describes the event type. An event type consists of a name and a subtype. Type and subtype names can not contain the characters "(", ")", "[", "]" or ".".

Type()
Creates an empty event type.

explicit Type(const char* name)
Creates an event type.
Parameters:
name - Name representing the event type
subtype - Subtype of the event

explicit Type(const std::string& name)
Creates an event type.
Parameters:
name - Name representing the event type
subtype - Subtype of the event

Type(const Type& type)
Copy constructor
Parameters:
type - Event type

~Type()
Destroys the event type.

Type& operator= (const Type& type)
Assignment operator
Returns:
*this
Parameters:
type - Event type

bool SetType(const char* name)
Sets the event type.
Returns:
true if successful
Parameters:
name - Name representing the event type
subtype - Subtype of the event

const char* GetName() const
Get the event name.
Returns:
name

int GetId() const
Get the event ID.
Returns:
name

const TypeInfo* GetTypeInfo() const
Get the type information record.
Returns:
type information record

const LayoutInfo* GetLayout() const
Get the the layout information record.
Returns:
layout information record

bool operator== (const Type& t) const
Test if two event types are equal.
Returns:
true if identical event types

bool operator!= (const Type& t) const
Test if two event types are unequal.
Returns:
true if different event types

bool operator< (const Type& t) const
Smaller than operator. Compares the type Id and subtype Id.
Returns:
true if smaller

static bool Test(const char* name)
Tests if the event type exists.
Returns:
true if type exists
Parameters:
name - Name representing the event type
subtype - Subtype of the event

bool Match(const char* pat) const
Tests if the pattern matches the event type. The pattern can contain a wildcard.
Returns:
true if event type matches pattern
Parameters:
pat - Pattern for event name

static bool CheckName(const char* name)
Check if a valid type name is specified.
Returns:
True if valid
Parameters:
name - Type or subtype name

static void DumpAll(std::ostream& os)
Dump all registered types to the specified output stream.
Parameters:
os - output stream

static void DumpAll()
Dump all registered types to the standard output stream.
Parameters:
os - output stream


This class has no child classes.
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++