src/OSD/OSD_Host.hxx

   1 // Created on: 2018-03-15
   2 // Created by: Stephan GARNAUD (ARM)
   3 // Copyright (c) 1998-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 #ifndef _OSD_Host_HeaderFile
  18 #define _OSD_Host_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TCollection_AsciiString.hxx>
  25 #include <OSD_Error.hxx>
  26 #include <OSD_SysType.hxx>
  27 #include <Standard_Integer.hxx>
  28 #include <OSD_OEMType.hxx>
  29 #include <Standard_Boolean.hxx>
  30 class Standard_ConstructionError;
  31 class Standard_NullObject;
  32 class OSD_OSDError;
  33 class TCollection_AsciiString;
  34
  35
  36 //! Carries information about a Host
  37 //! System version ,host name, nodename ...
  38 class OSD_Host
  39 {
  40 public:
  41
  42   DEFINE_STANDARD_ALLOC
  43
  44
  45   //! Initializes current host by default.
  46   Standard_EXPORT OSD_Host();
  47
  48   //! Returns system name and version
  49   Standard_EXPORT TCollection_AsciiString SystemVersion();
  50
  51   //! Returns the system type (UNIX System V, UNIX BSD, MS-DOS...)
  52   Standard_EXPORT OSD_SysType SystemId() const;
  53
  54   //! Returns host name.
  55   Standard_EXPORT TCollection_AsciiString HostName();
  56
  57   //! Returns available memory in Kilobytes.
  58   Standard_EXPORT Standard_Integer AvailableMemory();
  59
  60   //! Returns Internet address of current host.
  61   Standard_EXPORT TCollection_AsciiString InternetAddress();
  62
  63   //! Returns type of current machine.
  64   Standard_EXPORT OSD_OEMType MachineType();
  65
  66   //! Returns TRUE if an error occurs
  67   Standard_EXPORT Standard_Boolean Failed() const;
  68
  69   //! Resets error counter to zero
  70   Standard_EXPORT void Reset();
  71
  72   //! Raises OSD_Error
  73   Standard_EXPORT void Perror();
  74
  75   //! Returns error number if 'Failed' is TRUE.
  76   Standard_EXPORT Standard_Integer Error() const;
  77
  78
  79
  80
  81 protected:
  82
  83
  84
  85
  86
  87 private:
  88
  89
  90
  91   TCollection_AsciiString myName;
  92   OSD_Error myError;
  93
  94
  95 };
  96
  97
  98
  99
 100
 101
 102
 103 #endif // _OSD_Host_HeaderFile