This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.

GridLocationInfo2 Element Documentation

NAME

GridLocationInfo2 -- Click element;

SYNOPSIS

GridLocationInfo2(LATITUDE, LONGITUDE [, HEIGHT, KEYWORDS])

Ports: None
Package: grid (core)

DESCRIPTION

This element implements the GridGenericLocInfo interface. Unlike GridLocationInfo, this element can work in the kernel. LATITUDE and LONGITUDE are in milliseconds. Positive is North and East, negative is South and West. HEIGHT is in millimetres, positive is up. All are integers. Keyword arguments are:

LOC_GOOD
Boolean. If true, it means the location information (including error radius) can be believed. If false, don't believe the hype, it's a sequel, i.e. it's all bogus.
ERR_RADIUS
Unsigned short. The error radius in metres. The node's actual location is within a circle of ERR_RADIUS metres, centered at the supplied location.
TAG
String. A symbolic name used to identify this node's location, e.g. "ne43-521b", or "Robert's office".

ELEMENT HANDLERS

loc (read/write)
When reading, returns the element's location information, in this format: ``lat, lon, height (err=<err-radius> good=<good?> seq=<seq>). <err-radius> is in metres, <good?> is "yes" or "no", indicating whether the location information is at all valid (i.e. don't believe any of it unless <good?> is "yes"), and <seq> is the location sequence number; it changes every time the location or other parameters change. When writing, use the same syntax as the configuration arguments. ? tag (read/write) ! Read/write the location tag. Read format is: ``tag=<tag>.

SEE ALSO

FixSrcLoc, GridLocationInfo

Generated by 'click-elem2man' from '../elements/grid/gridlocationinfo2.hh' on 24/May/2007.

COMMENTS

 
elements/gridlocationinfo2.txt · Last modified: 2007/05/24 00:16 (external edit)
 
Recent changes RSS feed Driven by DokuWiki