Drake
Drake C++ Documentation
PendulumParamsIndices Struct Reference

Detailed Description

Describes the row indices of a PendulumParams.

#include <drake/examples/pendulum/pendulum_params.h>

Static Public Member Functions

static const std::vector< std::string > & GetCoordinateNames ()
 Returns a vector containing the names of each coordinate within this class. More...
 

Static Public Attributes

static const int kNumCoordinates = 4
 The total number of rows (coordinates). More...
 
static const int kMass = 0
 
static const int kLength = 1
 
static const int kDamping = 2
 
static const int kGravity = 3
 

Member Function Documentation

◆ GetCoordinateNames()

static const std::vector<std::string>& GetCoordinateNames ( )
static

Returns a vector containing the names of each coordinate within this class.

The indices within the returned vector matches that of this class. In other words, PendulumParamsIndices::GetCoordinateNames()[i] is the name for BasicVector::GetAtIndex(i).

Member Data Documentation

◆ kDamping

const int kDamping = 2
static

◆ kGravity

const int kGravity = 3
static

◆ kLength

const int kLength = 1
static

◆ kMass

const int kMass = 0
static

◆ kNumCoordinates

const int kNumCoordinates = 4
static

The total number of rows (coordinates).


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