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.

Parameters:

type - Event type

Returns:

*this

bool SetType(const char* name)

Sets the event type.

Parameters:

name - Name representing the event type
subtype - Subtype of the event

Returns:

true if successful

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.

Parameters:

name - Name representing the event type
subtype - Subtype of the event

Returns:

true if type exists

bool Match(const char* pat) const

Tests if the pattern matches the event type. The pattern can contain a wildcard.

Parameters:

pat - Pattern for event name

Returns:

true if event type matches pattern

static bool CheckName(const char* name)

Check if a valid type name is specified.

Parameters:

name - Type or subtype name

Returns:

True if valid

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 HTML hierarchy of classes or Java

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