com.altair.hwm.comm
Class HWMResponseHandle

java.lang.Object
  com.altair.hwm.comm.HWMResponseHandle

public class HWMResponseHandle
extends java.lang.Object

Title: HWMResponseHandle

Description: The HWMResponseHandle is a simple structure designed to contain the return from a HWM Communication query.

Company: Altair Engineering

Field Summary

boolean	m_bSuccess
java.lang.String	m_szResponse

Constructor Summary

HWMResponseHandle(java.lang.String szMsg)
Purpose: Constructor.

Method Summary

boolean	IsSuccess() Retuen whether the query was executed successfully.
java.lang.String	toString() Purpose: Converts the HWMMessageHandle to a String
java.util.Vector	toVector() Purpose: Converts the HWMMessageHandle to a Vector

Methods inherited from class java.lang.Object

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

Field Detail

m_bSuccess

public boolean m_bSuccess

m_szResponse

public java.lang.String m_szResponse

Constructor Detail

HWMResponseHandle

public HWMResponseHandle(java.lang.String szMsg)

Purpose: Constructor. Creates a HWMResponseHandle based on the given string. If the string is null, then the HWMResponseHandle will have a m_bSuccess of false, and no m_szResponse. Otherwise, if the first character of the string is a 0, the m_bSuccess will be false. any other character, and m_bSuccess will be true. Additionally, if the input String is more then 2 characters in length, then m_szResponse will contain all the characters from the index 2 position to the end of the string.

Parameters:

String - szMsg -- The message, probably one from a HWM Slave application.

Method Detail

IsSuccess

public boolean IsSuccess()

Retuen whether the query was executed successfully.

Returns:

boolean true->success; false=>failure

toString

public java.lang.String toString()

Purpose: Converts the HWMMessageHandle to a String

Overrides:

toString in class java.lang.Object

toVector

public java.util.Vector toVector()

Purpose: Converts the HWMMessageHandle to a Vector