Drake
InputPortFinder Struct Reference

A system diagram may inherit an input port from one of its contained subsystems, which will know that port by a different port number than we will use here. More...

#include <drake/systems/framework/system3.h>

Collaboration diagram for InputPortFinder:

Public Member Functions

 InputPortFinder (int subsystem_num, int port_num, InputPort3 *port)
 

Public Attributes

int subsystem_num {-1}
 -1 means this system. More...
 
int port_num {-1}
 Port number as understood by the subsystem. More...
 
InputPort3port {}
 Convenience pointer to the actual port. More...
 

Detailed Description

A system diagram may inherit an input port from one of its contained subsystems, which will know that port by a different port number than we will use here.

We record which subsystem and its port number here. Also, it may turn out that the subsystem also inherited that port from one of its subsystems, so the actual port may be arbitrarily deep. We'll find it and keep a direct pointer to it for convenience.

Constructor & Destructor Documentation

InputPortFinder ( int  subsystem_num,
int  port_num,
InputPort3 port 
)
inline

Member Data Documentation

InputPort3* port {}

Convenience pointer to the actual port.

int port_num {-1}

Port number as understood by the subsystem.

int subsystem_num {-1}

-1 means this system.


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