Drake
Drake C++ Documentation
CartPoleParamsIndices Struct Reference

Detailed Description

Describes the row indices of a CartPoleParams.

#include <drake/examples/multibody/cart_pole/cart_pole_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 kMc = 0
 
static const int kMp = 1
 
static const int kL = 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, CartPoleParamsIndices::GetCoordinateNames()[i] is the name for BasicVector::GetAtIndex(i).

Member Data Documentation

◆ kGravity

const int kGravity = 3
static

◆ kL

const int kL = 2
static

◆ kMc

const int kMc = 0
static

◆ kMp

const int kMp = 1
static

◆ kNumCoordinates

const int kNumCoordinates = 4
static

The total number of rows (coordinates).


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