In file /home/eternity/Source/Eso/TCBWrapper/H/keywords.h:

class Keywords : public ArrayGMessage

GMessage used for storing array of keywords

Inheritance:

Keywords < ArrayGMessage < GMessage < Debugable


Public Methods

Err Keywords::AddKeyword (Char *keyword)
Adds a keyword
Char* Keywords::Keyword (Int i)
Gets i-th keyword label
Keywords::Keywords (LogFile *aLogFile)
Constructor
Int Keywords::MatchesPattern (Char *pattern)
Decides wheter pattern matches keywords

Public

methods
Keywords (LogFile *aLogFile = NULL)
Constructor.
Char* Keyword (Int i)
Method returning i-th keyword from an array.
Int MatchesPattern (Char *pattern)
Given a pattern (search string) decides whether keywords match it.
Err AddKeyword (Char *keyword)
Adds a keyword.

Inherited from ArrayGMessage:

Public Methods

Err ArrayGMessage::AddField(Char *prefix, MsgField *contents)
ArrayGMessage::ArrayGMessage(LogFile *aLogFile)
Char* ArrayGMessage::CountName(Char *prefix)
Char* ArrayGMessage::FieldName(Char *prefix, Int i)
GMessage* ArrayGMessage::GetAsGMessage(Char *prefix, Int i)
MsgField* ArrayGMessage::GetField(Char *prefix, Int i)
Err ArrayGMessage::LoadFromLines(Char *prefix, Char *str)
Err ArrayGMessage::SetField(Char *prefix, Int i, MsgField *contents)

Inherited from GMessage:

Public Methods

Size GMessage::CheckSum(char *input, Size len)
Void GMessage::Clear()
Err GMessage::DebugHeaders(LogFile *aLogFile, Char *aLogLabel, LogLevel aLogLevel)
Err GMessage::Delete(Char *aFieldName)
GMessage::GMessage(LogFile *aLogFile)
GMessage::GMessage(const GMessage *aGMessage, LogFile *aLogFile)
GMessage::GMessage(Char *aFileName, LogFile *aLogFile)
GMessage::GMessage(Void *aBuffer, Size aSize, LogFile *aLogFile)
Err GMessage::GetAsBasicTime(Char *aFieldName, BasicTime *t) const
Void* GMessage::GetAsBytes(Char *aFieldName, Size *aSize) const
Err GMessage::GetAsFile(Char *aFieldName, Char *aFileName) const
GMessage* GMessage::GetAsGMessage(Char *aFieldName) const
Err GMessage::GetAsID(Char *aFieldName, ID *t) const
Err GMessage::GetAsInt(Char *aFieldName, Int *i) const
MsgField* GMessage::GetAsMsgField(Char *aFieldName) const
Err GMessage::GetAsSize(Char *aFieldName, Size *i) const
Char* GMessage::GetAsString(Char *aFieldName) const
Void GMessage::Initialize()
Err GMessage::LoadFromBytes(Void *aBuffer, Size aLength)
Err GMessage::LoadFromFile(Char *aFileName)
Char* GMessage::ReadBytesHeader(Void *aBuffer, Size aLength, Size *aSize, Size *anOffset)
Char* GMessage::ReadFileHeader(File *aFile, Size *aSize)
Err GMessage::Rename(Char *aFieldName, Char *newFieldName)
Err GMessage::SetAsBasicTime(Char *aFieldName, BasicTime aVariable)
Err GMessage::SetAsBytes(Char *aFieldName, Void *aBuffer, Size aSize)
Err GMessage::SetAsFile(Char *aFieldName, Char *aFileName)
Err GMessage::SetAsGMessage(Char *aFieldName, GMessage *aGMessage)
Err GMessage::SetAsID(Char *aFieldName, ID aVariable)
Err GMessage::SetAsInt(Char *aFieldName, Int aVariable)
Err GMessage::SetAsMsgField(Char *aFieldName, MsgField *aField)
Err GMessage::SetAsSize(Char *aFieldName, Size aVariable)
Err GMessage::SetAsString(Char *aFieldName, Char *aString)
Size GMessage::SizeOf() const
Void* GMessage::StoreToBytes(Size *aSize) const
Err GMessage::StoreToFile(Char *aFileName) const
MsgField* GMessage::StoreToMsgField(Char *aFieldName) const
Size GMessage::Sum(char *input, Size len)
Err GMessage::WriteBytesHeader(Void *aBuffer, MsgField *aMsgField, Size *anOffset) const
Err GMessage::WriteFileHeader(File *aFile, MsgField *aMsgField) const
GMessage::~GMessage()

Protected

attributes

FieldQueue* fields
MsgFields

Inherited from Debugable:

Public Methods

string* Debugable::CreateString(char *firstStr, int firstInt, int secondInt)
Debugable::Debugable(LogFile * debugLogFile)
int Debugable::SetDebugOptions(int newLogOptions)
void Debugable::SetLogFile(LogFile *aLogFile)
void Debugable::WriteString(LogLevel debugLevel, char * format, ...)
Debugable::~Debugable()

Documentation

GMessage used for storing array of keywords. This class simply extends the functionality of ArrayGMessage, making it simple to work with an array of keywords. In a fact an ArrayGMessage using prefix GM_KEYWORD.
methods

Keywords(LogFile *aLogFile = NULL)
Constructor.

Char* Keyword(Int i)
Method returning i-th keyword from an array.

Int MatchesPattern(Char *pattern)
Given a pattern (search string) decides whether keywords match it.

Err AddKeyword(Char *keyword)
Adds a keyword.

Err Keywords::AddKeyword(Char *keyword)
Adds a keyword. Simply calls ArrayGMessage::AddField with converted arguments.
Returns:
error code
Parameters:
keyword - keyword to add
Author:
Pavel
See Also:

Char* Keywords::Keyword(Int i)
Gets i-th keyword label. Creates and returns i-th label for keyword.
Returns:
created label
Parameters:
i - position of label to return
Author:
Pavel
See Also:

Keywords::Keywords(LogFile *aLogFile)
Constructor. Simply calls from ArrayGMessage inherited constructer.
Parameters:
aLogFile - log file for debugging messages
Author:
Pavel
See Also:
ArrayGMessage

Int Keywords::MatchesPattern(Char *pattern)
Decides wheter pattern matches keywords. This version accepts only a single word and looks, if there is an exactly same keyword stored. This method is virtual and expects further modifications to accept even more complex queries.
Returns:
0 if successfull, non 0 otherwise
Parameters:
pattern - string with a query
Author:
Pavel
See Also:


This class has no child classes.
Author:
Pavel
See Also:
ArrayGMessage, TCBWrapper, Client

alphabetic index hierarchy of classes


generated by doc++