Drake
InputPort< T > Class Template Referencefinal

This extends InputPortBase with some scalar type-dependent methods. More...

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

Public Member Functions

 InputPort (const System< T > *system, SystemBase *system_base, std::string name, InputPortIndex index, DependencyTicket ticket, PortDataType data_type, int size, const optional< RandomDistribution > &random_type)
 (Internal use only) Constructs a type-specific input port. More...
 
const System< T > * get_system () const
 Returns a reference to the System that owns this input port. More...
 
Does not allow copy, move, or assignment
 InputPort (const InputPort &)=delete
 
InputPortoperator= (const InputPort &)=delete
 
 InputPort (InputPort &&)=delete
 
InputPortoperator= (InputPort &&)=delete
 
- Public Member Functions inherited from InputPortBase
virtual ~InputPortBase ()
 
InputPortIndex get_index () const
 Returns the index of this input port within the owning System. More...
 
DependencyTicket ticket () const
 Returns the DependencyTicket for this input port within the owning System. More...
 
const SystemBaseget_system_base () const
 Returns a reference to the SystemBase that owns this input port. More...
 
PortDataType get_data_type () const
 Returns the port data type. More...
 
int size () const
 Returns the fixed size expected for a vector-valued input port. More...
 
bool is_random () const
 Returns true if this is a random port. More...
 
optional< RandomDistributionget_random_type () const
 Returns the RandomDistribution if this is a random port. More...
 
const std::string & get_name () const
 Get port name. More...
 
 InputPortBase (const InputPortBase &)=delete
 
InputPortBaseoperator= (const InputPortBase &)=delete
 
 InputPortBase (InputPortBase &&)=delete
 
InputPortBaseoperator= (InputPortBase &&)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from InputPortBase
 InputPortBase (SystemBase *owning_system, std::string name, InputPortIndex index, DependencyTicket ticket, PortDataType data_type, int size, const optional< RandomDistribution > &random_type)
 Provides derived classes the ability to set the base class members at construction. More...
 

Detailed Description

template<typename T>
class drake::systems::InputPort< T >

This extends InputPortBase with some scalar type-dependent methods.

Template Parameters
TThe mathematical type of the context, which must be a valid Eigen scalar.

Constructor & Destructor Documentation

◆ InputPort() [1/3]

InputPort ( const InputPort< T > &  )
delete

◆ InputPort() [2/3]

InputPort ( InputPort< T > &&  )
delete

◆ InputPort() [3/3]

InputPort ( const System< T > *  system,
SystemBase system_base,
std::string  name,
InputPortIndex  index,
DependencyTicket  ticket,
PortDataType  data_type,
int  size,
const optional< RandomDistribution > &  random_type 
)
inline

(Internal use only) Constructs a type-specific input port.

See InputPortBase::InputPortBase() for the meaning of these parameters. The additional system parameter here must be the same object as the system_base parameter. The name must not be empty.

Member Function Documentation

◆ get_system()

const System<T>* get_system ( ) const
inline

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

Note that for a Diagram input port this will be the Diagram, not the LeafSystem whose input port was exported.

◆ operator=() [1/2]

InputPort& operator= ( const InputPort< T > &  )
delete

◆ operator=() [2/2]

InputPort& operator= ( InputPort< T > &&  )
delete

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