src/OSD/OSD_Host.cdl

   1 -- Created on: 2018-03-15
   2 -- Created by: Stephan GARNAUD (ARM)
   3 -- Copyright (c) 1998-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   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.
  10 --
  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.
  13 --
  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
  21
  22
  23
  24
  25 class Host from OSD
  26
  27  ---Purpose: Carries information about a Host
  28
  29
  30 uses SysType, OEMType, Error, AsciiString from TCollection
  31 raises ConstructionError, NullObject, OSDError
  32
  33  is
  34
  35   Create returns Host;
  36     ---Purpose: Initializes current host by default.
  37     ---Level: Advanced
  38
  39   SystemVersion (me : in out) returns AsciiString is static;
  40     ---Purpose: Returns system name and version
  41     ---Level: Advanced
  42
  43   SystemId (me) returns SysType is static;
  44     ---Purpose: Returns the system type (UNIX System V, UNIX BSD, MS-DOS...)
  45     ---Level: Advanced
  46
  47   HostName (me : in out) returns AsciiString is static;
  48     ---Purpose: Returns host name.
  49     ---Level: Advanced
  50
  51   AvailableMemory (me : in out)  returns Integer is static;
  52     ---Purpose: Returns available memory in Kilobytes.
  53     ---Level: Obsolete syntax. Will be removed in next version
  54
  55   InternetAddress (me : in out) returns AsciiString is static;
  56     ---Purpose: Returns Internet address of current host.
  57     ---Level: Advanced
  58
  59   MachineType (me : in out) returns OEMType is static;
  60     ---Purpose: Returns type of current machine.
  61     ---Level: Advanced
  62
  63  Failed (me) returns Boolean is static;
  64    ---Purpose: Returns TRUE if an error occurs
  65    ---Level: Advanced
  66
  67  Reset (me : in out) is static;
  68    ---Purpose: Resets error counter to zero
  69    ---Level: Advanced
  70
  71  Perror (me : in out)
  72    ---Purpose: Raises OSD_Error
  73    ---Level: Advanced
  74    raises OSDError is static;
  75
  76  Error (me) returns Integer is static;
  77    ---Purpose: Returns error number if 'Failed' is TRUE.
  78    ---Level: Advanced
  79
  80 fields
  81   myName   : AsciiString;
  82   myError  : Error;
  83 end Host from OSD;
  84
  85