Drake
OutputPortBase Class Referenceabstract

OutputPortBase handles the scalar type-independent aspects of an OutputPort. More...

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

Public Member Functions

virtual ~OutputPortBase ()
 
OutputPortIndex get_index () const
 Returns the index of this output port within the owning System. More...
 
DependencyTicket ticket () const
 Returns the DependencyTicket for this output port within the owning System. More...
 
PortDataType get_data_type () const
 Gets the port data type specified at port construction. More...
 
int size () const
 Returns the fixed size expected for a vector-valued output port. More...
 
const SystemBaseget_system_base () const
 Returns a reference to the System that owns this output port. More...
 
const std::string & get_name () const
 Gets port name. More...
 
Does not allow copy, move, or assignment
 OutputPortBase (const OutputPortBase &)=delete
 
OutputPortBaseoperator= (const OutputPortBase &)=delete
 
 OutputPortBase (OutputPortBase &&)=delete
 
OutputPortBaseoperator= (OutputPortBase &&)=delete
 

Protected Member Functions

 OutputPortBase (SystemBase *owning_system, std::string name, OutputPortIndex index, DependencyTicket ticket, PortDataType data_type, int size)
 Provides derived classes the ability to set the base class members at construction. More...
 
SystemBaseget_mutable_system_base ()
 
virtual internal::OutputPortPrerequisite DoGetPrerequisite () const =0
 Concrete output ports must implement this to return the prerequisite dependency ticket for this port, which may be in the current System or one of its immediate child subsystems. More...
 

Detailed Description

OutputPortBase handles the scalar type-independent aspects of an OutputPort.

An OutputPort belongs to a System and represents the properties of one of that System's output ports.

Constructor & Destructor Documentation

◆ OutputPortBase() [1/3]

OutputPortBase ( const OutputPortBase )
delete

◆ OutputPortBase() [2/3]

OutputPortBase ( OutputPortBase &&  )
delete

◆ ~OutputPortBase()

~OutputPortBase ( )
virtualdefault

◆ OutputPortBase() [3/3]

OutputPortBase ( SystemBase owning_system,
std::string  name,
OutputPortIndex  index,
DependencyTicket  ticket,
PortDataType  data_type,
int  size 
)
protected

Provides derived classes the ability to set the base class members at construction.

Parameters
owning_systemThe System that owns this output port.
nameA name for the port. Must not be empty. Output port names should be unique within a single System.
indexThe index to be assigned to this OutputPort.
ticketThe DependencyTicket to be assigned to this OutputPort.
data_typeWhether the port described is vector or abstract valued.
sizeIf the port described is vector-valued, the number of elements expected, otherwise ignored.

Member Function Documentation

◆ DoGetPrerequisite()

virtual internal::OutputPortPrerequisite DoGetPrerequisite ( ) const
protectedpure virtual

Concrete output ports must implement this to return the prerequisite dependency ticket for this port, which may be in the current System or one of its immediate child subsystems.

◆ get_data_type()

PortDataType get_data_type ( ) const
inline

Gets the port data type specified at port construction.

◆ get_index()

OutputPortIndex get_index ( ) const
inline

Returns the index of this output port within the owning System.

For a Diagram, this will be the index within the Diagram, not the index within the LeafSystem whose output port was forwarded.

◆ get_mutable_system_base()

SystemBase& get_mutable_system_base ( )
inlineprotected

◆ get_name()

const std::string& get_name ( ) const
inline

Gets port name.

◆ get_system_base()

const SystemBase& get_system_base ( ) const
inline

Returns a reference to the System that owns this output port.

Note that for a diagram output port this will be the diagram, not the leaf system whose output port was forwarded.

◆ operator=() [1/2]

OutputPortBase& operator= ( OutputPortBase &&  )
delete

◆ operator=() [2/2]

OutputPortBase& operator= ( const OutputPortBase )
delete

◆ size()

int size ( ) const
inline

Returns the fixed size expected for a vector-valued output port.

Not meaningful for abstract output ports.

◆ ticket()

DependencyTicket ticket ( ) const
inline

Returns the DependencyTicket for this output port within the owning System.


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