Libpf::Utility::EnumeratorInterface Class Reference

Abstract interface for static and dynamics enumerators. More...

#include <EnumeratorInterface.h>

Inheritance diagram for Libpf::Utility::EnumeratorInterface:

Public Member Functions
virtual	~EnumeratorInterface ()=default
virtual const std::string &	name (void) const =0
virtual const std::string &	description (void) const =0
virtual std::vector< Option >::const_iterator	options_cbegin () const =0
virtual std::vector< Option >::const_iterator	options_cend () const =0
virtual std::size_t	options_size (void) const =0
std::string	json (void) const

Detailed Description

Abstract interface for static and dynamics enumerators.

Constructor & Destructor Documentation

~EnumeratorInterface()

virtual Libpf::Utility::EnumeratorInterface::~EnumeratorInterface ( )

virtualdefault

Member Function Documentation

description()

virtual const std::string & Libpf::Utility::EnumeratorInterface::description ( void  ) const

pure virtual

Returns

the description of the enumerator

Implemented in Libpf::Core::Enumerator, and Libpf::Utility::SmartEnumerator< T >.

json()

std::string Libpf::Utility::EnumeratorInterface::json

(

void

)

const

Returns

UTF-8 encoded string with the JSON-serialized object

name()

virtual const std::string & Libpf::Utility::EnumeratorInterface::name ( void  ) const

pure virtual

Returns

the name of the enumerator

Implemented in Libpf::Core::Enumerator, and Libpf::Utility::SmartEnumerator< T >.

options_cbegin()

virtual std::vector< Option >::const_iterator Libpf::Utility::EnumeratorInterface::options_cbegin ( ) const

pure virtual

Implemented in Libpf::Core::Enumerator, and Libpf::Utility::SmartEnumerator< T >.

options_cend()

virtual std::vector< Option >::const_iterator Libpf::Utility::EnumeratorInterface::options_cend ( ) const

pure virtual

Implemented in Libpf::Core::Enumerator, and Libpf::Utility::SmartEnumerator< T >.

options_size()

virtual std::size_t Libpf::Utility::EnumeratorInterface::options_size ( void  ) const

pure virtual

Implemented in Libpf::Core::Enumerator, and Libpf::Utility::SmartEnumerator< T >.

---

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

• EnumeratorInterface.h