#include <DataError.hpp>
Public Member Functions | |
Construction | |
DataError (unsigned fieldIndex, const IdfObject &object, DataErrorType errorType) | |
Constructor for field-level error. More... | |
DataError (const IdfObject &object, DataErrorType errorType) | |
Constructor for object-level error. More... | |
DataError (DataErrorType errorType) | |
Constructor for collection-level error without a related IddObjectType. More... | |
DataError (DataErrorType errorType, IddObjectType objectType) | |
Constructor for collection-level error with a related IddObjectType. More... | |
Inspection | |
Scope | scope () const |
Returns the scope of the error. More... | |
DataErrorType | type () const |
Returns the enum that describes the error. More... | |
unsigned | fieldIdentifier () const |
Returns the index of the erroneous field, if scope() == Scope::Field, otherwise throws. More... | |
Handle | objectIdentifier () const |
Returns the handle of the erroneous object, if applicable. More... | |
std::string | objectName () const |
Returns the name of the object identified by objectIdentifier(), or an empty string. More... | |
boost::optional< IddObjectType > | objectType () const |
Returns the type of the object identified by objectIdentifier() if the error is field- or object-level; if the error is collection level, the return value will either evaluate to false or be related to a cardinality constraint. More... | |
bool | operator== (const DataError &otherError) const |
Returns true if all data exactly equal. More... | |
bool | operator!= (const DataError &otherError) const |
Negation of operator==. More... | |
Related Functions | |
(Note that these are not member functions.) | |
typedef std::set< DataError, DataErrorLess > | DataErrorSet |
Set container for DataError. More... | |
typedef std::vector< DataError > | DataErrorVector |
std::ostream & | operator<< (std::ostream &os, const DataError &error) |
Ostream operator for DataError. More... | |
typedef boost::optional < DataError > | OptionalDataError |
openstudio::DataError::DataError | ( | unsigned | fieldIndex, |
const IdfObject & | object, | ||
DataErrorType | errorType | ||
) |
Constructor for field-level error.
openstudio::DataError::DataError | ( | const IdfObject & | object, |
DataErrorType | errorType | ||
) |
Constructor for object-level error.
openstudio::DataError::DataError | ( | DataErrorType | errorType | ) |
Constructor for collection-level error without a related IddObjectType.
openstudio::DataError::DataError | ( | DataErrorType | errorType, |
IddObjectType | objectType | ||
) |
Constructor for collection-level error with a related IddObjectType.
unsigned openstudio::DataError::fieldIdentifier | ( | ) | const |
Returns the index of the erroneous field, if scope() == Scope::Field, otherwise throws.
Handle openstudio::DataError::objectIdentifier | ( | ) | const |
Returns the handle of the erroneous object, if applicable.
Otherwise, returned Handle.isNull().
std::string openstudio::DataError::objectName | ( | ) | const |
Returns the name of the object identified by objectIdentifier(), or an empty string.
boost::optional<IddObjectType> openstudio::DataError::objectType | ( | ) | const |
Returns the type of the object identified by objectIdentifier() if the error is field- or object-level; if the error is collection level, the return value will either evaluate to false or be related to a cardinality constraint.
bool openstudio::DataError::operator!= | ( | const DataError & | otherError | ) | const |
Negation of operator==.
bool openstudio::DataError::operator== | ( | const DataError & | otherError | ) | const |
Returns true if all data exactly equal.
Scope openstudio::DataError::scope | ( | ) | const |
Returns the scope of the error.
DataErrorType openstudio::DataError::type | ( | ) | const |
Returns the enum that describes the error.
The .valueDescription() contains a brief description.
|
related |
Set container for DataError.
|
related |
|
related |
Ostream operator for DataError.
|
related |