SpecsCpp::SpecRunResult Class Reference

#include <SpecRunResult.h>

Inheritance diagram for SpecsCpp::SpecRunResult:

Public Member Functions
	SpecRunResult (ISpecComponent *component, ISpecGroup *group, ISpec *spec, RunResultStatus status, std::string_view message="")
RunResultStatus	status () const override
const char *	message () const override
ISpecComponent *	component () const override
ISpec *	spec () const override
ISpecGroup *	group () const override
ISpecRunResult *	copy () const override
Public Member Functions inherited from SpecsCpp::ISpecRunResult
virtual	~ISpecRunResult ()=default
virtual ISpecComponent *	component () const =0
virtual ISpecGroup *	group () const =0
virtual ISpec *	spec () const =0
virtual RunResultStatus	status () const =0
virtual const char *	message () const =0
virtual ISpecRunResult *	copy () const =0
virtual const char *	status_as_string () const

Static Public Member Functions
static std::unique_ptr< SpecRunResult >	passed (ISpecComponent *component, ISpecGroup *group, ISpec *spec)
static std::unique_ptr< SpecRunResult >	failed (ISpecComponent *component, ISpecGroup *group, ISpec *spec, std::string_view message="")
static std::unique_ptr< SpecRunResult >	not_run (ISpecComponent *component, ISpecGroup *group, ISpec *spec)
static std::unique_ptr< SpecRunResult >	timeout (ISpecComponent *component, ISpecGroup *group, ISpec *spec)

Detailed Description

Definition at line 11 of file SpecRunResult.h.

Constructor & Destructor Documentation

SpecRunResult()

SpecsCpp::SpecRunResult::SpecRunResult ( ISpecComponent *  component, ISpecGroup *  group, ISpec *  spec, RunResultStatus  status, std::string_view  message = ""  )

inline

Definition at line 19 of file SpecRunResult.h.

            : _component(component),
              _group(group),
              _spec(spec),
              _status(status),
              _message(message) {}

Member Function Documentation

component()

ISpecComponent * SpecsCpp::SpecRunResult::component ( ) const

inlineoverridevirtual

Implements SpecsCpp::ISpecRunResult.

Definition at line 31 of file SpecRunResult.h.

{ return _component; }

Referenced by failed(), not_run(), passed(), and timeout().

copy()

ISpecRunResult * SpecsCpp::SpecRunResult::copy ( ) const

inlineoverridevirtual

Implements SpecsCpp::ISpecRunResult.

Definition at line 35 of file SpecRunResult.h.

                                              {
            return new SpecRunResult(_component, _group, _spec, _status, _message);
        }

failed()

static std::unique_ptr< SpecRunResult > SpecsCpp::SpecRunResult::failed ( ISpecComponent *  component, ISpecGroup *  group, ISpec *  spec, std::string_view  message = ""  )

inlinestatic

Definition at line 45 of file SpecRunResult.h.

          {
            return std::make_unique<SpecRunResult>(
                component, group, spec, RunResultStatus::Failed, message
            );
        }

Referenced by SpecsCpp::SpecCodeBlock::run().

group()

ISpecGroup * SpecsCpp::SpecRunResult::group ( ) const

inlineoverridevirtual

Implements SpecsCpp::ISpecRunResult.

Definition at line 33 of file SpecRunResult.h.

{ return _group; }

Referenced by failed(), not_run(), passed(), and timeout().

message()

const char * SpecsCpp::SpecRunResult::message ( ) const

inlineoverridevirtual

Implements SpecsCpp::ISpecRunResult.

Definition at line 30 of file SpecRunResult.h.

{ return _message.c_str(); }

Referenced by failed().

not_run()

static std::unique_ptr< SpecRunResult > SpecsCpp::SpecRunResult::not_run ( ISpecComponent *  component, ISpecGroup *  group, ISpec *  spec  )

inlinestatic

Definition at line 53 of file SpecRunResult.h.

          {
            return std::make_unique<SpecRunResult>(component, group, spec, RunResultStatus::NotRun);
        }

passed()

static std::unique_ptr< SpecRunResult > SpecsCpp::SpecRunResult::passed ( ISpecComponent *  component, ISpecGroup *  group, ISpec *  spec  )

inlinestatic

Definition at line 39 of file SpecRunResult.h.

          {
            return std::make_unique<SpecRunResult>(component, group, spec, RunResultStatus::Passed);
        }

Referenced by SpecsCpp::SpecCodeBlock::run().

spec()

ISpec * SpecsCpp::SpecRunResult::spec ( ) const

inlineoverridevirtual

Implements SpecsCpp::ISpecRunResult.

Definition at line 32 of file SpecRunResult.h.

{ return _spec; }

Referenced by failed(), not_run(), passed(), and timeout().

status()

RunResultStatus SpecsCpp::SpecRunResult::status ( ) const

inlineoverridevirtual

Implements SpecsCpp::ISpecRunResult.

Definition at line 29 of file SpecRunResult.h.

{ return _status; }

timeout()

static std::unique_ptr< SpecRunResult > SpecsCpp::SpecRunResult::timeout ( ISpecComponent *  component, ISpecGroup *  group, ISpec *  spec  )

inlinestatic

Definition at line 59 of file SpecRunResult.h.

          {
            return std::make_unique<SpecRunResult>(
                component, group, spec, RunResultStatus::Timeout, "Timeout"
            );
        }

Referenced by SpecsCpp::SpecCodeBlock::run().

---

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

• Specs.Implementations/include/Specs/SpecRunResult.h