Files
OCCT/src/Transfer/Transfer_ResultFromTransient.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

110 lines
4.2 KiB
Plaintext
Executable File

-- Created on: 1995-11-16
-- Created by: Christian CAILLET
-- Copyright (c) 1995-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class ResultFromTransient from Transfer inherits TShared
---Purpose : This class, in conjunction with ResultFromModel, allows to
-- record the result of a transfer initially stored in a
-- TransientProcess.
--
-- A ResultFromTransient records a couple (Transient,Binder for
-- the result and checks) plus a list of "sub-results", which
-- have been recorded in the TrabsientProcess, under scope
-- attached to the starting transient.
uses Transient, HSequenceOfTransient, IndexedMapOfTransient,
Check, CheckStatus, Binder, TransientProcess
is
Create returns mutable ResultFromTransient;
---Purpose : Creates a ResultFromTransient, empty
SetStart (me : mutable; start : any Transient);
---Purpose : Sets starting entity
SetBinder (me : mutable; binder : any Binder);
---Purpose : Sets Binder (for result plus individual check)
Start (me) returns any Transient;
---Purpose : Returns the starting entity
Binder (me) returns any Binder;
---Purpose : Returns the binder
HasResult (me) returns Boolean;
---Purpose : Returns True if a result is recorded
Check (me) returns Check;
---Purpose : Returns the check (or an empty one if no binder)
---C++ : return const
CheckStatus (me) returns CheckStatus;
---Purpose : Returns the check status
ClearSubs (me : mutable);
---Purpose : Clears the list of (immediate) sub-results
AddSubResult (me : mutable; sub : mutable ResultFromTransient);
---Purpose : Adds a sub-result
NbSubResults (me) returns Integer;
---Purpose : Returns the count of recorded sub-results
SubResult (me; num : Integer) returns mutable ResultFromTransient;
---Purpose : Returns a sub-result, given its rank
ResultFromKey (me; key : Transient) returns ResultFromTransient;
---Purpose : Returns the ResultFromTransient attached to a given starting
-- entity (the key). Returns a null handle if not found
FillMap (me; map : in out IndexedMapOfTransient);
---Purpose : This method is used by ResultFromModel to collate the list of
-- ResultFromTransient, avoiding duplications with a map
-- Remark : <me> is already in the map and has not to be bound
Fill (me : mutable; TP : TransientProcess);
---Purpose : Fills from a TransientProcess, with the starting entity which
-- must have been set before. It works with scopes, calls Fill
-- on each of its sub-results
Strip (me : mutable);
---Purpose : Clears some data attached to binders used by TransientProcess,
-- which become useless once the transfer has been done :
-- the list of sub-scoped binders, which is now recorded as
-- sub-results
FillBack (me; TP : mutable TransientProcess);
---Purpose : Fills back a TransientProcess with definition of a
-- ResultFromTransient, respectfully to its structuration in
-- scopes
fields
thestart : Transient;
thebinder : Binder;
thesubs : HSequenceOfTransient;
end ResultFromTransient;