src/TransferBRep/TransferBRep_TransferResultInfo.cdl

   1 -- Created on: 1999-08-11
   2 -- Created by: Roman LYGIN
   3 -- Copyright (c) 1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 class TransferResultInfo from TransferBRep inherits TShared from MMgt
  24
  25     ---Purpose: Data structure for storing information on transfer result.
  26     --          At the moment it dispatches information for the following types:
  27     --          - result,
  28     --          - result + warning(s),
  29     --          - result + fail(s),
  30     --          - result + warning(s) + fail(s)
  31     --          - no result,
  32     --          - no result + warning(s),
  33     --          - no result + fail(s),
  34     --          - no result + warning(s) + fail(s),
  35
  36 is
  37
  38     Create returns TransferResultInfo from TransferBRep;
  39         ---Purpose: Creates object with all fields nullified.
  40
  41     Clear (me: mutable);
  42         ---Purpose: Resets all the fields.
  43
  44     Result (me: mutable) returns Integer;
  45         ---C++: inline
  46         ---C++: return &
  47
  48     ResultWarning (me: mutable) returns Integer;
  49         ---C++: inline
  50         ---C++: return &
  51
  52     ResultFail (me: mutable) returns Integer;
  53         ---C++: inline
  54         ---C++: return &
  55
  56     ResultWarningFail (me: mutable) returns Integer;
  57         ---C++: inline
  58         ---C++: return &
  59
  60     NoResult (me: mutable) returns Integer;
  61         ---C++: inline
  62         ---C++: return &
  63
  64     NoResultWarning (me: mutable) returns Integer;
  65         ---C++: inline
  66         ---C++: return &
  67
  68     NoResultFail (me: mutable) returns Integer;
  69         ---C++: inline
  70         ---C++: return &
  71
  72     NoResultWarningFail (me: mutable) returns Integer;
  73         ---C++: inline
  74         ---C++: return &
  75
  76 fields
  77
  78     myR,  myRW,  myRF,  myRWF,
  79     myNR, myNRW, myNRF, myNRWF: Integer;
  80
  81 end TransferResultInfo;