Aria  2.8.0
ArMapSupplementInterface Class Referenceabstract

Methods related to miscellaneous extra data in an Aria map. More...

#include <ArMapInterface.h>

Inherited by ArMapInterface, and ArMapSupplement.

Public Member Functions

 ArMapSupplementInterface ()
 Default constructor.
 
virtual double getOriginAltitude ()=0
 Gets the altitude of the origin; valid only if hasOriginLatLongAlt returns true. More...
 
virtual ArPose getOriginLatLong ()=0
 Returns the latitude/longitude origin; valid only if hasOriginLatLongAlt returns true.
 
virtual bool hasOriginLatLongAlt ()=0
 Returns whether this map has an origin specified in latitude/longitude (and altitude)
 
virtual void setOriginLatLongAlt (bool hasOriginLatLong, const ArPose &originLatLong, double altitude, ArMapChangeDetails *changeDetails=NULL)=0
 Sets the latitude/longitude and altitude of the origin. More...
 
virtual void writeSupplementToFunctor (ArFunctor1< const char *> *functor, const char *endOfLineChars)=0
 Writes the supplemental data to the given functor. More...
 
virtual ~ArMapSupplementInterface ()
 Destructor.
 

Detailed Description

Methods related to miscellaneous extra data in an Aria map.

ArMapSupplementInterface is basically a repository for any pieces of data that do not fit in the other categories (i.e. scan data, map objects, or info). It currently stores the optional latitude/longitude information.

Member Function Documentation

◆ getOriginAltitude()

virtual double ArMapSupplementInterface::getOriginAltitude ( )
pure virtual

Gets the altitude of the origin; valid only if hasOriginLatLongAlt returns true.

Returns
double the altitude (in meters) of the origin

Implemented in ArMapSupplement.

◆ setOriginLatLongAlt()

virtual void ArMapSupplementInterface::setOriginLatLongAlt ( bool  hasOriginLatLong,
const ArPose originLatLong,
double  altitude,
ArMapChangeDetails changeDetails = NULL 
)
pure virtual

Sets the latitude/longitude and altitude of the origin.

Parameters
hasOriginLatLonga bool set to true if the map has latitude/longitude information for the origin
originLatLongthe ArPose that specifies the latitude/longitude of the origin
altitudethe double altitude (in meters) of the origin
changeDetailsa pointer to the optional ArMapChangeDetails in which to store a description of the changes to the scan data; if NULL then the changes are not tracked.

◆ writeSupplementToFunctor()

virtual void ArMapSupplementInterface::writeSupplementToFunctor ( ArFunctor1< const char *> *  functor,
const char *  endOfLineChars 
)
pure virtual

Writes the supplemental data to the given functor.

Parameters
functorthe ArFunctor1 to which to write the supplemental data (as text lines)
endOfLineCharsthe const char * string to be appended to the end of each text line

The documentation for this class was generated from the following file: