// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _IFSelect_TransformStandard_HeaderFile #define _IFSelect_TransformStandard_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_DefineHandle_HeaderFile #include #endif #ifndef _Handle_IFSelect_TransformStandard_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Handle_IFSelect_Selection_HeaderFile #include #endif #ifndef _IFSelect_SequenceOfGeneralModifier_HeaderFile #include #endif #ifndef _Handle_Interface_CopyControl_HeaderFile #include #endif #ifndef _IFSelect_Transformer_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Handle_IFSelect_Modifier_HeaderFile #include #endif #ifndef _Handle_Interface_Protocol_HeaderFile #include #endif #ifndef _Handle_Interface_InterfaceModel_HeaderFile #include #endif #ifndef _Handle_Standard_Transient_HeaderFile #include #endif class IFSelect_Selection; class Interface_CopyControl; class IFSelect_Modifier; class Interface_Graph; class Interface_Protocol; class Interface_CheckIterator; class Interface_InterfaceModel; class Interface_CopyTool; class Standard_Transient; class TCollection_AsciiString; //! This class runs transformations made by Modifiers, as
//! the ModelCopier does when it produces files (the same set
//! of Modifiers can then be used, as to transform the starting
//! Model, as at file sending time).
//!
//! First, considering the resulting model, two options :
//! - modifications are made directly on the starting model
//! (OnTheSpot option), or
//! - data are copied by the standard service Copy, only the
//! remaining (not yet sent in a file) entities are copied
//! (StandardCopy option)
//!
//! If a Selection is set, it forces the list of Entities on which
//! the Modifiers are applied. Else, each Modifier is considered
//! its Selection. By default, it is for the whole Model
//!
//! Then, the Modifiers are sequentially applied
//! If at least one Modifier "May Change Graph", or if the option
//! StandardCopy is selected, the graph will be recomputed
//! (by the WorkSession, see method RunTransformer)
//!
//! Remark that a TransformStandard with option StandardCopy
//! and no Modifier at all has the effect of computing the
//! remaining data (those not yet sent in any output file).
//! Moreover, the Protocol is not changed
class IFSelect_TransformStandard : public IFSelect_Transformer { public: //! Creates a TransformStandard, option StandardCopy, no Modifier
Standard_EXPORT IFSelect_TransformStandard(); //! Sets the Copy option to a new value :
//! - True for StandardCopy - False for OnTheSpot
Standard_EXPORT void SetCopyOption(const Standard_Boolean option) ; //! Returns the Copy option
Standard_EXPORT Standard_Boolean CopyOption() const; //! Sets a Selection (or unsets if Null)
//! This Selection then defines the list of entities on which the
//! Modifiers will be applied
//! If it is set, it has priority on Selections of Modifiers
//! Else, for each Modifier its Selection is evaluated
//! By default, all the Model is taken
Standard_EXPORT void SetSelection(const Handle(IFSelect_Selection)& sel) ; //! Returns the Selection, Null by default
Standard_EXPORT Handle_IFSelect_Selection Selection() const; //! Returns the count of recorded Modifiers
Standard_EXPORT Standard_Integer NbModifiers() const; //! Returns a Modifier given its rank in the list
Standard_EXPORT Handle_IFSelect_Modifier Modifier(const Standard_Integer num) const; //! Returns the rank of a Modifier in the list, 0 if unknown
Standard_EXPORT Standard_Integer ModifierRank(const Handle(IFSelect_Modifier)& modif) const; //! Adds a Modifier to the list :
//! - = 0 (default) : at the end of the list
//! - > 0 : at rank
//! Returns True if done, False if is out of range
Standard_EXPORT Standard_Boolean AddModifier(const Handle(IFSelect_Modifier)& modif,const Standard_Integer atnum = 0) ; //! Removes a Modifier from the list
//! Returns True if done, False if not in the list
Standard_EXPORT Standard_Boolean RemoveModifier(const Handle(IFSelect_Modifier)& modif) ; //! Removes a Modifier from the list, given its rank
//! Returns True if done, False if is out of range
Standard_EXPORT Standard_Boolean RemoveModifier(const Standard_Integer num) ; //! Performs the Standard Transformation, by calling Copy then
//! ApplyModifiers (which can return an error status)
Standard_EXPORT Standard_Boolean Perform(const Interface_Graph& G,const Handle(Interface_Protocol)& protocol,Interface_CheckIterator& checks,Handle(Interface_InterfaceModel)& newmod) ; //! This the first operation. It calls StandardCopy or OnTheSpot
//! according the option
Standard_EXPORT void Copy(const Interface_Graph& G,Interface_CopyTool& TC,Handle(Interface_InterfaceModel)& newmod) const; //! This is the standard action of Copy : its takes into account
//! only the remaining entities (noted by Graph Status positive)
//! and their proper dependances of course. Produces a new model.
Standard_EXPORT void StandardCopy(const Interface_Graph& G,Interface_CopyTool& TC,Handle(Interface_InterfaceModel)& newmod) const; //! This is the OnTheSpot action : each entity is bound with ...
//! itself. The produced model is the same as the starting one.
Standard_EXPORT void OnTheSpot(const Interface_Graph& G,Interface_CopyTool& TC,Handle(Interface_InterfaceModel)& newmod) const; //! Applies the modifiers sequencially.
//! For each one, prepares required data (if a Selection is
//! associated as a filter).
//! For the option OnTheSpot, it determines if the graph may be
//! changed and updates if required
//! If a Modifier causes an error (check "HasFailed"),
//! ApplyModifier stops : the following Modifiers are ignored
Standard_EXPORT Standard_Boolean ApplyModifiers(const Interface_Graph& G,const Handle(Interface_Protocol)& protocol,Interface_CopyTool& TC,Interface_CheckIterator& checks,Handle(Interface_InterfaceModel)& newmod) const; //! This methods allows to know what happened to a starting
//! entity after the last Perform. It reads result from the map
//! which was filled by Perform.
Standard_EXPORT Standard_Boolean Updated(const Handle(Standard_Transient)& entfrom,Handle(Standard_Transient)& entto) const; //! Returns a text which defines the way a Transformer works :
//! "On the spot edition" or "Standard Copy" followed by
//! " Modifiers"
Standard_EXPORT TCollection_AsciiString Label() const; DEFINE_STANDARD_RTTI(IFSelect_TransformStandard) protected: private: Standard_Boolean thecopy; Handle_IFSelect_Selection thesel; IFSelect_SequenceOfGeneralModifier themodifs; Handle_Interface_CopyControl themap; }; // other Inline functions and methods (like "C++: function call" methods) #endif