List of all members | Public Member Functions | Public Attributes
casadi::Options::Entry Struct Reference

#include <options.hpp>

Detailed Description

Definition at line 46 of file options.hpp.

Public Member Functions

void disp (const std::string &name, std::ostream &stream) const
 

Public Attributes

TypeID type
 
std::string description
 

Member Function Documentation

◆ disp()

void casadi::Options::Entry::disp ( const std::string &  name,
std::ostream &  stream 
) const

Definition at line 48 of file options.cpp.

48  {
49  stream << "> \"" << name << "\" ["
50  << GenericType::get_type_description(this->type)
51  << "] ";
52 
53  // Print out the description on a new line.
54  stream << " \"" << this->description << "\""<< std::endl;
55  }
casadi::GenericType::get_type_description
static std::string get_type_description(TypeID type)
Get a description of a type.
Definition: generic_type.cpp:119
casadi::Options::Entry::description
std::string description
Definition: options.hpp:48

References description, casadi::GenericType::get_type_description(), and type.

Referenced by casadi::Options::print_one().

Member Data Documentation

◆ description

std::string casadi::Options::Entry::description

Definition at line 48 of file options.hpp.

Referenced by disp(), and casadi::Options::info().

◆ type

TypeID casadi::Options::Entry::type

Definition at line 47 of file options.hpp.

Referenced by casadi::Options::check(), disp(), and casadi::Options::type().

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