0022627: Change OCCT memory management defaults
[occt.git] / src / AlienImage / AlienImage_SGIRGBAlienData.cdl
1 --
2 -- File:        AlienImage_SGIRGBAlienData.cdl
3 -- Created:     23/03/93
4 -- Author:      BBL
5 --
6 ---Copyright:   Matravision 1993
7 --
8
9 class SGIRGBAlienData from AlienImage inherits AlienImageData from AlienImage
10
11         ---Version: 0.0
12
13         ---Purpose: This class defines a SGI .rgb Alien image.
14         ---Keywords:
15         ---Warning:
16         ---References:
17
18 uses
19         File                    from OSD,
20         AsciiString             from TCollection,
21         ColorImage              from Image,
22         PseudoColorImage        from Image,
23         Image                   from Image,
24         X11XColor               from AlienImage,
25         SGIRGBFileHeader        from AlienImage
26
27 raises
28         OutOfRange      from Standard,
29         TypeMismatch    from Standard
30
31 is
32         Create returns mutable SGIRGBAlienData from AlienImage ;
33
34         Clear( me : in out mutable ) ;
35         ---Level: Public
36         ---Purpose: Frees memory allocated by SGIRGBAlienData
37         ---C++: alias ~
38
39         Read ( me : in out mutable ; afile : in out File from OSD )
40           returns Boolean from Standard ;
41         ---Level: Public
42           ---Purpose: Read content of a  SGIRGBAlienData object from a file .
43           --          Returns True if file is a SGI .rgb file .
44
45         Write( me : in immutable; afile : in out File from OSD )
46           returns Boolean from Standard ;
47         ---Level: Public
48           ---Purpose: Write content of a  SGIRGBAlienData object to a file .
49
50         SetName( me : in out mutable ;
51                  aName : in AsciiString from TCollection)
52         is redefined;
53         ---Level: Public
54           ---Purpose: Set Image name .
55
56         Name( me : in immutable ) returns AsciiString from TCollection
57         is redefined;
58           ---C++: return const &
59         ---Level: Public
60           ---Purpose: Get Image name .
61
62         ToImage( me : in  immutable) 
63           returns mutable Image from Image 
64           raises TypeMismatch from Standard ;
65         ---Level: Public
66           ---Purpose : convert a SGIRGBAlienData object to a Image object.
67
68         FromImage( me : in out mutable ; anImage : in Image from Image )
69           raises TypeMismatch from Standard ;
70         ---Level: Public
71           ---Purpose : convert a Image object to a SGIRGBAlienData object.
72
73         --
74         --                      Private Method
75         --
76
77         ToPseudoColorImage( me : in immutable) 
78           returns PseudoColorImage from Image is private ;
79         ---Level: Internal
80           ---Purpose : convert a AlienImage object to a Image object.
81
82         ToColorImage( me : in immutable) 
83           returns ColorImage from Image is private ;
84         ---Level: Internal
85           ---Purpose : convert a AlienImage object to a Image object.
86
87 fields
88
89         myHeader : SGIRGBFileHeader from AlienImage is protected ;
90         myRedData, myGreenData, myBlueData : Address from Standard is protected;
91                 -- ( unsigned short * )
92
93 end ;
94