maliput
ComparisonResult< T > Struct Template Reference

Detailed Description

template<typename T>
struct maliput::common::ComparisonResult< T >

ComparisonResult is a struct that holds the result of a comparison between two objects of type T.

  • If the objects are equal, then message is empty.
  • If the objects are not equal, then message contains a string describing the difference. Used as return type by compare methods in maliput.
    Template Parameters
    TThe type of the objects being compared.
    Returns
    A ComparisonResult<T> object.

#include <include/maliput/common/compare.h>

Public Attributes

std::optional< std::string > message
 

Member Data Documentation

◆ message

std::optional<std::string> message

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