|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.signalsoftcorp.lst.client.MLP300LocationRequest
Represents a MLP 3.0.0 location request.
An instance of this class is passed in a call to
WLILocation.getLocation
.
If one of the request parameters is invalid. you will get a error specified by
MLP300Error
.
see
MLP300LocationResponse
for more information.\
Constructor Summary | |
MLP300LocationRequest()
|
Method Summary | |
int |
getAltAcc()
Accuracy of altitude in meters. |
java.lang.String |
getClientId()
This is the login id that the client uses when it make calls to LocationStudio |
java.lang.String |
getClientPwd()
This is the password that the client uses when it make calls to LocationStudio |
int |
getHorAcc()
Requested horizontal accuracy in meters. |
int |
getLlAcc()
Longitude and latitude accuracy in seconds. |
java.lang.String |
getLocType()
Defines the type of location requested. |
int |
getMaxLocAge()
This states the maximum allowable age in seconds of a location sent as a response to a location request. |
MLP300Msid[] |
getMLP300Msid()
Returns an array of MLP300Msids . |
java.lang.String |
getPrioType()
Defines the priority of a location request. |
java.lang.String |
getRespReq()
This field represents response time requirement |
int |
getRespTimer()
Defines a timer for the response time (in seconds) within which the current location should be obtained. |
void |
setAltAcc(int altAcc)
Accuracy of altitude in meters |
void |
setClientId(java.lang.String clientId)
This is the login id that the client uses when it make calls to LocationStudio |
void |
setClientPwd(java.lang.String clientPwd)
This is the password that the client uses when it make calls to LocationStudio |
void |
setHorAcc(int horAcc)
Requested horizontal accuracy in meters. |
void |
setLlAcc(int llAcc)
Longitude and latitude accuracy in seconds. |
void |
setLocType(java.lang.String locType)
Defines the type of location requested. |
void |
setMaxLocAge(int maxLocAge)
This states the maximum allowable age in seconds of a location sent as a response to a location request. |
void |
setMLP300Msid(MLP300Msid[] mLP300Msid)
Sets an array of MLP300Msids . |
void |
setPrioType(java.lang.String prioType)
Defines the priority of a location request. |
void |
setRespReq(java.lang.String respReq)
This field represents response time requirement |
void |
setRespTimer(int respTimer)
Defines a timer for the response time (in seconds) within which the current location should be obtained. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public MLP300LocationRequest()
Method Detail |
public MLP300Msid[] getMLP300Msid()
MLP300Msids
.public void setMLP300Msid(MLP300Msid[] mLP300Msid)
MLP300Msids
.MLP300Msid[]
- Mandatory - The actual subscribers that should positioned.public java.lang.String getClientId()
public void setClientId(java.lang.String clientId)
clientId
- Mandatory - The id that identifies the client in LocationStudio.public java.lang.String getClientPwd()
public void setClientPwd(java.lang.String clientPwd)
clientPwd
- Mandatory - The password that is used in LocationStudio for authentication.public java.lang.String getRespReq()
This field represents response time requirement
Valid valuesNO_DELAY | return either initial or last known location of the user |
LOW_DELAY | return the current location with minimum delay. The mobility service shall attempt to fulfill any accuracy requirement, but in doing so shall not add any additional delay. |
DELAY_TOL | obtain the current location with regard to fulfilling the accuracy |
Default value is DELAY_TOL.
public void setRespReq(java.lang.String respReq)
This field represents response time requirement
Valid valuesNO_DELAY | return either initial or last known location of the user |
LOW_DELAY | return the current location with minimum delay. The mobility service shall attempt to fulfill any accuracy requirement, but in doing so shall not add any additional delay. |
DELAY_TOL | obtain the current location with regard to fulfilling the accuracy |
Default value is DELAY_TOL.
respReq
- Optional - This field represents response time requirementpublic int getRespTimer()
setMaxLocAge
.public void setRespTimer(int respTimer)
Default value is 0, meaning that the timeout time is determined by underlaying
protocols.
setMaxLocAge
.
respTimer
- Defines a timer for the response time (in seconds).public int getLlAcc()
public void setLlAcc(int llAcc)
The default value 0 means that this value is undefined.
llAcc
- Longitude and latitude accuracy in seconds. Can not be defined (>0)
when HorAcc is defined (>0).public int getHorAcc()
public void setHorAcc(int horAcc)
The default value 0 means that this value is undefined.
horAcc
- Requested horizontal accuracy in meters. Can not be defined (>0)
when LlAcc is defined (>0).public int getAltAcc()
public void setAltAcc(int altAcc)
The default value 0 means that this value is undefined.
altAcc
- Accuracy of altitude in meterspublic int getMaxLocAge()
public void setMaxLocAge(int maxLocAge)
The default value 0 means that this value is undefined.
maxLocAge
- This states the maximum allowable age in seconds of a location sent as a
response to a location request.public void setLocType(java.lang.String locType)
Defines the type of location requested.
Valid valuesCURRENT | After a location attempt has successfully delivered a location estimate, the location estimate is known as the current location at that point in time. |
LAST | The current location estimate is generally stored in the network until replaced by a later location estimate and is known as the last known location. The last known location may be distinct from the initial location., i.e. more recent. |
CURRENT_OR_LAST | If a location attempt has successfully delivered, the current location is returned. Otherwise the last known location stored in the network is returned. |
locType
- Optional - Defines the type of location requested.public java.lang.String getLocType()
Defines the type of location requested.
Valid valuesCURRENT | After a location attempt has successfully delivered a location estimate, the location estimate is known as the current location at that point in time. |
LAST | The current location estimate is generally stored in the network until replaced by a later location estimate and is known as the last known location. The last known location may be distinct from the initial location., i.e. more recent. |
CURRENT_OR_LAST | If a location attempt has successfully delivered, the current location is returned. Otherwise the last known location stored in the network is returned. |
public void setPrioType(java.lang.String prioType)
Defines the priority of a location request.
Valid values:NORMAL | The request is handled with normal priority |
HIGH | The request is handled with high priority |
prioType
- Optional - Defines the priority of a location request.public java.lang.String getPrioType()
Defines the priority of a location request.
Valid values:NORMAL | The request is handled with normal priority |
HIGH | The request is handled with high priority |
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |