GEOS
Public Types | Public Member Functions | List of all members
geos::TableErrorListing Class Reference

Class for retrieving errors in the table classes. More...

#include <TableTypes.hpp>

Public Types

using Iterator = std::vector< string >::const_iterator
 The iterator alias for the errors vector of string.
 

Public Member Functions

void addError (string_view text)
 Add an error that will be display at the end of the table. More...
 
bool hasErrors () const
 
void clear ()
 Clear all error when calling toString()
 
Iterator begin () const
 
Iterator end () const
 
void appendErrors (std::vector< string > &errors)
 Append a vector of string to the errors vector. More...
 
std::vector< string > const & getErrors () const
 
std::vector< string > & getErrors ()
 

Detailed Description

Class for retrieving errors in the table classes.

Definition at line 44 of file TableTypes.hpp.

Member Function Documentation

◆ addError()

void geos::TableErrorListing::addError ( string_view  text)
inline

Add an error that will be display at the end of the table.

Parameters
textThe string error to display.

Definition at line 103 of file TableTypes.hpp.

◆ appendErrors()

void geos::TableErrorListing::appendErrors ( std::vector< string > &  errors)
inline

Append a vector of string to the errors vector.

Parameters
errorsA vector of string to append

Definition at line 83 of file TableTypes.hpp.

◆ begin()

Iterator geos::TableErrorListing::begin ( ) const
inline
Returns
An Iterator pointing to the first element of the errors vector

Definition at line 70 of file TableTypes.hpp.

◆ end()

Iterator geos::TableErrorListing::end ( ) const
inline
Returns
An Iterator pointing to the last element of the errors vector

Definition at line 76 of file TableTypes.hpp.

◆ getErrors() [1/2]

std::vector< string >& geos::TableErrorListing::getErrors ( )
inline
Returns
A reference to the errors vector.

Definition at line 95 of file TableTypes.hpp.

◆ getErrors() [2/2]

std::vector< string > const& geos::TableErrorListing::getErrors ( ) const
inline
Returns
A const reference to the errors vector.

Definition at line 89 of file TableTypes.hpp.

◆ hasErrors()

bool geos::TableErrorListing::hasErrors ( ) const
inline
Returns
true if an error has already been added

Definition at line 106 of file TableTypes.hpp.


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