0031501: Foundation Classes, Message_Printer - remove theToPutEndl argument -- prepar...

[occt.git] / src / StepData / StepData_FileRecognizer.hxx

// Created on: 1992-02-11
// Created by: Christian CAILLET
// Copyright (c) 1992-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _StepData_FileRecognizer_HeaderFile
#define _StepData_FileRecognizer_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <Standard_Boolean.hxx>
#include <Standard_Transient.hxx>
class Standard_Transient;
class Standard_NoSuchObject;
class TCollection_AsciiString;


class StepData_FileRecognizer;
DEFINE_STANDARD_HANDLE(StepData_FileRecognizer, Standard_Transient)


class StepData_FileRecognizer : public Standard_Transient
{

public:

  
  //! Evaluates if recognition has a result, returns it if yes
  //! In case of success, Returns True and puts result in "res"
  //! In case of Failure, simply Returns False
  //! Works by calling deferred method Eval, and in case of failure,
  //! looks for Added Recognizers to work
  Standard_EXPORT Standard_Boolean Evaluate (const TCollection_AsciiString& akey, Handle(Standard_Transient)& res);
  
  //! Returns result of last recognition (call of Evaluate)
  Standard_EXPORT Handle(Standard_Transient) Result() const;
  
  //! Adds a new Recognizer to the Compound, at the end
  //! Several calls to Add work by adding in the order of calls :
  //! Hence, when Eval has failed to recognize, Evaluate will call
  //! Evaluate from the first added Recognizer if there is one,
  //! and to the second if there is still no result, and so on
  Standard_EXPORT void Add (const Handle(StepData_FileRecognizer)& reco);




  DEFINE_STANDARD_RTTI_INLINE(StepData_FileRecognizer,Standard_Transient)

protected:

  
  //! Assumes that no result has yet been recognized
  Standard_EXPORT StepData_FileRecognizer();
  
  //! Records the result of the recognition. Called by specific
  //! method Eval to record a result : after calling it, Eval has
  //! finished and can return
  Standard_EXPORT void SetOK (const Handle(Standard_Transient)& aresult);
  
  //! Records that recognition gives no result
  Standard_EXPORT void SetKO();
  
  //! THIS METHOD DEFINES THE RECOGNITION PROTOCOL, it is proper to
  //! each precise type of Recognizer
  //! For a suitable type of akey, it calls SetOK(result) where
  //! result is an empty result of appropriate type, then returns
  Standard_EXPORT virtual void Eval (const TCollection_AsciiString& akey) = 0;



private:


  Handle(Standard_Transient) theres;
  Standard_Boolean hasnext;
  Handle(StepData_FileRecognizer) thenext;


};







#endif // _StepData_FileRecognizer_HeaderFile