https://mooseframework.inl.gov
Public Member Functions | Public Attributes | List of all members
moose::internal::SolutionInvalidityInfo Class Reference

Helper class that stores the info associated with an invalid solution. More...

#include <SolutionInvalidityRegistry.h>

Inheritance diagram for moose::internal::SolutionInvalidityInfo:
[legend]

Public Member Functions

 SolutionInvalidityInfo (const std::string &object_type, const std::string &message, const InvalidSolutionID id, const bool warning)
 
bool operator== (const SolutionInvalidityName &other) const
 

Public Attributes

InvalidSolutionID id
 The solution ID. More...
 
bool warning
 Whether or not this is a warning. More...
 
std::string object_type
 The type of the object. More...
 
std::string message
 The invalid message. More...
 

Detailed Description

Helper class that stores the info associated with an invalid solution.

Definition at line 71 of file SolutionInvalidityRegistry.h.

Constructor & Destructor Documentation

◆ SolutionInvalidityInfo()

moose::internal::SolutionInvalidityInfo::SolutionInvalidityInfo ( const std::string &  object_type,
const std::string &  message,
const InvalidSolutionID  id,
const bool  warning 
)
inline

Definition at line 74 of file SolutionInvalidityRegistry.h.

79  {
80  }
SolutionInvalidityName(const std::string &object_type, const std::string &message)
bool warning
Whether or not this is a warning.
std::string object_type
The type of the object.

Member Function Documentation

◆ operator==()

bool moose::internal::SolutionInvalidityName::operator== ( const SolutionInvalidityName other) const
inlineinherited

Definition at line 42 of file SolutionInvalidityRegistry.h.

43  {
44  return object_type == other.object_type && message == other.message;
45  }
std::string object_type
The type of the object.

Member Data Documentation

◆ id

InvalidSolutionID moose::internal::SolutionInvalidityInfo::id

The solution ID.

Definition at line 83 of file SolutionInvalidityRegistry.h.

◆ message

std::string moose::internal::SolutionInvalidityName::message
inherited

The invalid message.

Definition at line 50 of file SolutionInvalidityRegistry.h.

Referenced by moose::internal::SolutionInvalidityName::operator==().

◆ object_type

std::string moose::internal::SolutionInvalidityName::object_type
inherited

The type of the object.

Definition at line 48 of file SolutionInvalidityRegistry.h.

Referenced by moose::internal::SolutionInvalidityName::operator==().

◆ warning

bool moose::internal::SolutionInvalidityInfo::warning

Whether or not this is a warning.

Definition at line 85 of file SolutionInvalidityRegistry.h.


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