casegenerated.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Ondrej Starek
 *
 * This file is part of OTest2.
 *
 * OTest2 is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OTest2 is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with OTest2.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef OTest2INCLUDE_CASEGENERATED_H_
#define OTest2INCLUDE_CASEGENERATED_H_
 
#include <string>
 
#include <otest2/caseordinary.h>
#include <otest2/contextobject.h>
#include <otest2/fcemarshalerptr.h>
#include <otest2/stateptr.h>
 
namespace OTest2 {
 
class Context;
 
class CaseGenerated : public CaseOrdinary, public ContextObject {
  private:
    struct Impl;
    Impl* pimpl;
 
  public:
    /* -- avoid copying */
    CaseGenerated(
        const CaseGenerated&) = delete;
    CaseGenerated& operator =(
        const CaseGenerated&) = delete;
 
    explicit CaseGenerated(
        const Context& context_,
        const std::string& name_);
 
    virtual ~CaseGenerated();
 
    /* -- object interface */
    virtual std::string getName() const;
 
    /* -- scenario object */
    virtual bool startUpObject(
        const Context& context_,
        int index_) override;
    virtual void scheduleBody(
        const Context& context_,
        ScenarioPtr scenario_,
        ObjectPtr me_) override;
    virtual void tearDownObject(
        const Context& context_,
        int index_) override;
 
    /* -- ordinary case */
    virtual StatePtr getFirstState() const override;
    virtual StatePtr getState(
        const std::string& name_) const override;
 
    /* -- context object */
    virtual const Context& otest2Context() const;
 
  protected:
    void registerState(
        const std::string& name_,
        StatePtr state_);
 
    void setEnteringState(
        const std::string& name_);
 
    void registerFixture(
        FceMarshalerPtr start_up_,
        FceMarshalerPtr tear_down_);
};
 
} /* -- namespace OTest2 */
 
#endif /* -- OTest2INCLUDE_CASEGENERATED_H_ */