Open CASCADE Technology  7.7.0
Public Member Functions | Static Public Member Functions
OSD_Process Class Reference

A set of system process tools. More...

#include <OSD_Process.hxx>

Public Member Functions

 OSD_Process ()
 Initializes the object and prepare for a possible dump. More...
 
void TerminalType (TCollection_AsciiString &Name)
 Returns the terminal used (vt100, vt200 ,sun-cmd ...) More...
 
Quantity_Date SystemDate ()
 Gets system date. More...
 
TCollection_AsciiString UserName ()
 Returns the user name. More...
 
Standard_Boolean IsSuperUser ()
 Returns True if the process user is the super-user. More...
 
Standard_Integer ProcessId ()
 Returns the 'Process Id'. More...
 
OSD_Path CurrentDirectory ()
 Returns the current path where the process is. More...
 
void SetCurrentDirectory (const OSD_Path &where)
 Changes the current process directory. More...
 
Standard_Boolean Failed () const
 Returns TRUE if an error occurs. More...
 
void Reset ()
 Resets error counter to zero. More...
 
void Perror ()
 Raises OSD_Error. More...
 
Standard_Integer Error () const
 Returns error number if 'Failed' is TRUE. More...
 

Static Public Member Functions

static TCollection_AsciiString ExecutablePath ()
 Return full path to the current process executable. More...
 
static TCollection_AsciiString ExecutableFolder ()
 Return full path to the folder containing current process executable with trailing separator. More...
 

Detailed Description

A set of system process tools.

Constructor & Destructor Documentation

◆ OSD_Process()

OSD_Process::OSD_Process ( )

Initializes the object and prepare for a possible dump.

Member Function Documentation

◆ CurrentDirectory()

OSD_Path OSD_Process::CurrentDirectory ( )

Returns the current path where the process is.

◆ Error()

Standard_Integer OSD_Process::Error ( ) const

Returns error number if 'Failed' is TRUE.

◆ ExecutableFolder()

static TCollection_AsciiString OSD_Process::ExecutableFolder ( )
static

Return full path to the folder containing current process executable with trailing separator.

◆ ExecutablePath()

static TCollection_AsciiString OSD_Process::ExecutablePath ( )
static

Return full path to the current process executable.

◆ Failed()

Standard_Boolean OSD_Process::Failed ( ) const

Returns TRUE if an error occurs.

◆ IsSuperUser()

Standard_Boolean OSD_Process::IsSuperUser ( )

Returns True if the process user is the super-user.

◆ Perror()

void OSD_Process::Perror ( )

Raises OSD_Error.

◆ ProcessId()

Standard_Integer OSD_Process::ProcessId ( )

Returns the 'Process Id'.

◆ Reset()

void OSD_Process::Reset ( )

Resets error counter to zero.

◆ SetCurrentDirectory()

void OSD_Process::SetCurrentDirectory ( const OSD_Path where)

Changes the current process directory.

◆ SystemDate()

Quantity_Date OSD_Process::SystemDate ( )

Gets system date.

◆ TerminalType()

void OSD_Process::TerminalType ( TCollection_AsciiString Name)

Returns the terminal used (vt100, vt200 ,sun-cmd ...)

◆ UserName()

TCollection_AsciiString OSD_Process::UserName ( )

Returns the user name.


The documentation for this class was generated from the following file: