0023024: Update headers of OCCT files
[occt.git] / src / AlienImage / AlienImage_EuclidAlienData.cdl
CommitLineData
b311480e 1-- Created on: 1993-03-23
2-- Created by: BBL
3-- Copyright (c) 1993-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977 5--
b311480e 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.
7fd59977 10--
b311480e 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.
7fd59977 13--
b311480e 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
7fd59977 21
22class EuclidAlienData from AlienImage inherits AlienImageData from AlienImage
23
24 ---Version: 0.0
25
26 ---Level: Public
27 ---Purpose: This class defines an Euclid .PIX Alien image.
28 ---Keywords:
29 ---Warning:
30 ---References:
31
32uses
33 File from OSD,
34 AsciiString from TCollection,
35 ColorImage from Image,
36 PseudoColorImage from Image,
37 Image from Image,
38 HArray2OfInteger from TColStd
39
40raises
41 OutOfRange from Standard,
42 TypeMismatch from Standard
43
44is
45 Create returns mutable EuclidAlienData from AlienImage ;
46
47 Clear( me : in out mutable ) ;
48 ---Level: Public
49 ---Purpose: Frees memory allocated by EuclidAlienData
50 ---C++: alias ~
51
52 Read ( me : in out mutable ; afile : in out File from OSD )
53 returns Boolean from Standard ;
54 ---Level: Public
55 ---Purpose: Read content of a EuclidAlienData object from a file .
56 -- Returns True if file is a XWD file .
57
58 Write( me : in immutable; afile : in out File from OSD )
59 returns Boolean from Standard ;
60 ---Level: Public
61 ---Purpose: Write content of a EuclidAlienData object to a file .
62
63 ToImage( me : in immutable)
64 returns mutable Image from Image
65 raises TypeMismatch from Standard ;
66 ---Level: Public
67 ---Purpose : convert a EuclidAlienData object to a Image object.
68
69 FromImage( me : in out mutable ; anImage : in Image from Image )
70 raises TypeMismatch from Standard ;
71 ---Level: Public
72 ---Purpose : convert a Image object to a EuclidAlienData object.
73
74 --
75 -- Private Method
76 --
77
78
79 FromPseudoColorImage( me : in out mutable ;
80 anImage : in PseudoColorImage from Image );
81 ---Level: Internal
82 ---Purpose : convert a Image object to a EuclidAlienData object.
83
84 FromColorImage( me : in out mutable ;
85 anImage : in ColorImage from Image );
86 ---Level: Internal
87 ---Purpose : convert a Image object to a EuclidAlienData object.
88
89fields
90
91 myX1, myY1, myX2, myY2 : Integer from Standard ;
92 myNumberOfColor : Integer from Standard ;
93 myColors : Address from Standard ;
94 myPixels : HArray2OfInteger from TColStd ;
95 myPixelsIsDef : Boolean from Standard ;
96end ;
97