class P1::ImageSdk::P1MetaListIterator

Overview

#include <C_P1ImageCommonMetaData.h>

class P1MetaListIterator
{
public:
    // construction

    P1MetaListIterator(P1MetaIter* iterator);

    // methods

    void Begin();
    bool IsLast();
    std::string GetName();
    P1MetaListIterator GetListIterator();
    P1MetaDataIterator GetMetaDataIterator();
    void Next();
    P1MetaIter* GetPtr();
};

// direct descendants

class MetaListIterator;

Detailed Documentation

Methods

void Begin()

Set iterator to point to the start of dataset.

bool IsLast()

Get the name of the object the iterator currently points to.

Returns:

a string with the name of the currently selected object

std::string GetName()

Get the name of the object the iterator currently points to.

Returns:

a string with the name of the currently selected object

P1MetaListIterator GetListIterator()

Get an iterator to a metadata list that the current iterator is pointing to. A MetaList is equivalent to a directory in a filesystem and is used to organize metadata in tree like system.

Returns:

a ListIterator that the iterator is pointing to.

P1MetaDataIterator GetMetaDataIterator()

Get the metadata iterator that the iterator currently is pointing to.

Returns:

a MetaObject iterator the iterator is currently pointing to. A metaobject is equivalent to a file in a filesystem.

void Next()

forward iterator to point to the next element of dataset.