NumberTree Class Documentation

classNumberTree

Namespace:datalogics_interface

Detailed Description

The number tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary.

A number tree uses keys that are integers to map to data objects, sorted in ascending numerical order.

Uses types

PDFDictPDFObject

Constructor & Destructor Documentation

NumberTree

NumberTree(Document &doc)

Parameters

doc: Document &

The Document in which to create the NumberTree.

Creates a new, empty NumberTree in the specified Document.

~NumberTree

~NumberTree()

Member Function Documentation

get

std::unique_ptr< PDFObject >get(int32_tkey)

Parameters

key: int32_t

The integer key of the PDFObject to get from the tree.

Returns:

The PDFObject value corresponding to the supplied key.

Retrieves an entry from this NumberTree.

get_pdf_dict

PDFDictget_pdf_dict()

Returns:

The PDFDict representing the NumberTree's data structure.

Gets the underlying PDFDict of this NumberTree.

put

voidput(int32_tkey, PDFObject &value)

Parameters

key: int32_t

- The integer of the PDFObject to put in the tree.

value: PDFObject &

- The PDFObject to be associated with key.

Returns:

void

Puts a new entry in this NumberTree. If an entry with this name is already in the tree, it is replaced.

remove

voidremove(int32_tkey)

Parameters

key: int32_t

- The integer of the PDFObject to remove from the tree.

Returns:

void

Removes the specified PDFObject from this NumberTree. It does nothing if no PDFObject of that number exists in this NumberTree.