1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-21 10:13:43 +03:00
occt/src/Transfer/Transfer_ActorOfProcessForTransient.hxx

122 lines
4.2 KiB
C++

// Created on: 1992-02-03
// 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 _Transfer_ActorOfProcessForTransient_HeaderFile
#define _Transfer_ActorOfProcessForTransient_HeaderFile
#include <Standard.hxx>
#include <Standard_Type.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_Transient.hxx>
#include <TColStd_MapTransientHasher.hxx>
#include <TColStd_HSequenceOfTransient.hxx>
#include <Transfer_TransferMapOfProcessForTransient.hxx>
class Standard_DomainError;
class Standard_Transient;
class Transfer_ProcessForTransient;
class Transfer_IteratorOfProcessForTransient;
class Transfer_Binder;
class Transfer_SimpleBinderOfTransient;
class Transfer_ActorOfProcessForTransient;
DEFINE_STANDARD_HANDLE(Transfer_ActorOfProcessForTransient, Standard_Transient)
class Transfer_ActorOfProcessForTransient : public Standard_Transient
{
public:
Standard_EXPORT Transfer_ActorOfProcessForTransient();
//! Prerequesite for Transfer : the method Transfer is
//! called on a starting object only if Recognize has
//! returned True on it
//! This allows to define a list of Actors, each one
//! processing a definite kind of data
//! TransferProcess calls Recognize on each one before
//! calling Transfer. But even if Recognize has returned
//! True, Transfer can reject by returning a Null Binder
//! (afterwards rejection), the next actor is then invoked
//!
//! The provided default returns True, can be redefined
Standard_EXPORT virtual Standard_Boolean Recognize (const Handle(Standard_Transient)& start);
//! Specific action of Transfer. The Result is stored in
//! the returned Binder, or a Null Handle for "No result"
//! (Default defined as doing nothing; should be deffered)
//! "mutable" allows the Actor to record intermediate
//! information, in addition to those of TransferProcess
Standard_EXPORT virtual Handle(Transfer_Binder) Transferring (const Handle(Standard_Transient)& start, const Handle(Transfer_ProcessForTransient)& TP);
//! Prepares and Returns a Binder for a Transient Result
//! Returns a Null Handle if <res> is itself Null
Standard_EXPORT Handle(Transfer_SimpleBinderOfTransient) TransientResult (const Handle(Standard_Transient)& res) const;
//! Returns a Binder for No Result, i.e. a Null Handle
Standard_EXPORT Handle(Transfer_Binder) NullResult() const;
//! If <mode> is True, commands an Actor to be set at the
//! end of the list of Actors (see SetNext)
//! If it is False (creation default), each add Actor is
//! set at the beginning of the list
//! This allows to define default Actors (which are Last)
Standard_EXPORT void SetLast (const Standard_Boolean mode = Standard_True);
//! Returns the Last status (see SetLast).
Standard_EXPORT Standard_Boolean IsLast() const;
//! Defines a Next Actor : it can then be asked to work if
//! <me> produces no result for a given type of Object.
//! If Next is already set and is not "Last", calls
//! SetNext on it. If Next defined and "Last", the new
//! actor is added before it in the list
Standard_EXPORT void SetNext (const Handle(Transfer_ActorOfProcessForTransient)& next);
//! Returns the Actor defined as Next, or a Null Handle
Standard_EXPORT Handle(Transfer_ActorOfProcessForTransient) Next() const;
DEFINE_STANDARD_RTTI_INLINE(Transfer_ActorOfProcessForTransient,Standard_Transient)
protected:
private:
Handle(Transfer_ActorOfProcessForTransient) thenext;
Standard_Boolean thelast;
};
#endif // _Transfer_ActorOfProcessForTransient_HeaderFile