mip::CompositeResult Class Reference

Represents a list of zero or more actions and their results. More...

#include <composite_result.hpp>

Classes
struct	Entry

Public Member Functions
	CompositeResult ()=default
	CompositeResult (bool success)
	CompositeResult (CmdResult result)
	CompositeResult (CompositeDescriptor cmd, CmdResult result)
	CompositeResult (const Entry &result)
bool	isEmpty () const
bool	notEmpty () const
size_t	count () const
bool	allSuccessful () const
bool	allFailed () const
bool	anySuccessful () const
bool	anyFailed () const
bool	noneSuccessful () const
bool	noneFailed () const
bool	allMatch (CmdResult result) const
bool	anyMatch (CmdResult result) const
bool	noneMatch (CmdResult result) const
	operator bool () const
bool	operator! () const
CmdResult	summary () const
void	clear ()
void	append (CmdResult result, CompositeDescriptor desc=0x0000)
void	append (Entry result)
template<class MipType >
void	append (CmdResult result, uint16_t index=0)
void	extend (const CompositeResult &other)
CompositeResult &	operator+= (bool result)
CompositeResult &	operator+= (CmdResult result)
CompositeResult &	operator+= (Entry result)
bool	appendAndCheckThisCmd (bool result, uint32_t id)
bool	appendAndCheckThisCmd (CmdResult result, CompositeDescriptor desc)
bool	appendAndCheckThisCmd (Entry result)
const Entry &	first () const
Entry &	first ()
const Entry &	last () const
Entry &	last ()
CmdResult	firstResult () const
CmdResult	lastResult () const
std::vector< Entry >::iterator	begin ()
std::vector< Entry >::iterator	end ()
std::vector< Entry >::const_iterator	begin () const
std::vector< Entry >::const_iterator	end () const

Detailed Description

Represents a list of zero or more actions and their results.

Constructor & Destructor Documentation

CompositeResult() [1/5]

mip::CompositeResult::CompositeResult ( )

default

CompositeResult() [2/5]

mip::CompositeResult::CompositeResult ( bool  success )

inline

CompositeResult() [3/5]

mip::CompositeResult::CompositeResult ( CmdResult  result )

inline

CompositeResult() [4/5]

mip::CompositeResult::CompositeResult ( CompositeDescriptor  cmd, CmdResult  result  )

inline

CompositeResult() [5/5]

mip::CompositeResult::CompositeResult ( const Entry &  result )

inline

Member Function Documentation

allFailed()

bool mip::CompositeResult::allFailed ( ) const

inline

allMatch()

bool mip::CompositeResult::allMatch ( CmdResult  result ) const

inline

allSuccessful()

bool mip::CompositeResult::allSuccessful ( ) const

inline

anyFailed()

bool mip::CompositeResult::anyFailed ( ) const

inline

anyMatch()

bool mip::CompositeResult::anyMatch ( CmdResult  result ) const

inline

anySuccessful()

bool mip::CompositeResult::anySuccessful ( ) const

inline

append() [1/3]

void mip::CompositeResult::append ( CmdResult  result, CompositeDescriptor  desc = 0x0000  )

inline

append() [2/3]

template<class MipType >

void mip::CompositeResult::append ( CmdResult  result, uint16_t  index = 0  )

inline

append() [3/3]

void mip::CompositeResult::append ( Entry  result )

inline

appendAndCheckThisCmd() [1/3]

bool mip::CompositeResult::appendAndCheckThisCmd ( bool  result, uint32_t  id  )

inline

appendAndCheckThisCmd() [2/3]

bool mip::CompositeResult::appendAndCheckThisCmd ( CmdResult  result, CompositeDescriptor  desc  )

inline

appendAndCheckThisCmd() [3/3]

bool mip::CompositeResult::appendAndCheckThisCmd ( Entry  result )

inline

begin() [1/2]

std::vector<Entry>::iterator mip::CompositeResult::begin ( )

inline

begin() [2/2]

std::vector<Entry>::const_iterator mip::CompositeResult::begin ( ) const

inline

clear()

void mip::CompositeResult::clear ( )

inline

count()

size_t mip::CompositeResult::count ( ) const

inline

end() [1/2]

std::vector<Entry>::iterator mip::CompositeResult::end ( )

inline

end() [2/2]

std::vector<Entry>::const_iterator mip::CompositeResult::end ( ) const

inline

extend()

void mip::CompositeResult::extend ( const CompositeResult &  other )

inline

first() [1/2]

Entry& mip::CompositeResult::first ( )

inline

first() [2/2]

const Entry& mip::CompositeResult::first ( ) const

inline

firstResult()

CmdResult mip::CompositeResult::firstResult ( ) const

inline

isEmpty()

bool mip::CompositeResult::isEmpty ( ) const

inline

last() [1/2]

Entry& mip::CompositeResult::last ( )

inline

last() [2/2]

const Entry& mip::CompositeResult::last ( ) const

inline

lastResult()

CmdResult mip::CompositeResult::lastResult ( ) const

inline

noneFailed()

bool mip::CompositeResult::noneFailed ( ) const

inline

noneMatch()

bool mip::CompositeResult::noneMatch ( CmdResult  result ) const

inline

noneSuccessful()

bool mip::CompositeResult::noneSuccessful ( ) const

inline

notEmpty()

bool mip::CompositeResult::notEmpty ( ) const

inline

operator bool()

mip::CompositeResult::operator bool ( ) const

inline

operator!()

bool mip::CompositeResult::operator! ( ) const

inline

operator+=() [1/3]

CompositeResult& mip::CompositeResult::operator+= ( bool  result )

inline

operator+=() [2/3]

CompositeResult& mip::CompositeResult::operator+= ( CmdResult  result )

inline

operator+=() [3/3]

CompositeResult& mip::CompositeResult::operator+= ( Entry  result )

inline

summary()

CmdResult mip::CompositeResult::summary ( ) const

inline

---

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

• src/cpp/mip/extras/composite_result.hpp