public class EndpointLocation extends Object
Element of DiagramEndpoint
Constructor and Description |
---|
EndpointLocation() |
Modifier and Type | Method and Description |
---|---|
Altitude |
getAntennaHeight()
Get the antenna height above the ground level.
|
TString |
getExcluded()
Get whether the referenced Location is included or excluded at this diagram
endpoint..
|
Common<?> |
getLocSat()
Get a reference to a geographic location or satellite associated with this
diagram endpoint.
|
Serial |
getLocSatRef()
Deprecated.
SSRF references are managed automatically. Use
getLocSat() instead. |
Az180 |
getMinPointAngle()
Get the minimum vertical pointing angle for satellite ground station
antennas..
|
Altitude |
getSiteElevation()
Get the site elevation of each base station and repeater in a trunking
system..
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetAntennaHeight()
Determine if the AntennaHeight is configured.
|
boolean |
isSetExcluded()
Determine if the Excluded is configured.
|
boolean |
isSetLocSat()
Determine if the locSat field is configured.
|
boolean |
isSetLocSatRef()
Determine if the LocSatRef is configured.
|
boolean |
isSetMinPointAngle()
Determine if the MinPointAngle is configured.
|
boolean |
isSetSiteElevation()
Determine if the SiteElevation is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this EndpointLocation record after
loading from XML.
|
void |
prepare()
Update the SSRF data type references in this EndpointLocation record.
|
void |
setAntennaHeight(Altitude value)
Set the antenna height above the ground level.
|
void |
setExcluded(TString value)
Set whether the referenced Location is included or excluded at this diagram
endpoint..
|
void |
setLocSatRef(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setLocSat(Common) instead. |
void |
setMinPointAngle(Az180 value)
Set the minimum vertical pointing angle for satellite ground station
antennas..
|
void |
setSiteElevation(Altitude value)
Set the site elevation of each base station and repeater in a trunking
system..
|
String |
toString()
Get a string representation of this EndpointLocation instance
configuration.
|
EndpointLocation |
withAntennaHeight(Double value)
Set the antenna height above the ground level.
|
EndpointLocation |
withExcluded(ListCBO value)
Set whether the referenced Location is included or excluded at this diagram
endpoint.
|
EndpointLocation |
withLocSat(Common<?> value)
Set a reference to a geographic location or satellite associated with this
diagram endpoint.
|
EndpointLocation |
withLocSatRef(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withLocSat(Common) instead. |
EndpointLocation |
withMinPointAngle(Double value)
Set the minimum vertical pointing angle for satellite ground station
antennas.
|
EndpointLocation |
withSiteElevation(Double value)
Set the site elevation of each base station and repeater in a trunking
system.
|
public Altitude getAntennaHeight()
Altitude
instancepublic void setAntennaHeight(Altitude value)
value
- a Altitude
instancepublic boolean isSetAntennaHeight()
public TString getExcluded()
TString
data typepublic void setExcluded(TString value)
value
- the Excluded value in a TString
data typepublic boolean isSetExcluded()
If configured this method also inspects the TString
wrapped value.
@Deprecated public Serial getLocSatRef()
getLocSat()
instead.Serial
instance@Deprecated public void setLocSatRef(Serial value)
#setLocSat(Common)
instead.value
- a Serial
instancepublic boolean isSetLocSatRef()
public Az180 getMinPointAngle()
Az180
instancepublic void setMinPointAngle(Az180 value)
value
- a Az180
instancepublic boolean isSetMinPointAngle()
public Altitude getSiteElevation()
Altitude
instancepublic void setSiteElevation(Altitude value)
value
- a Altitude
instancepublic boolean isSetSiteElevation()
public EndpointLocation withAntennaHeight(Double value)
value
- An instances of type Double
.public EndpointLocation withExcluded(ListCBO value)
value
- An instances of type ListCBO
.@Deprecated public EndpointLocation withLocSatRef(Serial value)
withLocSat(Common)
instead.value
- An instances of type Serial
.public EndpointLocation withMinPointAngle(Double value)
value
- An instances of type Double
.public EndpointLocation withSiteElevation(Double value)
value
- An instances of type Double
.public String toString()
public boolean isSet()
EndpointLocation
has no configuration requirements.
public Common<?> getLocSat()
Common
instancepublic boolean isSetLocSat()
public EndpointLocation withLocSat(Common<?> value)
value
- An instances of type Common>
.public void prepare()
This method builds the exported locSatRef
field with values from
the transient locSat
field. This method should typically be called
after the EndpointLocation is configured and (optionally) before exporting
an SSRF message.
public void postLoad(SSRF root)
This method builds the transient locSat
with values from the
imported locSatRef
field. This method should typically be called
after the EndpointLocation is imported from XML. * @param root the SSRF
root instance.
Copyright © 2016 OpenSSRF.org. All rights reserved.