/*
 * AbstractLtlFormula.h
 *
 *  Created on: 15.04.2013
 *      Author: thomas
 */

#ifndef STORM_LTL_ABSTRACTLTLFORMULA_H_
#define STORM_LTL_ABSTRACTLTLFORMULA_H_

#include <vector>
#include "src/modelchecker/ltl/ForwardDeclarations.h"
#include "src/formula/abstract/AbstractFormula.h"

// Forward declaration for formula visitor
namespace storm {
namespace property {
namespace ltl {

template <class T>
class AbstractLtlFormula;

}
}
}

#include "visitor/AbstractLtlFormulaVisitor.h"


namespace storm {
namespace property {
namespace ltl {

/*!
 * Interface class for all LTL root formulas.
 */
template <class T>
class AbstractLtlFormula : public virtual storm::property::abstract::AbstractFormula<T> {
public:
	/**
	 * Empty destructor
	 */
	virtual ~AbstractLtlFormula() {
		// Intentionally left empty
	}

	/*!
	 * Calls the model checker to check this formula.
	 * Needed to infer the correct type of formula class.
	 *
	 * @note This function should only be called in a generic check function of a model checker class. For other uses,
	 *       the methods of the model checker should be used.
	 *
	 * @note This function is not implemented in this class.
	 *
	 * @returns A vector indicating the probability that the formula holds for each state.
	 */
	virtual std::vector<T>* check(const storm::modelchecker::ltl::AbstractModelChecker<T>& modelChecker) const = 0;

	/*!
	 * Clones the called object.
	 *
	 * Performs a "deep copy", i.e. the subtrees of the new object are clones of the original ones
	 *
	 * @returns a new AND-object that is identical the called object.
	 */
	virtual AbstractLtlFormula<T>* clone() const = 0;

	/*!
	 *	@brief Visits all nodes of a formula tree.
	 *
	 *	@note Every subclass must implement this method.
	 *
	 *	This method is given a visitor that visits each node to perform some
	 *	task on it (e.g. Validity checks, conversion, ...). The subclasses are to
	 *
	 *
	 *
	 *	@param visitor The visitor object.
	 *	@return true iff all subtrees are valid.
	 */
	virtual void visit(const visitor::AbstractLtlFormulaVisitor<T>& visitor) const = 0;
};

} /* namespace ltl */
} /* namespace property */
} /* namespace storm */
#endif /* STORM_LTL_ABSTRACTLTLFORMULA_H_ */