obx::LeavesInfo Class Reference

Information about a set of leaf nodes that is returned by TreeCursor::getLeavesInfo(). Contains meta data about (data) leaves: full path in the tree, ID, and property type. More...

#include <objectbox.hpp>

Public Member Functions
	~LeavesInfo ()
size_t	size ()
	Gets the number of leaves.
const char *	leafPathCString (size_t index)
	Gets the path of a given leaf (by index).
std::string	leafPath (size_t index)
	Gets the path of a given leaf (by index).
OBXPropertyType	leafPropertyType (size_t index)
	Gets the property type (as OBXPropertyType) of a given leaf (by index).
obx_id	leafId (size_t index)
	Gets the id of a given leaf (by index).

Detailed Description

Information about a set of leaf nodes that is returned by TreeCursor::getLeavesInfo(). Contains meta data about (data) leaves: full path in the tree, ID, and property type.

Constructor & Destructor Documentation

~LeavesInfo()

obx::LeavesInfo::~LeavesInfo ( )

inline

Member Function Documentation

leafId()

obx_id obx::LeavesInfo::leafId ( size_t  index )

inline

Gets the id of a given leaf (by index).

leafPath()

std::string obx::LeavesInfo::leafPath ( size_t  index )

inline

Gets the path of a given leaf (by index).

leafPathCString()

const char * obx::LeavesInfo::leafPathCString ( size_t  index )

inline

Gets the path of a given leaf (by index).

Returns

a C string that is valid until

leafPropertyType()

OBXPropertyType obx::LeavesInfo::leafPropertyType ( size_t  index )

inline

Gets the property type (as OBXPropertyType) of a given leaf (by index).

Returns

OBXPropertyType_Unknown if no property type was found.

size()

size_t obx::LeavesInfo::size ( )

inline

Gets the number of leaves.