IContainer< nam, false, Opts... > Struct Template Referenceabstract

A container of read-write options. More...

#include "IOption.hpp"

+ Inheritance diagram for IContainer< nam, false, Opts... >:

Public Types

typedef NameT< nam > Name
 
typedef IGroup< nam, false, Opts... > Element
 

Public Member Functions

virtual std::size_t size () const =0
 The number of actual elements.
 
Default element.

Changes to it are applied immediately to all actual elements.

virtual const Elementall () const =0
 
virtual Elementall ()=0
 
Access an actual element.
virtual const Elementoperator[] (std::size_t idx) const =0
 
virtual Elementoperator[] (std::size_t idx)=0
 
- Public Member Functions inherited from IBase
virtual Names enumerator () const =0
 The option name as enumerator.
 
virtual String name () const =0
 The option name as string.
 
virtual String path () const =0
 The option name as string, preceded by the names of its parents, if any, interspersed with '.'.
 
virtual String shortDescription () const =0
 One-liner that describes this option.
 
virtual String longDescription () const =0
 Longer text that describes this option in more detail.
 
virtual bool readOnly () const =0
 Returns true if this or any of its parents is read-only.
 
virtual UsageLevel minUsageLevel () const =0
 For a leaf, this is its own usage level. For a node, this is the minimum usage level of all of its descendants: basic < mid < pro.
 
virtual Specs specialization () const =0
 The sub-type of this option.
 

Detailed Description

template<Names nam, class... Opts>
struct opals::opts::IContainer< nam, false, Opts... >

A container of read-write options.