Packagenet.systemeD.halcyon.connection
Classpublic class Marker
InheritanceMarker Inheritance Entity Inheritance flash.events.EventDispatcher

A marker is a generic entity that can be used for representing non-Node point features. For example, it can be used for displaying bug reports or waypoints on VectorBackground layers



Public Properties
 PropertyDefined by
 Inheritedconnection : Connection
Connection to which this entity belongs.
Entity
 Inheriteddeleted : Boolean = false
Entity
 Inheritedentities : Array
List of entities.
Entity
 InheritedhasParents : Boolean
Whether this entity has any parents.
Entity
 InheritedhasParentWays : Boolean
Whether this entity has any parents that are Ways.
Entity
 Inheritedid : Number
OSM ID.
Entity
 InheritedisDirty : Boolean
Check if entity is modified since last markClean().
Entity
  lat : Number
[read-only]
Marker
  latp : Number
[read-only]
Marker
 Inheritedloaded : Boolean
Is entity fully loaded, or is it just a placeholder reference (as a relation member)?
Entity
 Inheritedlocked : Boolean = false
Lock against purging when off-screen
Entity
  lon : Number
[read-only]
Marker
 Inheritedmemberships : Array
Returns all relations that this Entity is part of, as array of {relation, position, role}, sorted by position.
Entity
 InheritednumParentWays : uint
How many parents are Ways?
Entity
 InheritedparentObjects : Array
All parents of this entity.
Entity
 InheritedparentRelations : Array
All parents that are Relations
Entity
 InheritedparentsLoaded : Boolean = true
Have all its parents (ie, relations that contain this object as a member, ways that contain this node) been loaded into memory
Entity
 InheritedparentWays : Array
Get array of all Ways of which this object (presumably a node) is a child.
Entity
 Inheritedstatus : String
Entity
 Inheritedtimestamp : String
Most recent modification of the entity (from OSM API).
Entity
 Inheriteduid : Number
User ID who last edited this entity (from OSM API).
Entity
 Inheritedversion : uint
Current version number.
Entity
Public Methods
 MethodDefined by
  
Marker(connection:Connection, id:Number, version:uint, tags:Object, loaded:Boolean, lat:Number, lon:Number)
Marker
 Inherited
addParent(parent:Entity):void
Create parent link from this entity to another.
Entity
 Inherited
countParentObjects(within:Object):uint
How many parents does this entity have that satisfy the "within" constraint?
Entity
 Inherited
findParentRelationsOfType(type:String, role:String = null):Array
Returns parents that are relations, and of the specified type, and of which this entity is the correct role (if provided).
Entity
 Inherited
getDescription():String
Basic description of Entity - should be overriden by subclass.
Entity
 Inherited
Entity
 Inherited
getTag(key:String):String
Retrieve a tag by key.
Entity
 Inherited
getTagArray():Array
Returns an array that duplicates the tags on this entity.
Entity
 Inherited
Entity
 Inherited
getTagsCopy():Object
Returns an object that duplicates the tags on this entity.
Entity
 Inherited
getTagsHash():Object
Entity
  
getType():String
Marker
 Inherited
Whether the entity has any tags other than meta-tags (attribution, created_by, source, tiger:...)
Entity
 Inherited
hasParent(entity:Entity):Boolean
Whether 'entity' is a parent of this Entity.
Entity
 Inherited
hasTags():Boolean
Whether the entity has > 0 tags.
Entity
 Inherited
isDeleted():Boolean
Whether entity is marked deleted.
Entity
 Inherited
isEmpty():Boolean
Whether entity is "empty" - to be overridden by subclass.
Entity
 Inherited
isType(str:String):Boolean
Compare type against supplied string
Entity
 Inherited
isUneditedTiger():Boolean
Rough function to detect entities untouched since TIGER import.
Entity
  
lat2latp(lat:Number):Number
[static]
Marker
  
latp2lat(a:Number):Number
[static]
Marker
 Inherited
markClean():void
Reset modified flag.
Entity
 Inherited
markDirty():void
Set entity as modified.
Entity
 Inherited
mergeTags(source:Entity, performAction:Function):Boolean
Copy tags from another entity into this one, creating "key=value1; value2" pairs if necessary.
Entity
 Inherited
nullify():void
Free up memory by converting entity to a dummy entity, for entities that we no longer need but which are part of a still-in-memory relation
Entity
 Inherited
remove(performAction:Function):void
Delete entity - must be overridden.
Entity
 Inherited
removeFromParents(performAction:Function):void
Entity
 Inherited
removeParent(parent:Entity):void
Remove parent link.
Entity
 Inherited
renameTag(oldKey:String, newKey:String, performAction:Function):void
Change oldKey=[value] to newKey=[value], with optional undoability.
Entity
 Inherited
renumber(newID:Number, newVersion:uint):void
Assign a new ID and version.
Entity
 Inherited
resume():void
Resume redrawing of the object
Entity
 Inherited
sameTags(entity:Entity):Boolean
Compare tags between two entities.
Entity
 Inherited
setDeletedState(isDeleted:Boolean):void
Mark entity as deleted.
Entity
 Inherited
setStatus(s:String):void
Change entity status.
Entity
 Inherited
setTag(key:String, value:String, performAction:Function):void
Set key=value, with optional undoability.
Entity
 Inherited
suspend():void
Temporarily prevent redrawing of the object.
Entity
 Inherited
tagIs(key:String, value:String):Boolean
Entity
  
toString():String
Marker
 Inherited
updateEntityProperties(version:uint, tags:Object, loaded:Boolean, parentsLoaded:Boolean, uid:Number, timestamp:String):void
Set a bunch of properties in one hit.
Entity
  
within(left:Number, right:Number, top:Number, bottom:Number):Boolean
Marker
Protected Methods
 MethodDefined by
 Inherited
Implement nullifybehaviour: delete tags, etc.
Entity
Property detail
latproperty
lat:Number  [read-only]Implementation
    public function get lat():Number
latpproperty 
latp:Number  [read-only]Implementation
    public function get latp():Number
lonproperty 
lon:Number  [read-only]Implementation
    public function get lon():Number
Constructor detail
Marker()constructor
public function Marker(connection:Connection, id:Number, version:uint, tags:Object, loaded:Boolean, lat:Number, lon:Number)Parameters
connection:Connection
 
id:Number
 
version:uint
 
tags:Object
 
loaded:Boolean
 
lat:Number
 
lon:Number
Method detail
getType()method
public override function getType():String

Returns
String
lat2latp()method 
public static function lat2latp(lat:Number):NumberParameters
lat:Number

Returns
Number
latp2lat()method 
public static function latp2lat(a:Number):NumberParameters
a:Number

Returns
Number
toString()method 
public override function toString():String

Returns
String
within()method 
public override function within(left:Number, right:Number, top:Number, bottom:Number):BooleanParameters
left:Number
 
right:Number
 
top:Number
 
bottom:Number

Returns
Boolean