com.SIMRacingApps

Class Windows

java.lang.Object

com.SIMRacingApps.Windows

public class Windows
extends java.lang.Object

This class defines wrappers to all of the calls to the Windows API. This way, all the platform specific stuff is all in one place. All methods are static, so there is no need to instantiate this class as an object.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Windows.Handle Defines a wrapper for a HANDLE to hide the Windows definition details
static class	Windows.MsgId Defines a wrapper for the MsgId to hide Windows definition details.
static class	Windows.Pointer Defines a wrapper for a Pointer to hide the JNA definition details
static class	Windows.Robot The Windows.Robot class is a subclass of the java.awt.Robot class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_FILE_NOT_FOUND
static int	m_lastError

Constructor Summary

Constructors

Constructor and Description
Windows()

Method Summary

Modifier and Type	Method and Description
static void	closeHandle(Windows.Handle h) Closes a previously opened Handle
static int	getLastError() Returns the last error number to compare against the Error Codes defined above.
static java.lang.String	getLastErrorMessage() Returns the text error message associated with the last error number.
static void	keyPress(com.sun.jna.platform.win32.WinDef.HWND hWin, int key)
static Windows.Pointer	mapViewOfFile(Windows.Handle h) Returns a Pointer to the memory where the file was mapped to.
static Windows.Handle	openCommPort(int portNumber) Return a Handle to a COM port There is some good information here about how to use the Window serial port API.
static Windows.Handle	openEvent(java.lang.String eventName) Returns a Handle to an Event.
static Windows.Handle	openFileMapping(java.lang.String filename) Returns a Handle to a memory mapped file.
static void	postMessage(com.sun.jna.platform.win32.WinDef.HWND hWin, Windows.MsgId id, int wParam, int lParam) Sends a message to the specified window and does not wait on it to be received
static Windows.MsgId	registerWindowMessage(java.lang.String name) Returns the MsgId of named message.
static void	sendNotifyMessage(Windows.MsgId id, int wParam, int lParam) Sends a message to anyone listening to the specified MsgId
static void	setAffinity(int cores_to_reserve) Tells windows what cores I'm allowed to run on.
static boolean	setCommPortDTR(Windows.Handle hCommPort, boolean flag) This method either sets or clears the DTR signal on the comm port.
static boolean	setCommPortRTS(Windows.Handle hCommPort, boolean flag) This method either sets or clears the RTS signal on the comm port.
static void	setConsoleTitle(java.lang.String title) Sets the title of the console window.
static boolean	setForegroundWindow(java.lang.String windowClass, java.lang.String windowTitle) Finds the window with the given title and brings it to the foreground.
static void	unmapViewOfFile(Windows.Pointer p) Removes the memory pointer mapping.
static void	waitForSingleObject(Windows.Handle h, int timeout) Waits for a specified amount of time for an event to occur.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_FILE_NOT_FOUND

public static int ERROR_FILE_NOT_FOUND

m_lastError

public static int m_lastError

Constructor Detail

Windows

public Windows()

Method Detail

closeHandle

public static void closeHandle(Windows.Handle h)

Closes a previously opened Handle

Parameters:

h - The handle to close

getLastError

public static int getLastError()

Returns the last error number to compare against the Error Codes defined above.

Returns:

The error number.

getLastErrorMessage

public static java.lang.String getLastErrorMessage()

Returns the text error message associated with the last error number.

Returns:

An error message.

keyPress

public static void keyPress(com.sun.jna.platform.win32.WinDef.HWND hWin,
                            int key)

mapViewOfFile

public static Windows.Pointer mapViewOfFile(Windows.Handle h)

Returns a Pointer to the memory where the file was mapped to.

Parameters:

h - A Handle to a memory mapped file.

Returns:

A Pointer to the memory.

openCommPort

public static Windows.Handle openCommPort(int portNumber)

Return a Handle to a COM port There is some good information here about how to use the Window serial port API.

Parameters:

portNumber - The port number to open as an integer

Returns:

A Handle object to the open port, null if error.

openEvent

public static Windows.Handle openEvent(java.lang.String eventName)

Returns a Handle to an Event.

Parameters:

eventName - The name of the event.

Returns:

A Handle for the event.

openFileMapping

public static Windows.Handle openFileMapping(java.lang.String filename)

Returns a Handle to a memory mapped file.

Parameters:

filename - The memory map name.

Returns:

A Handle to the file.

postMessage

public static void postMessage(com.sun.jna.platform.win32.WinDef.HWND hWin,
                               Windows.MsgId id,
                               int wParam,
                               int lParam)

Sends a message to the specified window and does not wait on it to be received

Parameters:

hWin - A handle to an existing window.

id - The MsgId to send to.

wParam - A 32 bit word.

lParam - A 64 bit word.

registerWindowMessage

public static Windows.MsgId registerWindowMessage(java.lang.String name)

Returns the MsgId of named message.

Parameters:

name - The name of the message

Returns:

The MsgId or null on failure

sendNotifyMessage

public static void sendNotifyMessage(Windows.MsgId id,
                                     int wParam,
                                     int lParam)

Sends a message to anyone listening to the specified MsgId

Parameters:

id - The MsgId to send to.

wParam - A 32 bit word.

lParam - A 64 bit word.

setCommPortRTS

public static boolean setCommPortRTS(Windows.Handle hCommPort,
                                     boolean flag)

This method either sets or clears the RTS signal on the comm port.

Parameters:

hCommPort - A handle to an open comm port

flag - true sets RTS, false clears RTS

Returns:

true if successful

setCommPortDTR

public static boolean setCommPortDTR(Windows.Handle hCommPort,
                                     boolean flag)

This method either sets or clears the DTR signal on the comm port.

Parameters:

hCommPort - A handle to an open comm port

flag - true sets DTR, false clears DTR

Returns:

true if successful

setConsoleTitle

public static void setConsoleTitle(java.lang.String title)

Sets the title of the console window.

Parameters:

title - The title.

setForegroundWindow

public static boolean setForegroundWindow(java.lang.String windowClass,
                                          java.lang.String windowTitle)

Finds the window with the given title and brings it to the foreground. If no window exists, then nothing changes.

Parameters:

windowClass - The window class or null

windowTitle - The window title or null

Returns:

true if success, false if not.

unmapViewOfFile

public static void unmapViewOfFile(Windows.Pointer p)

Removes the memory pointer mapping.

Parameters:

p - The Pointer to release.

waitForSingleObject

public static void waitForSingleObject(Windows.Handle h,
                                       int timeout)

Waits for a specified amount of time for an event to occur.

Parameters:

h - A Handle to an event.

timeout - Amount of time to wait in milliseconds.

setAffinity

public static void setAffinity(int cores_to_reserve)

Tells windows what cores I'm allowed to run on.

Parameters:

cores_to_reserve - The number of cores to reserve.