Contains all low-level Herald datatype implementations. More...

Classes
class	Base64String
	Strongly, rather than stringly, typed representation of Base64 String data. Prevents incorrect initialisation or manipulation. More...

class	DataRef
	The main data workhorse class of the Herald API. More...

class	DataSections
	Represents a fixed array of Data references using the default memory arena that tracks its own in-use size. More...

class	Date

struct	Distance

class	Distribution

class	Encounter

class	ErrorCode

class	ImmediateSendData

class	Location

struct	LocationReference

struct	MemoryArenaEntry
	Represents an external 'pointer' to an allocated memory area. More...

class	MemoryArena
	Very basic paged memory arena class. More...

class	PayloadData

struct	PayloadSharingData

struct	PayloadTimestamp

struct	PlacenameLocationReference

struct	Proximity

class	AllZerosNotRandom

class	IntegerDistributedRandomSource

class	RandomnessGenerator

class	RSSI

class	SHA256

class	TargetIdentifier

class	TimeInterval

class	UUID

struct	WGS84CircularAreaLocationReference

struct	WGS84PointLocationReference

Typedefs
using	Data = DataRef<>
	Defaults references to Data to equal the DataRef with the default Memory Arena dimensions, unless HERALD_MEMORYARENA_MAX is specified May also have its allocation size set by HERALD_MEMORYARENA_PAGE. Note this only takes affect if HERALD_MEMORYARENA_MAX is also specified.

Enumerations
enum class	BluetoothState : short { unsupported , poweredOn , poweredOff , resetting }

enum class	ProximityMeasurementUnit : short { RSSI , RTT }

enum class	SensorState : short { on , off , unavailable }

enum class	SensorType : short { BLE , GPS , BEACON , ACCELEROMETER , ULTRASOUND , OTHER }
	Sensor type as qualifier for target identifier. More...

Functions
constexpr unsigned long	pagesRequired (std::size_t size, std::size_t pageSize)

std::string	str (SensorType t) noexcept

Detailed Description

Contains all low-level Herald datatype implementations.

Enumeration Type Documentation

strong

Enumerator
on	Sensor is powered on, active and operational.
off	Sensor is powered off, inactive and not operational.
unavailable	Sensor is not available.

strong

Sensor type as qualifier for target identifier.