IVector< nam, rdOnly, Opts > Struct Template Reference

A vector of a variable number of read-only options. More...

#include "IOption.hpp"

+ Inheritance diagram for IVector< nam, rdOnly, Opts >:

Additional Inherited Members

- Public Types inherited from IContainer< nam, rdOnly, Opts... >
typedef NameT< nam > Name
typedef IGroup< nam, rdOnly, Opts... > Element
- Public Member Functions inherited from IContainer< nam, rdOnly, Opts... >
virtual std::size_t size () const=0
 The number of actual elements.
virtual const Elementall () const=0
 Access the default element. More...
virtual const Elementoperator[] (std::size_t idx) const=0
 Access an actual element.
- 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, bool rdOnly, class... Opts>
struct opals::opts::IVector< nam, rdOnly, Opts >

A vector of a variable number of read-only options.

Template Parameters
namThe name of the vector and its elements.
rdOnlyIf true, then this vector provides only constant access to its elements. Otherwise, also non-constant.
OptsThe sequence of group members.