Package onep :: Package location :: Module location
[frames] | no frames]

Module location

Classes
  CivicLocation
LocationCivic consists of a standard CAType constant and the associated value.
  CustomLocation
The Cisco Custom location type allows specification of multiple arbitrary name and value pairs, in order to describe a location.
  GeoLocation
GeoLocation contains geographic (GPS) location information for an object in agreement with RFC 3825.
  LocationChangeFilter
The LocationChangeFilter is passed to Location.add_change_listener() when configuring for notification of location change events.
  LocationChangeListener
The listener interface for receiving location change events.
  LocationChangeEvent
The LocationChangeEvent is sent whenever a Location related event notification is needed.
  Location
Location class stores all information related to physical location in the real world.
Functions
 
fromIDL(idl)
Convert from NetworkLocationIDL to Location.
Variables
  AltType = enum(LOCATION_ALT_TYPE_METERS= 1, LOCATION_ALT_TYPE_...
Location Subtype definitions.
  LocationSubtype = enum(LOCATION_TYPE_NONE= 0x0, LOCATION_TYPE_...
Location Standardized Civic CAtype numbers.
  CivicType = enum(LOCATION_CIVIC_COUNTY= 1, LOCATION_CIVIC_CITY...
  LocationHandleType = enum(LocElementHandle= 0, LocInterfaceHan...
  LocationChangeEventChanger = enum(LOCATION_CHNG_NONE= 0, LOCAT...
Function Details

fromIDL(idl)

 

Convert from NetworkLocationIDL to Location. For internal use only


Variables Details

AltType

Location Subtype definitions.

These definitions are used to specify different types of Location information. The bit definitions mirror those internally used inside IOS.

Value:
enum(LOCATION_ALT_TYPE_METERS= 1, LOCATION_ALT_TYPE_FLOORS= 2, LOCATIO\
N_ALT_TYPE_FEET= 15)

LocationSubtype

Location Standardized Civic CAtype numbers.

These Civic Address type (CAtype) numbers come from RFC 4776, except for "LOCATION_CIVIC_COUNTRY". LOCATION_CIVIC_COUNTRY is used to access the country code information associated with the Civic Address elements.

Value:
enum(LOCATION_TYPE_NONE= 0x0, LOCATION_TYPE_GEO= 0x1, LOCATION_TYPE_CI\
VIC= 0x2, LOCATION_TYPE_ELIN= 0x4, LOCATION_TYPE_CUSTOM= 0x8)

CivicType

Value:
enum(LOCATION_CIVIC_COUNTY= 1, LOCATION_CIVIC_CITY= 2, LOCATION_CIVIC_\
CITY_DIVISION= 3, LOCATION_CIVIC_NEIGHBORHOOD= 4, LOCATION_CIVIC_STREE\
T_GROUP= 5, LOCATION_CIVIC_RES_7= 6, LOCATION_CIVIC_RES_8= 7, LOCATION\
_CIVIC_RES_9= 8, LOCATION_CIVIC_RES_10= 9, LOCATION_CIVIC_RES_11= 10, \
LOCATION_CIVIC_RES_12= 11, LOCATION_CIVIC_RES_13= 12, LOCATION_CIVIC_R\
ES_14= 13, LOCATION_CIVIC_RES_15= 14, LOCATION_CIVIC_LEADING_STREET_DI\
R= 15, LOCATION_CIVIC_TRAILING_STREET_SUFFIX= 16, LOCATION_CIVIC_STREE\
T_SUFFIX= 17, LOCATION_CIVIC_STREET_NUMBER= 18, LOCATION_CIVIC_STREET_\
...

LocationHandleType

Value:
enum(LocElementHandle= 0, LocInterfaceHandle= 1)

LocationChangeEventChanger

Value:
enum(LOCATION_CHNG_NONE= 0, LOCATION_CHNG_CLI= 1, LOCATION_CHNG_NMSP= \
2, LOCATION_CHNG_SNMP= 3, LOCATION_CHNG_CDP= 4, LOCATION_CHNG_LLDP= 5,\
 LOCATION_CHNG_ONEP= 6)