OptionsFromStreamPack::SetOptionsFromStreamNode Class Reference

Node class for setting options from a stream. More...

#include <OptionsFromStreamPack_SetOptionsFromStreamNode.hpp>

Inheritance diagram for OptionsFromStreamPack::SetOptionsFromStreamNode:

[legend]List of all members.

Public Member Functions
	SetOptionsFromStreamNode (const std::string &options_group, int num_options, const char *option_names[], bool exists_optional=true)
	Constructs with the name of the options group and the names of the options.
void	set_options (const OptionsFromStream &options)
	Overridden from SetOptionsFromStream and calls setOption(...).
Protected Member Functions
virtual void	setOption (int option_num, const std::string &option_value)=0
	To be overridden by the subclass to set an option given its integer position and the option value.

---

Detailed Description

Node class for setting options from a stream.

This class uses the template method pattern to delegate the setting of options.

Definition at line 42 of file OptionsFromStreamPack_SetOptionsFromStreamNode.hpp.

---

Constructor & Destructor Documentation

OptionsFromStreamPack::SetOptionsFromStreamNode::SetOptionsFromStreamNode (  const std::string &  options_group, int  num_options, const char *  option_names[], bool  exists_optional = true )

Constructs with the name of the options group and the names of the options. Parameters: options_group  The name of the options group to access num_options  The number of options in the opitons group. option_name  An array (length num_options) containing the names of the options. exists_optional  Specifies if the options group must exist. Definition at line 37 of file OptionsFromStreamPack_SetOptionsFromStreamNode.cpp.

---

Member Function Documentation

void OptionsFromStreamPack::SetOptionsFromStreamNode::set_options (  const OptionsFromStream &  options  )  [virtual]

Overridden from SetOptionsFromStream and calls setOption(...). The options group #options_group# is used. If this options group does not exist and #exists_optional# == false then an #std::invalid_argument# exception will be thrown. Implements OptionsFromStreamPack::SetOptionsFromStream. Definition at line 43 of file OptionsFromStreamPack_SetOptionsFromStreamNode.cpp.

virtual void OptionsFromStreamPack::SetOptionsFromStreamNode::setOption (  int  option_num, const std::string &  option_value )  [protected, pure virtual]

To be overridden by the subclass to set an option given its integer position and the option value. The integer possition returned is the possition of the option in option_names[option_num] that was passed to the constructor.

---

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

• OptionsFromStreamPack_SetOptionsFromStreamNode.hpp
• OptionsFromStreamPack_SetOptionsFromStreamNode.cpp

---