MeVisLabToolboxReference
ml::BaseItemParser Class Reference

Parser class for BaseItem strings, containing an object's id and name. More...

#include <mlBaseItemParser.h>

Inheritance diagram for ml::BaseItemParser:
ml::ParserBase

List of all members.

Public Types

enum  { kInvalidType = kNumBaseErrorCodes, kNumBaseItemErrorCodes }
 Error codes. More...

Public Member Functions

 BaseItemParser ()
 Constructor.
int getId (MLssize_t &id)
 Parse and return object id.
int getName (std::string &name)
 Parse and return object name.
virtual const char * getErrorMessage (int errorCode)
 Get error string for errorCode.

Detailed Description

Parser class for BaseItem strings, containing an object's id and name.

The strings use the following syntax: ['#'id][[:]name] id = integer name = string

Definition at line 39 of file mlBaseItemParser.h.


Member Enumeration Documentation

anonymous enum

Error codes.

Enumerator:
kInvalidType 
kNumBaseItemErrorCodes 

Highest error code +1, not to be used as error code enumerator!

Definition at line 56 of file mlBaseItemParser.h.


Constructor & Destructor Documentation

ml::BaseItemParser::BaseItemParser ( ) [inline]

Constructor.

Definition at line 44 of file mlBaseItemParser.h.


Member Function Documentation

virtual const char* ml::BaseItemParser::getErrorMessage ( int  errorCode) [virtual]

Get error string for errorCode.

Reimplemented from ml::ParserBase.

int ml::BaseItemParser::getId ( MLssize_t id)

Parse and return object id.

int ml::BaseItemParser::getName ( std::string &  name)

Parse and return object name.


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