Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.geo.coordinates

Interface GeoCoordinates

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<GeoCoordinates>, 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:
    GeoCoordinatesBuilder

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

        default java.lang.Class<GeoCoordinates> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull GeoCoordinates obj)
        Default implementation of Object.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:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull GeoCoordinates thisObj,
                             java.lang.Object obj)
        Default implementation of Object.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 invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull GeoCoordinates obj)
        Default implementation of Object.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:
        java.lang.NullPointerException - if obj is null

      • getLatitude

        GeoCoordinates.Latitude getLatitude()
        Return latitude, or null if it is not present. 
             
         Bit that selects between North and South latitude.
        Returns:
        Latitude latitude, or null if it is not present.

      • requireLatitude

        default @NonNull GeoCoordinates.Latitude 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:
        java.util.NoSuchElementException - if latitude is not present

      • getLatitudeDegrees

        org.opendaylight.yangtools.yang.common.Uint8 getLatitudeDegrees()
        Return latitudeDegrees, or null if it is not present. 
             
         Degrees of latitude.
        Returns:
        Uint8 latitudeDegrees, or null 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:
        java.util.NoSuchElementException - if latitudeDegrees is not present

      • getLatitudeMinutes

        org.opendaylight.yangtools.yang.common.Uint8 getLatitudeMinutes()
        Return latitudeMinutes, or null if it is not present. 
             
         Minutes of latitude.
        Returns:
        Uint8 latitudeMinutes, or null 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:
        java.util.NoSuchElementException - if latitudeMinutes is not present

      • getLatitudeSeconds

        org.opendaylight.yangtools.yang.common.Uint8 getLatitudeSeconds()
        Return latitudeSeconds, or null if it is not present. 
             
         Seconds of latitude.
        Returns:
        Uint8 latitudeSeconds, or null 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:
        java.util.NoSuchElementException - if latitudeSeconds is not present

      • getLongitude

        GeoCoordinates.Longitude getLongitude()
        Return longitude, or null if it is not present. 
             
         Bit that selects between East and West longitude.
        Returns:
        Longitude longitude, or null if it is not present.

      • requireLongitude

        default @NonNull GeoCoordinates.Longitude 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:
        java.util.NoSuchElementException - if longitude is not present

      • getLongitudeDegrees

        org.opendaylight.yangtools.yang.common.Uint16 getLongitudeDegrees()
        Return longitudeDegrees, or null if it is not present. 
             
         Degrees of longitude.
        Returns:
        Uint16 longitudeDegrees, or null 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:
        java.util.NoSuchElementException - if longitudeDegrees is not present

      • getLongitudeMinutes

        org.opendaylight.yangtools.yang.common.Uint8 getLongitudeMinutes()
        Return longitudeMinutes, or null if it is not present. 
             
         Minutes of longitude.
        Returns:
        Uint8 longitudeMinutes, or null 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:
        java.util.NoSuchElementException - if longitudeMinutes is not present

      • getLongitudeSeconds

        org.opendaylight.yangtools.yang.common.Uint8 getLongitudeSeconds()
        Return longitudeSeconds, or null if it is not present. 
             
         Seconds of longitude.
        Returns:
        Uint8 longitudeSeconds, or null 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:
        java.util.NoSuchElementException - if longitudeSeconds is not present

      • getAltitude

        java.lang.Integer getAltitude()
        Return altitude, or null if it is not present. 
             
         Height relative to sea level in meters.
        Returns:
        Integer altitude, or null if it is not present.

      • requireAltitude

        default @NonNull java.lang.Integer requireAltitude()
        Return altitude, guaranteed to be non-null. 
             
         Height relative to sea level in meters.
        Returns:
        Integer altitude, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if altitude is not present

      • getAddress

        SimpleAddress getAddress()
        Return address, or null if it is not present. 
             
         AFI address.
        Returns:
        SimpleAddress address, or null if it is not present.

      • requireAddress

        default @NonNull SimpleAddress requireAddress()
        Return address, guaranteed to be non-null. 
             
         AFI address.
        Returns:
        SimpleAddress address, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if address is not present