Interface GeoCoordinates
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<GeoCoordinates>
,org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator")
public interface GeoCoordinates
extends org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>, org.opendaylight.yangtools.yang.binding.Augmentable<GeoCoordinates>
Geo-coordinates LCAF type.
This class represents the following YANG schema fragment defined in module ietf-lisp-address-types
container geo-coordinates { when "../address-type = 'laddr:geo-coordinates-lcaf'" { } leaf latitude { type bits { bit N { } } } leaf latitude-degrees { type uint8 { range "0 .. 90"; } } leaf latitude-minutes { type uint8 { range 0..59; } } leaf latitude-seconds { type uint8 { range 0..59; } } leaf longitude { type bits { bit E { } } } leaf longitude-degrees { type uint16 { range "0 .. 180"; } } leaf longitude-minutes { type uint8 { range 0..59; } } leaf longitude-seconds { type uint8 { range 0..59; } } leaf altitude { type int32; } leaf address { type simple-address; } }
To create instances of this class use GeoCoordinatesBuilder
.
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
This class represents the following YANG schema fragment defined in module ietf-lisp-address-typesstatic final class
This class represents the following YANG schema fragment defined in module ietf-lisp-address-types -
Field Summary
Modifier and TypeFieldDescriptionstatic final @NonNull org.opendaylight.yangtools.yang.common.QName
YANG identifier of the statement represented by this class. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
bindingEquals
(@NonNull GeoCoordinates thisObj, Object obj) Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode
(@NonNull GeoCoordinates obj) Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString
(@NonNull GeoCoordinates obj) Default implementation ofObject.toString()
contract for this interface.Return address, ornull
if it is not present.Return altitude, ornull
if it is not present.Return latitude, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint8
Return latitudeDegrees, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint8
Return latitudeMinutes, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint8
Return latitudeSeconds, ornull
if it is not present.Return longitude, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint16
Return longitudeDegrees, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint8
Return longitudeMinutes, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint8
Return longitudeSeconds, ornull
if it is not present.default Class<GeoCoordinates>
default @NonNull SimpleAddress
Return address, guaranteed to be non-null.default @NonNull Integer
Return altitude, guaranteed to be non-null.default @NonNull GeoCoordinates.Latitude
Return latitude, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint8
Return latitudeDegrees, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint8
Return latitudeMinutes, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint8
Return latitudeSeconds, guaranteed to be non-null.default @NonNull GeoCoordinates.Longitude
Return longitude, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint16
Return longitudeDegrees, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint8
Return longitudeMinutes, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint8
Return longitudeSeconds, guaranteed to be non-null.Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations
-
Field Details
-
QNAME
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAMEYANG identifier of the statement represented by this class.
-
-
Method Details
-
implementedInterface
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
Default implementation ofObject.hashCode()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.- Parameters:
obj
- Object for which to generate hashCode() result.- Returns:
- Hash code value of data modeled by this interface.
- Throws:
NullPointerException
- ifobj
is null
-
bindingEquals
Default implementation ofObject.equals(Object)
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.- Parameters:
thisObj
- Object acting as the receiver of equals invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
is null
-
bindingToString
Default implementation ofObject.toString()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.- Parameters:
obj
- Object for which to generate toString() result.- Returns:
String
value of data modeled by this interface.- Throws:
NullPointerException
- ifobj
is null
-
getLatitude
GeoCoordinates.Latitude getLatitude()Return latitude, ornull
if it is not present.Bit that selects between North and South latitude.
- Returns:
Latitude
latitude, ornull
if it is not present.
-
requireLatitude
Return latitude, guaranteed to be non-null.Bit that selects between North and South latitude.
- Returns:
Latitude
latitude, guaranteed to be non-null.- Throws:
NoSuchElementException
- if latitude is not present
-
getLatitudeDegrees
org.opendaylight.yangtools.yang.common.Uint8 getLatitudeDegrees()Return latitudeDegrees, ornull
if it is not present.Degrees of latitude.
- Returns:
Uint8
latitudeDegrees, ornull
if it is not present.
-
requireLatitudeDegrees
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireLatitudeDegrees()Return latitudeDegrees, guaranteed to be non-null.Degrees of latitude.
- Returns:
Uint8
latitudeDegrees, guaranteed to be non-null.- Throws:
NoSuchElementException
- if latitudeDegrees is not present
-
getLatitudeMinutes
org.opendaylight.yangtools.yang.common.Uint8 getLatitudeMinutes()Return latitudeMinutes, ornull
if it is not present.Minutes of latitude.
- Returns:
Uint8
latitudeMinutes, ornull
if it is not present.
-
requireLatitudeMinutes
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireLatitudeMinutes()Return latitudeMinutes, guaranteed to be non-null.Minutes of latitude.
- Returns:
Uint8
latitudeMinutes, guaranteed to be non-null.- Throws:
NoSuchElementException
- if latitudeMinutes is not present
-
getLatitudeSeconds
org.opendaylight.yangtools.yang.common.Uint8 getLatitudeSeconds()Return latitudeSeconds, ornull
if it is not present.Seconds of latitude.
- Returns:
Uint8
latitudeSeconds, ornull
if it is not present.
-
requireLatitudeSeconds
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireLatitudeSeconds()Return latitudeSeconds, guaranteed to be non-null.Seconds of latitude.
- Returns:
Uint8
latitudeSeconds, guaranteed to be non-null.- Throws:
NoSuchElementException
- if latitudeSeconds is not present
-
getLongitude
GeoCoordinates.Longitude getLongitude()Return longitude, ornull
if it is not present.Bit that selects between East and West longitude.
- Returns:
Longitude
longitude, ornull
if it is not present.
-
requireLongitude
Return longitude, guaranteed to be non-null.Bit that selects between East and West longitude.
- Returns:
Longitude
longitude, guaranteed to be non-null.- Throws:
NoSuchElementException
- if longitude is not present
-
getLongitudeDegrees
org.opendaylight.yangtools.yang.common.Uint16 getLongitudeDegrees()Return longitudeDegrees, ornull
if it is not present.Degrees of longitude.
- Returns:
Uint16
longitudeDegrees, ornull
if it is not present.
-
requireLongitudeDegrees
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireLongitudeDegrees()Return longitudeDegrees, guaranteed to be non-null.Degrees of longitude.
- Returns:
Uint16
longitudeDegrees, guaranteed to be non-null.- Throws:
NoSuchElementException
- if longitudeDegrees is not present
-
getLongitudeMinutes
org.opendaylight.yangtools.yang.common.Uint8 getLongitudeMinutes()Return longitudeMinutes, ornull
if it is not present.Minutes of longitude.
- Returns:
Uint8
longitudeMinutes, ornull
if it is not present.
-
requireLongitudeMinutes
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireLongitudeMinutes()Return longitudeMinutes, guaranteed to be non-null.Minutes of longitude.
- Returns:
Uint8
longitudeMinutes, guaranteed to be non-null.- Throws:
NoSuchElementException
- if longitudeMinutes is not present
-
getLongitudeSeconds
org.opendaylight.yangtools.yang.common.Uint8 getLongitudeSeconds()Return longitudeSeconds, ornull
if it is not present.Seconds of longitude.
- Returns:
Uint8
longitudeSeconds, ornull
if it is not present.
-
requireLongitudeSeconds
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireLongitudeSeconds()Return longitudeSeconds, guaranteed to be non-null.Seconds of longitude.
- Returns:
Uint8
longitudeSeconds, guaranteed to be non-null.- Throws:
NoSuchElementException
- if longitudeSeconds is not present
-
getAltitude
Integer getAltitude()Return altitude, ornull
if it is not present.Height relative to sea level in meters.
- Returns:
Integer
altitude, ornull
if it is not present.
-
requireAltitude
Return altitude, guaranteed to be non-null.Height relative to sea level in meters.
- Returns:
Integer
altitude, guaranteed to be non-null.- Throws:
NoSuchElementException
- if altitude is not present
-
getAddress
SimpleAddress getAddress()Return address, ornull
if it is not present.AFI address.
- Returns:
SimpleAddress
address, ornull
if it is not present.
-
requireAddress
Return address, guaranteed to be non-null.AFI address.
- Returns:
SimpleAddress
address, guaranteed to be non-null.- Throws:
NoSuchElementException
- if address is not present
-