Files
OCCT/src/IGESDraw/IGESDraw_NetworkSubfigure.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

142 lines
5.8 KiB
Plaintext
Executable File

-- Created on: 1993-01-11
-- Created by: CKY / Contract Toubro-Larsen ( TCD )
-- Copyright (c) 1993-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 NetworkSubfigure from IGESDraw inherits IGESEntity
---Purpose : defines IGES Network Subfigure Instance Entity,
-- Type <420> Form Number <0> in package IGESDraw
--
-- Used to specify each instance of Network Subfigure
-- Definition Entity (Type 320, Form 0).
uses
XYZ from gp,
HAsciiString from TCollection,
NetworkSubfigureDef from IGESDraw,
TextDisplayTemplate from IGESGraph,
ConnectPoint from IGESDraw,
HArray1OfConnectPoint from IGESDraw
raises OutOfRange
is
Create returns mutable NetworkSubfigure;
-- specific for the entity
Init (me : mutable;
aDefinition : NetworkSubfigureDef;
aTranslation : XYZ;
aScaleFactor : XYZ;
aTypeFlag : Integer;
aDesignator : HAsciiString;
aTemplate : TextDisplayTemplate;
allConnectPoints : HArray1OfConnectPoint);
---Purpose : This method is used to set the fields of the class
-- NetworkSubfigure
-- - aDefinition : Network Subfigure Definition Entity
-- - aTranslation : Translation data relative to the model
-- space or the definition space
-- - aScaleFactor : Scale factors in the definition space
-- - aTypeFlag : Type flag
-- - aDesignator : Primary reference designator
-- - aTemplate : Primary reference designator Text
-- display Template Entity
-- - allConnectPoints : Associated Connect Point Entities
SubfigureDefinition (me) returns NetworkSubfigureDef;
---Purpose : returns Network Subfigure Definition Entity specified by this entity
Translation (me) returns XYZ from gp;
---Purpose : returns Translation Data relative to either model space or to
-- the definition space of a referring entity
TransformedTranslation (me) returns XYZ from gp;
---Purpose : returns the Transformed Translation Data relative to either model
-- space or to the definition space of a referring entity
ScaleFactors (me) returns XYZ from gp;
---Purpose : returns Scale factor in definition space(x, y, z axes)
TypeFlag (me) returns Integer;
---Purpose : returns Type Flag which implements the distinction between Logical
-- design and Physical design data,and is required if both are present.
-- Type Flag = 0 : Not specified (default)
-- = 1 : Logical
-- = 2 : Physical
ReferenceDesignator (me) returns HAsciiString from TCollection;
---Purpose : returns the primary reference designator
HasDesignatorTemplate (me) returns Boolean;
---Purpose : returns True if Text Display Template Entity is specified,
-- else False
DesignatorTemplate (me) returns TextDisplayTemplate;
---Purpose : returns primary reference designator Text Display Template Entity,
-- or null. If null, no Text Display Template Entity specified
NbConnectPoints (me) returns Integer;
---Purpose : returns the number of associated Connect Point Entities
ConnectPoint (me; Index : Integer) returns ConnectPoint
raises OutOfRange;
---Purpose : returns the Index'th associated Connect point Entity
-- raises exception if Index <= 0 or Index > NbConnectPoints()
fields
--
-- Class : IGESDraw_NetworkSubfigure
--
-- Purpose : Declaration of the variables specific to a NetworkSubfigure.
--
-- Reminder : A Network Subfigure Instance Entity is defined by :
-- - a Network Subfigure Definition
-- - translation data relative to referring entity's
-- model or definition space
-- - the scale factors in x,y and z directions
-- - a type flag to distinguish logical design data
-- from physical data
-- Type flag : 0 = not specified (default)
-- 1 = logical
-- 2 = physical
-- - the pointers to associated Connect Point Entities
--
theSubfigureDefinition : NetworkSubfigureDef;
theTranslation : XYZ;
theScaleFactor : XYZ;
theTypeFlag : Integer;
theDesignator : HAsciiString;
theDesignatorTemplate : TextDisplayTemplate;
theConnectPoints : HArray1OfConnectPoint;
end NetworkSubfigure;