Files
OCCT/src/IFSelect/IFSelect_Transformer.cdl
abv 6e33d3ced2 0024830: Remove redundant keyword 'mutable' in CDL declarations
Redundant keyword 'mutable' removed in CDL files.
In IGESConvGeom_GeomBuilder, unused methods MakeXY() and MakeXYZ() removed.
Method StepAP214_AutoDesignGroupAssignment::Init() replicating same method of the base class is removed as it causes CDL extraction error after above (seemingly irrelevant) changes.
2014-05-29 14:58:25 +04:00

88 lines
4.5 KiB
Plaintext

-- Created on: 1994-05-27
-- Created by: Christian CAILLET
-- Copyright (c) 1994-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.
deferred class Transformer from IFSelect inherits TShared
---Purpose : A Transformer defines the way an InterfaceModel is transformed
-- (without sending it to a file).
-- In order to work, each type of Transformer defines it method
-- Perform, it can be parametred as needed.
--
-- It receives a Model (the data set) as input. It then can :
-- - edit this Model on the spot (i.e. alter its content : by
-- editing entities, or adding/replacing some ...)
-- - produce a copied Model, which detains the needed changes
-- (typically on the same type, but some or all entities beeing
-- rebuilt or converted; or converted from a protocol to
-- another one)
uses AsciiString from TCollection,
CheckIterator, Graph, Protocol from Interface, InterfaceModel
is
Perform (me : mutable; G : Graph; protocol : Protocol from Interface;
checks : in out CheckIterator;
newmod : out InterfaceModel) returns Boolean is deferred;
---Purpose : Performs a Transformation (defined by each sub-class) :
-- <G> gives the input data (especially the starting model) and
-- can be used for queries (by Selections, etc...)
-- <protocol> allows to work with General Services as necessary
-- (it applies to input data)
-- If the change corresponds to a conversion to a new protocol,
-- see also the method ChangeProtocol
-- <checks> stores produced checks messages if any
-- <newmod> gives the result of the transformation :
-- - if it is Null (i.e. has not been affected), the transformation
-- has been made on the spot, it is assumed to cause no change
-- to the graph of dependances
-- - if it equates the starting Model, it has been transformed on
-- the spot (possibiliy some entities were replaced inside it)
-- - if it is new, it corresponds to a new data set which replaces
-- the starting one
--
-- <me> is mutable to allow results for ChangeProtocol to be
-- memorized if needed, and to store informations useful for
-- the method Updated
--
-- Returns True if Done, False if an Error occured : in this case,
-- if a new data set has been produced, the transformation
-- is ignored, else data may be corrupted.
ChangeProtocol (me; newproto : in out Protocol from Interface)
returns Boolean is virtual;
---Purpose : This methods allows to declare that the Protocol applied to
-- the new Model has changed. It applies to the last call to
-- Perform.
--
-- Returns True if the Protocol has changed, False else.
-- The provided default keeps the starting Protocol. This method
-- should be redefined as required by the effect of Perform.
Updated (me; entfrom : Transient; entto : out Transient)
returns Boolean is deferred;
---Purpose : This method allows to know what happened to a starting
-- entity after the last Perform. If <entfrom> (from starting
-- model) has one and only one known item which corresponds in
-- the new produced model, this method must return True and
-- fill the argument <entto>. Else, it returns False.
Label (me) returns AsciiString from TCollection is deferred;
---Purpose : Returns a text which defines the way a Transformer works
-- (to identify the transformation it performs)
end Transformer;