mgrs-ios 1.1.6 Documentation

Class Grid​Zone

public class GridZone  
  • Grid Zone

Initializers

init(_:​_:​)

public init(_ strip: LongitudinalStrip, _ band: LatitudeBand)  
  • Constructor
  • @param strip
  •        longitudinal strip
    
  • @param band
  •        latitude band
    

Properties

strip

public let strip: LongitudinalStrip
  • Longitudinal strip

band

public let band: LatitudeBand
  • Latitude band

bounds

public let bounds: Bounds
  • Bounds

Methods

number()

public func number() -> Int  
  • Get the zone number
  • @return zone number

letter()

public func letter() -> Character  
  • Get the band letter
  • @return band letter

hemisphere()

public func hemisphere() -> Hemisphere  
  • Get the hemisphere
  • @return hemisphere

name()

public func name() -> String  
  • Get the label name
  • @return name

is​Within(_:​)

public func isWithin(_ bounds: Bounds) -> Bool  
  • Is the provided bounds within the zone bounds
  • @param bounds
  •        bounds
    
  • @return true if within bounds

strip​Expand()

public func stripExpand() -> Int  
  • Get the longitudinal strip expansion, number of additional neighbors to
  • iterate over in combination with this strip
  • @return longitudinal strip neighbor iteration expansion

lines(_:​)

public func lines(_ gridType: GridType) -> [MGRSLine]?  
  • Get the grid zone lines
  • @param gridType
  •        grid type
    
  • @return lines

lines(_:​_:​)

public func lines(_ tileBounds: Bounds, _ gridType: GridType) -> [MGRSLine]?  
  • Get the grid zone lines
  • @param tileBounds
  •        tile bounds
    
  • @param gridType
  •        grid type
    
  • @return lines

draw​Bounds(_:​_:​)

public func drawBounds(_ tileBounds: Bounds, _ gridType: GridType) -> Bounds?  
  • Get the draw bounds of easting and northing in meters
  • @param tileBounds
  •        tile bounds
    
  • @param gridType
  •        grid type
    
  • @return draw bounds or null