src/STEPEdit/STEPEdit.cdl

   1 -- Created on: 1998-07-29
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1998-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and / or modify it
   9 -- under the terms of the GNU Lesser General Public version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 package STEPEdit
  18
  19     ---Purpose : Provides tools to exploit and edit a set of STEP data :
  20     --           editors, selections ..
  21
  22 uses Standard, TCollection,
  23      Interface, IFSelect, StepData
  24
  25 is
  26
  27     class EditContext;
  28     -- This class is for global context : ApplicationContext,
  29     --   ProductRelatedProductCategory
  30
  31     class EditSDR;
  32     -- This class allows to edit product data for a SDR
  33
  34
  35         --  Some useful operators
  36         --  They are not classes, they are just based on general tools
  37
  38     Protocol returns Protocol from Interface;
  39     ---Purpose : Returns a Protocol fit for STEP (creates the first time)
  40
  41     NewModel returns StepModel from StepData;
  42     ---Purpose : Returns a new empty StepModel fit for STEP
  43     --           i.e. with its header determined from Protocol
  44
  45     SignType returns Signature from IFSelect;
  46     ---Purpose : Returns a SignType fit for STEP (creates the first time)
  47
  48     NewSelectSDR returns SelectSignature from IFSelect;
  49     ---Purpose : Creates a Selection for ShapeDefinitionRepresentation
  50     --           By default searches among root entities
  51
  52     NewSelectPlacedItem returns SelectSignature from IFSelect;
  53     ---Purpose : Creates a Selection for Placed Items, i.e. MappedItem or
  54     --           ContextDependentShapeRepresentation, which itself refers to a
  55     --           RepresentationRelationship with possible subtypes (Shape...
  56     --           and/or ...WithTransformation)
  57     --           By default in the whole StepModel
  58
  59     NewSelectShapeRepr returns SelectSignature from IFSelect;
  60     ---Purpose : Creates a Selection for ShapeRepresentation and its sub-types,
  61     --           plus ContextDependentShapeRepresentation (which is not a
  62     --           sub-type of ShapeRepresentation)
  63     --           By default in the whole StepModel
  64
  65 end STEPEdit;