Defines an event name

Inheritance:

Public Methods

	Name () Default constructor
explicit	Name (int id) Default constructor
explicit	Name (const char* name) Constructor
explicit	Name (const std::string& name) Constructor
bool	SetName (const char* name) Set name
const char*	GetName () const Get event name
int	GetId () const Get event ID
bool	operator== (const Name& n) const Equality operator
bool	operator!= (const Name& n) const Inequality operator
static int	GetNameId (const char* name) Get event ID
static bool	Test (const char* name) Test name
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 names.
static void	DumpAll () Dump all registered names.

Documentation

Describes the event name. An event name can not contain the characters "(", ")", "[", "]" or ".".

Name()

Creates an empty event name.

explicit Name(int id)

Creates an event name.

Parameters:

name - Name representing the event name

explicit Name(const char* name)

Creates an event name.

Parameters:

name - Name representing the event name

explicit Name(const std::string& name)

Creates an event name.

Parameters:

name - Name representing the event name

bool SetName(const char* name)

Sets the event name.

Parameters:

name - Name representing the event name

Returns:

true if successful

const char* GetName() const

Get the event name.

Returns:

name

int GetId() const

Get the event ID.

Returns:

name

bool operator== (const Name& n) const

Test if two event names are equal.

Returns:

true if identical event names

bool operator!= (const Name& n) const

Test if two event names are unequal.

Returns:

true if different event names

static int GetNameId(const char* name)

Get the event ID of the given string. Will not register the name but rather return 0 if the name does not exists.

Returns:

ID

static bool Test(const char* name)

Tests if the event name exists.

Parameters:

name - Name representing the event name

Returns:

true if type exists

bool Match(const char* pat) const

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

Parameters:

pat - Pattern for event name

Returns:

true if event name matches pattern

static bool CheckName(const char* name)

Check if a valid name name is specified.

Parameters:

name - Name

Returns:

True if valid

static void DumpAll(std::ostream& os)

Dump all registered names to the specified output stream.

Parameters:

os - output stream

static void DumpAll()

Dump all registered names 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