src/IGESDraw/IGESDraw_NetworkSubfigure.cdl

   1 -- Created on: 1993-01-11
   2 -- Created by: CKY / Contract Toubro-Larsen ( TCD )
   3 -- Copyright (c) 1993-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 under
   9 -- the terms of the GNU Lesser General Public License 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 class NetworkSubfigure from IGESDraw  inherits IGESEntity
  18
  19         ---Purpose : defines IGES Network Subfigure Instance Entity,
  20         --           Type <420> Form Number <0> in package IGESDraw
  21         --
  22         --           Used to specify each instance of Network Subfigure
  23         --           Definition Entity (Type 320, Form 0).
  24
  25 uses
  26
  27         XYZ                   from gp,
  28         HAsciiString          from TCollection,
  29         NetworkSubfigureDef   from IGESDraw,
  30         TextDisplayTemplate   from IGESGraph,
  31         ConnectPoint          from IGESDraw,
  32         HArray1OfConnectPoint from IGESDraw
  33
  34 raises OutOfRange
  35
  36 is
  37
  38         Create returns NetworkSubfigure;
  39
  40         -- specific for the entity
  41
  42         Init (me               : mutable;
  43               aDefinition      : NetworkSubfigureDef;
  44               aTranslation     : XYZ;
  45               aScaleFactor     : XYZ;
  46               aTypeFlag        : Integer;
  47               aDesignator      : HAsciiString;
  48               aTemplate        : TextDisplayTemplate;
  49               allConnectPoints : HArray1OfConnectPoint);
  50         ---Purpose : This method is used to set the fields of the class
  51         --           NetworkSubfigure
  52         --       - aDefinition      : Network Subfigure Definition Entity
  53         --       - aTranslation     : Translation data relative to the model
  54         --                            space or the definition space
  55         --       - aScaleFactor     : Scale factors in the definition space
  56         --       - aTypeFlag        : Type flag
  57         --       - aDesignator      : Primary reference designator
  58         --       - aTemplate        : Primary reference designator Text
  59         --                            display Template Entity
  60         --       - allConnectPoints : Associated Connect Point Entities
  61
  62         SubfigureDefinition (me) returns NetworkSubfigureDef;
  63         ---Purpose : returns Network Subfigure Definition Entity specified by this entity
  64
  65         Translation (me) returns XYZ from gp;
  66         ---Purpose : returns Translation Data relative to either model space or to
  67         -- the definition space of a referring entity
  68
  69         TransformedTranslation (me) returns XYZ from gp;
  70         ---Purpose : returns the Transformed Translation Data relative to either model
  71         -- space or to the definition space of a referring entity
  72
  73         ScaleFactors (me) returns XYZ from gp;
  74         ---Purpose : returns Scale factor in definition space(x, y, z axes)
  75
  76         TypeFlag (me) returns Integer;
  77         ---Purpose : returns Type Flag which implements the distinction between Logical
  78         -- design and Physical design data,and is required if both are present.
  79         --         Type Flag = 0 : Not specified (default)
  80         --                   = 1 : Logical
  81         --                   = 2 : Physical
  82
  83         ReferenceDesignator (me) returns HAsciiString from TCollection;
  84         ---Purpose : returns the primary reference designator
  85
  86         HasDesignatorTemplate (me) returns Boolean;
  87         ---Purpose : returns True if Text Display Template Entity is specified,
  88         -- else False
  89
  90         DesignatorTemplate (me) returns TextDisplayTemplate;
  91         ---Purpose : returns primary reference designator Text Display Template Entity,
  92         -- or null. If null, no Text Display Template Entity specified
  93
  94         NbConnectPoints (me) returns Integer;
  95         ---Purpose : returns the number of associated Connect Point Entities
  96
  97         ConnectPoint (me; Index : Integer) returns ConnectPoint
  98         raises OutOfRange;
  99         ---Purpose : returns the Index'th  associated Connect point Entity
 100         -- raises exception if Index <= 0 or Index > NbConnectPoints()
 101
 102 fields
 103
 104 --
 105 -- Class    : IGESDraw_NetworkSubfigure
 106 --
 107 -- Purpose  : Declaration of the variables specific to a NetworkSubfigure.
 108 --
 109 -- Reminder : A  Network Subfigure Instance Entity is defined by :
 110 --                  - a Network Subfigure Definition
 111 --                  - translation data relative to referring entity's
 112 --                     model or definition space
 113 --                  - the scale factors in x,y and z directions
 114 --                  - a type flag to distinguish logical design data
 115 --                     from physical data
 116 --                     Type flag : 0 = not specified (default)
 117 --                                 1 = logical
 118 --                                 2 = physical
 119 --                  - the pointers to associated Connect Point Entities
 120 --
 121
 122         theSubfigureDefinition   : NetworkSubfigureDef;
 123
 124         theTranslation           : XYZ;
 125
 126         theScaleFactor           : XYZ;
 127
 128         theTypeFlag              : Integer;
 129
 130         theDesignator            : HAsciiString;
 131
 132         theDesignatorTemplate    : TextDisplayTemplate;
 133
 134         theConnectPoints         : HArray1OfConnectPoint;
 135
 136 end NetworkSubfigure;