IRCResponseParseResult Class Reference

Result info generated by the IRCResponseParser. More...

#include <ircresponseparseresult.h>

Public Member Functions

 IRCResponseParseResult ()
 Creates an invalid object. More...
 
 IRCResponseParseResult (const IRCResponseType &responseType, bool bWasParsed)
 A valid response result with set type and notification if it was parsed or not. More...
 
 IRCResponseParseResult (const IRCResponseParseResult &other)
 
bool isValid () const
 
IRCResponseParseResultoperator= (const IRCResponseParseResult &other)
 
const IRCResponseTypetype () const
 Type of the response as defined by IRCResponseType. More...
 
bool wasParsed () const
 true if response message was parsed, false if IRCResponseParser ignored the response. More...
 

Detailed Description

Result info generated by the IRCResponseParser.

Definition at line 16 of file ircresponseparseresult.h.

Constructor & Destructor Documentation

IRCResponseParseResult::IRCResponseParseResult ( )

Creates an invalid object.

Invalid object means that error occured and the parsing didn't even occur.

Definition at line 14 of file ircresponseparseresult.cpp.

IRCResponseParseResult::IRCResponseParseResult ( const IRCResponseType responseType,
bool  bWasParsed 
)

A valid response result with set type and notification if it was parsed or not.

Parameters
responseTypeType of the parsed response. Please note that this may still be invalid, even if the entire result object is valid.
bWasParsedtrue if IRCResponseParser attempted to parse the message. false if message was completely ignored by the parser.

Definition at line 20 of file ircresponseparseresult.cpp.

Member Function Documentation

const IRCResponseType & IRCResponseParseResult::type ( ) const

Type of the response as defined by IRCResponseType.

If isValid() returns false this will also return an invalid IRCResponseType object.

Definition at line 65 of file ircresponseparseresult.cpp.

bool IRCResponseParseResult::wasParsed ( ) const
inline

true if response message was parsed, false if IRCResponseParser ignored the response.

Definition at line 63 of file ircresponseparseresult.h.


The documentation for this class was generated from the following files: