Common implementation of a generated test case. More...

#include <casegenerated.h>

Inheritance diagram for OTest2::CaseGenerated:

[legend]

Collaboration diagram for OTest2::CaseGenerated:

[legend]

Classes
struct	Impl

Public Member Functions
	CaseGenerated (const CaseGenerated &)=delete

CaseGenerated &	operator= (const CaseGenerated &)=delete

	CaseGenerated (const Context &context_, const std::string &name_)
	Ctor. More...

virtual	~CaseGenerated ()
	Dtor. More...

virtual std::string	getName () const
	Get object's name. More...

virtual bool	startUpObject (const Context &context_, int index_) override
	Execute start-up function at specified index. More...

virtual void	scheduleBody (const Context &context_, ScenarioPtr scenario_, ObjectPtr me_) override
	Schedule body of the testing object. More...

virtual void	tearDownObject (const Context &context_, int index_) override
	Execute tear-down function at specified index. More...

virtual StatePtr	getFirstState () const override
	Get the initial state. More...

virtual StatePtr	getState (const std::string &name_) const override
	Get state with specified name_. More...

virtual const Context &	otest2Context () const
	Get the OTest2 context. More...

Public Member Functions inherited from OTest2::CaseOrdinary
	CaseOrdinary (const CaseOrdinary &)=delete

CaseOrdinary &	operator= (const CaseOrdinary &)=delete

	CaseOrdinary (const Context &context_)
	Ctor. More...

virtual	~CaseOrdinary ()
	Dtor. More...

Public Member Functions inherited from OTest2::Case
	Case ()
	Ctor. More...

virtual	~Case ()
	Dtor. More...

	Case (const Case &)=delete

Case &	operator= (const Case &)=delete

Public Member Functions inherited from OTest2::ObjectScenario
	ObjectScenario ()
	Dtor. More...

virtual	~ObjectScenario ()
	Dtor. More...

	ObjectScenario (const ObjectScenario &)=delete

ObjectScenario &	operator= (const ObjectScenario &)=delete

Public Member Functions inherited from OTest2::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object ()
	Ctor. More...

virtual	~Object ()
	Dtor. More...

Public Member Functions inherited from OTest2::ContextObject
	ContextObject (const ContextObject &)=delete

ContextObject &	operator= (const ContextObject &)=delete

	ContextObject ()
	Ctor. More...

virtual	~ContextObject ()
	Dtor. More...

Protected Member Functions
void	registerState (const std::string &name_, StatePtr state_)
	Register new test state. More...

void	setEnteringState (const std::string &name_)
	Set name of the entering (first) state. More...

void	registerFixture (FceMarshalerPtr start_up_, FceMarshalerPtr tear_down_)
	Register a pair of start-up and tear-down functions. More...

Detailed Description

Common implementation of a generated test case.

Definition at line 37 of file casegenerated.h.

Constructor & Destructor Documentation

◆ CaseGenerated() [1/2]

OTest2::CaseGenerated::CaseGenerated ( const CaseGenerated & )

delete

◆ CaseGenerated() [2/2]

OTest2::CaseGenerated::CaseGenerated	(	const Context &	context_,
		const std::string &	name_
	)

explicit

Ctor.

Parameters

context_	OTest2 context
name_	Name of the test case

Definition at line 80 of file casegenerated.cpp.

◆ ~CaseGenerated()

OTest2::CaseGenerated::~CaseGenerated ( )

virtual

Dtor.

Definition at line 88 of file casegenerated.cpp.

Member Function Documentation

◆ getFirstState()

StatePtr OTest2::CaseGenerated::getFirstState ( ) const

overridevirtual

Get the initial state.

Returns: The state or nullptr if the case doesn't contain any one.

Implements OTest2::CaseOrdinary.

Definition at line 130 of file casegenerated.cpp.

◆ getName()

std::string OTest2::CaseGenerated::getName ( ) const

virtual

Get object's name.

Implements OTest2::Object.

Definition at line 92 of file casegenerated.cpp.

◆ getState()

StatePtr OTest2::CaseGenerated::getState ( const std::string & name_ ) const

overridevirtual

Get state with specified name_.

Parameters

name_ Name of the state

Returns: The state or null pointer

Implements OTest2::CaseOrdinary.

Definition at line 134 of file casegenerated.cpp.

◆ operator=()

CaseGenerated& OTest2::CaseGenerated::operator= ( const CaseGenerated & )

delete

◆ otest2Context()

const Context & OTest2::CaseGenerated::otest2Context ( ) const

virtual

Get the OTest2 context.

Implements OTest2::ContextObject.

Definition at line 139 of file casegenerated.cpp.

◆ registerFixture()

void OTest2::CaseGenerated::registerFixture	(	FceMarshalerPtr	start_up_,
		FceMarshalerPtr	tear_down_
	)

protected

Register a pair of start-up and tear-down functions.

Definition at line 154 of file casegenerated.cpp.

◆ registerState()

void OTest2::CaseGenerated::registerState	(	const std::string &	name_,
		StatePtr	state_
	)

protected

Register new test state.

Parameters

name_	Name of the state
state_	The state

Definition at line 143 of file casegenerated.cpp.

◆ scheduleBody()

void OTest2::CaseGenerated::scheduleBody	(	const Context &	context_,
		ScenarioPtr	scenario_,
		ObjectPtr	me_
	)

overridevirtual

Schedule body of the testing object.

Parameters

context_	The OTest2 context
scenario_	The scenario representing this object
me_	A shared pointer pointing this instance

Implements OTest2::ObjectScenario.

Definition at line 109 of file casegenerated.cpp.

◆ setEnteringState()

void OTest2::CaseGenerated::setEnteringState ( const std::string & name_ )

protected

Set name of the entering (first) state.

Parameters

name_ The name

Definition at line 149 of file casegenerated.cpp.

◆ startUpObject()

bool OTest2::CaseGenerated::startUpObject	(	const Context &	context_,
		int	index_
	)

overridevirtual

Execute start-up function at specified index.

Parameters

context_	The OTest2 context
index_	The zero based index of the start-up function

Returns: True if the start-up function exists and has been run

Implements OTest2::ObjectScenario.

Definition at line 96 of file casegenerated.cpp.

◆ tearDownObject()

void OTest2::CaseGenerated::tearDownObject	(	const Context &	context_,
		int	index_
	)

overridevirtual

Execute tear-down function at specified index.

Parameters

context_	The OTest2 context
index_	The zero based index of the tear-down function

Implements OTest2::ObjectScenario.

Definition at line 120 of file casegenerated.cpp.

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

include/otest2/casegenerated.h
lib/casegenerated.cpp

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CaseGenerated() [1/2]

◆ CaseGenerated() [2/2]

◆ ~CaseGenerated()

Member Function Documentation

◆ getFirstState()

◆ getName()

◆ getState()

◆ operator=()

◆ otest2Context()

◆ registerFixture()

◆ registerState()

◆ scheduleBody()

◆ setEnteringState()

◆ startUpObject()

◆ tearDownObject()