ControlParameterCollection Class Reference

#include <ControlParameters.h>

Collaboration diagram for ControlParameterCollection:

Public Member Functions
	ControlParameterCollection (const std::string &name)
void	addParameter (ControlParameter *param, const std::string &name)
ControlParameter &	lookup (const std::string &name)
std::string	printToIniString ()
	print all control parameters in the INI file format More...
std::string	printToYamlString ()
bool	checkIfAllSet ()
	are all the control parameters initialized? More...
void	clearAllSet ()
void	deleteAll ()

Public Attributes
std::map< std::string, ControlParameter * >	_map

Private Attributes
std::string	_name

Detailed Description

ControlParameterCollections contains a map of all the control parameters.

Definition at line 71 of file ControlParameters.h.

Constructor & Destructor Documentation

ControlParameterCollection::ControlParameterCollection ( const std::string &  name )

inlineexplicit

Definition at line 73 of file ControlParameters.h.

: _name(name) {}

Member Function Documentation

void ControlParameterCollection::addParameter ( ControlParameter *  param, const std::string &  name  )

inline

Use this to add a parameter for the first time in the RobotControlParameters or SimulatorControlParameters This should only be used during initialization of a ControlParameter

Definition at line 80 of file ControlParameters.h.

References mapContains().

                                                                    {
    if (mapContains(_map, name)) {
      printf(
          "[ERROR] ControlParameterCollection %s: tried to add parameter %s "
          "twice!\n",
          _name.c_str(), name.c_str());
      throw std::runtime_error("control parameter error");
    }
    _map[name] = param;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool ControlParameterCollection::checkIfAllSet

(

)

are all the control parameters initialized?

Definition at line 67 of file ControlParameters.cpp.

References _map.

                                               {
  for (auto& kv : _map) {
    if (!kv.second->_set) {
      return false;
    }
  }
  return true;
}

Here is the caller graph for this function:

void ControlParameterCollection::clearAllSet

(

)

Definition at line 76 of file ControlParameters.cpp.

References _map.

                                             {
  for (auto& kv : _map) {
    kv.second->_set = false;
  }
}

Here is the caller graph for this function:

void ControlParameterCollection::deleteAll

(

)

Definition at line 82 of file ControlParameters.cpp.

References _map.

                                           {
  for(auto& kv : _map) {
    delete kv.second;
  }
  _map.clear();
}

Here is the caller graph for this function:

ControlParameter& ControlParameterCollection::lookup ( const std::string &  name )

inline

Lookup a control parameter by its name. This does not modify the set field of the control parameter!

Definition at line 95 of file ControlParameters.h.

References mapContains().

                                                  {
    if (mapContains(_map, name)) {
      return *_map[name];
    } else {
      // for now:
      throw std::runtime_error("parameter " + name +
                               " wasn't found in parameter collection " +
                               _name);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

std::string ControlParameterCollection::printToIniString

(

)

print all control parameters in the INI file format

Definition at line 100 of file ControlParameters.cpp.

References _map, _name, and getCurrentTimeAndDate().

                                                       {
  std::string result = ";; Generated on " + getCurrentTimeAndDate() + "\n";

  // ini section
  result += "[";
  result += _name + "]\n\n";

  std::vector<std::string> lines;

  // names (and max name length)
  int maxLength_name = 0;
  for (auto& kv : _map) {
    maxLength_name = std::max(maxLength_name, (int)kv.first.length());
    lines.push_back(kv.first);
  }

  // pad, equals sign, and number
  size_t i = 0;
  int maxLength_number = 0;
  for (auto& kv : _map) {
    int charsToAdd = maxLength_name - (int)lines[i].length();
    assert(charsToAdd >= 0);
    for (int j = 0; j < charsToAdd; j++) {
      lines[i].push_back(' ');
    }
    lines[i] += " = ";
    lines[i] += kv.second->toString();
    maxLength_number = std::max(maxLength_number, (int)lines[i].length());
    i++;
  }

  // pad, ;;, and units
  i = 0;
  for (auto& kv : _map) {
    int charsToAdd = maxLength_number - (int)lines[i].length();
    assert(charsToAdd >= 0);
    for (int j = 0; j < charsToAdd; j++) {
      lines[i].push_back(' ');
    }
    lines[i] += " ;; ";
    if (kv.second->_units.empty()) {
      lines[i] += "No units specified.  Add them!";
    } else {
      lines[i] += kv.second->_units;
    }

    i++;
  }

  // combine lines
  for (auto& line : lines) {
    result += line + "\n";
  }

  return result;
}

Here is the call graph for this function:

std::string ControlParameterCollection::printToYamlString

(

)

print all control parameters in the YAML file format

Definition at line 157 of file ControlParameters.cpp.

References _map, _name, getCurrentTimeAndDate(), and YAML_COLLECTION_NAME_KEY.

                                                        {
  std::string result = "# Generated on " + getCurrentTimeAndDate() + "\n";

  result += YAML_COLLECTION_NAME_KEY;
  result += ": ";
  result += _name + "\n\n";

  std::vector<std::string> lines;

  // names
  int maxLength_name = 0;
  for (auto& kv : _map) {
    maxLength_name = std::max(maxLength_name, (int)kv.first.length());
    lines.push_back(kv.first);
  }

  // name pad, :, and number
  size_t i = 0;
  int maxLength_number = 0;
  for (auto& kv : _map) {
    int charsToAdd = maxLength_name - (int)lines[i].length();
    assert(charsToAdd >= 0);
    for (int j = 0; j < charsToAdd; j++) {
      lines[i].push_back(' ');
    }
    lines[i] += ": ";
    lines[i] += kv.second->toString();
    maxLength_number = std::max(maxLength_number, (int)lines[i].length());
    i++;
  }

  // combine lines
  for (auto& line : lines) {
    result += line + "\n";
  }

  return result;
}

Here is the call graph for this function:

Member Data Documentation

std::map<std::string, ControlParameter*> ControlParameterCollection::_map

Definition at line 114 of file ControlParameters.h.

std::string ControlParameterCollection::_name

private

Definition at line 117 of file ControlParameters.h.

---

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

• ControlParameters.h
• ControlParameters.cpp