Diagnostic for the most recent parseRuleText() rejection. More...

#include <Controls.hpp>

Collaboration diagram for openswmm::controls::ParseError:

Public Attributes
int	line = -1
	1-based line in the submitted text; -1 if unknown

std::string	message
	Human-readable reason for the rejection.

int	code = 0
	Legacy error code for the same rejection.

std::string	token
	Offending token legacy names in its message.

Detailed Description

Diagnostic for the most recent parseRuleText() rejection.

line is 1-based and indexes the original rule text, counting blank lines, so it can be shown directly against what the caller submitted. Both fields are only meaningful after parseRuleText() returns < 0.

Member Data Documentation

◆ code

int openswmm::controls::ParseError::code = 0

Legacy error code for the same rejection.

◆ line

int openswmm::controls::ParseError::line = -1

1-based line in the submitted text; -1 if unknown

◆ message

std::string openswmm::controls::ParseError::message

Human-readable reason for the rejection.

◆ token

std::string openswmm::controls::ParseError::token

Offending token legacy names in its message.

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