Package com.trx.neon.api.neonConstraint.model

Class ElevationInfo

java.lang.Object

com.trx.neon.api.neonConstraint.model.ElevationInfo

All Implemented Interfaces:

android.os.Parcelable

public class ElevationInfo
extends java.lang.Object
implements android.os.Parcelable

ElevationInfo specifies the elevation of an entity. Entities can be marked as being outside on the terrain or inside a specific building on a floor. They can also be marked as containing no elevation information, in which case any constraint will only affect 2D position. Created by John on 7/1/2016.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElevationInfo.AltitudeType	Represents the type of altitude info for an entity
static class	ElevationInfo.ElevationType	Represents the type of elevation info for an entity

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
float	Altitude	Value representing the altitude
float	AltitudeError	Value representing the altitude error
ElevationInfo.AltitudeType	AltType	Value representing the altitude type
static android.os.Parcelable.Creator<ElevationInfo>	CREATOR	Used for sending data across binders
double	Floor	Value representing the floor index
java.util.UUID	StructureID	Optional building identifier
ElevationInfo.ElevationType	Type	Represents the type of elevation info for an entity

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
ElevationInfo(android.os.Parcel in)

Method Summary

Modifier and Type	Method	Description
static ElevationInfo	AtAltitude(ElevationInfo.AltitudeType type, float meters, float metersError)	The entity is at the specified altitude in meters above mean sea level with the specified error in meters
int	describeContents()
static ElevationInfo	None()	There is no elevation info associated with this entity or constraint - only constrain in 2D
static ElevationInfo	OnFloor(java.util.UUID structureID, int floor)	The entity is on a building floor with a known id and zero-indexed floor number
static ElevationInfo	OnTerrain()	The entity is outside (not in a building) and placed on the terrain
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Type

public final ElevationInfo.ElevationType Type

Represents the type of elevation info for an entity

StructureID

public final java.util.UUID StructureID

Optional building identifier

Floor

public final double Floor

Value representing the floor index

AltType

public final ElevationInfo.AltitudeType AltType

Value representing the altitude type

Altitude

public final float Altitude

Value representing the altitude

AltitudeError

public final float AltitudeError

Value representing the altitude error

CREATOR

public static final android.os.Parcelable.Creator<ElevationInfo> CREATOR

Used for sending data across binders

Constructor Detail

ElevationInfo

public ElevationInfo(android.os.Parcel in)

Method Detail

OnFloor

public static ElevationInfo OnFloor(java.util.UUID structureID,
                                    int floor)

The entity is on a building floor with a known id and zero-indexed floor number

Parameters:

structureID - The identifier for a building, which can be retrieved with the NeonEnvironment API.

floor - The zero-based index of the floor

Returns:

An ElevationInfo object for a building and floor

OnTerrain

public static ElevationInfo OnTerrain()

The entity is outside (not in a building) and placed on the terrain

Returns:

An ElevationInfo object for on terrain

AtAltitude

public static ElevationInfo AtAltitude(ElevationInfo.AltitudeType type,
                                       float meters,
                                       float metersError)

The entity is at the specified altitude in meters above mean sea level with the specified error in meters

Returns:

An ElevationInfo object for at altitude

None

public static ElevationInfo None()

There is no elevation info associated with this entity or constraint - only constrain in 2D

Returns:

An ElevationInfo object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object