OutputPort Class Reference

An OutputPort represents a data output from a System. More...

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

Inheritance diagram for OutputPort:

Public Member Functions
virtual	~OutputPort ()=default
void	add_dependent (OutputPortListenerInterface *dependent)
	Registers dependent to receive invalidation notifications whenever this output port's value changes. More...
void	remove_dependent (OutputPortListenerInterface *dependent)
	Unregisters dependent from invalidation notifications. More...
long long	get_version () const
	Returns a positive and monotonically increasing number that is guaranteed to change whenever GetMutableVectorData is called. More...
void	NoteValueModification ()
	Notify any dependents that the value on this OutputPort has changed, and update the value version here. More...

Protected Member Functions
	OutputPort ()

Detailed Description

An OutputPort represents a data output from a System.

Other Systems may have InputPort objects that depend on the values presented at an OutputPort.

There are two kinds of concrete OutputPort:

• VectorOutputPort: Vector values templatized by scalar type, and
• AbstractOutputPort: Abstract values of arbitrary type.

VectorOutputPort values can participate in automatic differentiation, but AbstractOutputPort values cannot.

Constructor & Destructor Documentation

virtual ~OutputPort ( )

virtualdefault

OutputPort ( )

inlineprotected

Member Function Documentation

void add_dependent ( OutputPortListenerInterface *  dependent )

inline

Registers dependent to receive invalidation notifications whenever this output port's value changes.

long long get_version ( ) const

inline

Returns a positive and monotonically increasing number that is guaranteed to change whenever GetMutableVectorData is called.

void NoteValueModification ( )

inline

Notify any dependents that the value on this OutputPort has changed, and update the value version here.

void remove_dependent ( OutputPortListenerInterface *  dependent )

inline

Unregisters dependent from invalidation notifications.

---

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

• drake/systems/framework/system_output.h