Drake
InputPortDescriptor< T > Class Template Reference

InputPortDescriptor is a notation for specifying the kind of input a System accepts, on a given port. More...

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

Public Member Functions

 InputPortDescriptor (const System< T > *system, int index, PortDataType data_type, int size, const optional< RandomDistribution > &random_type)
 
const System< T > * get_system () const
 
int get_index () const
 
PortDataType get_data_type () const
 
int size () const
 
bool is_random () const
 
optional< RandomDistributionget_random_type () const
 
Basic Concepts

MoveConstructible only; not CopyConstructible; not Copy/Move-Assignable.

 InputPortDescriptor ()=delete
 
 InputPortDescriptor (InputPortDescriptor &&other)=default
 
 InputPortDescriptor (const InputPortDescriptor &)=delete
 
InputPortDescriptoroperator= (InputPortDescriptor &&)=delete
 
InputPortDescriptoroperator= (const InputPortDescriptor &)=delete
 
 ~InputPortDescriptor ()=default
 

Detailed Description

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

InputPortDescriptor is a notation for specifying the kind of input a System accepts, on a given port.

It is not a mechanism for handling any actual input data.

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

Constructor & Destructor Documentation

InputPortDescriptor ( const System< T > *  system,
int  index,
PortDataType  data_type,
int  size,
const optional< RandomDistribution > &  random_type 
)
inline
Parameters
systemThe system to which this descriptor belongs.
indexThe index of the input port described, starting from zero and incrementing by one per port.
data_typeWhether the port described is vector or abstract valued.
sizeIf the port described is vector-valued, the number of elements, or kAutoSize if determined by connections.
random_typeInput ports may optionally be labeled as random, if the port is intended to model a random-source "noise" or "disturbance" input.
InputPortDescriptor ( )
delete

Here is the caller graph for this function:

InputPortDescriptor ( InputPortDescriptor< T > &&  other)
default
InputPortDescriptor ( const InputPortDescriptor< T > &  )
delete
~InputPortDescriptor ( )
default

Here is the caller graph for this function:

Member Function Documentation

PortDataType get_data_type ( ) const
inline

Here is the caller graph for this function:

int get_index ( ) const
inline

Here is the caller graph for this function:

optional<RandomDistribution> get_random_type ( ) const
inline

Here is the caller graph for this function:

const System<T>* get_system ( ) const
inline

Here is the caller graph for this function:

bool is_random ( ) const
inline

Here is the caller graph for this function:

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

Here is the caller graph for this function:

InputPortDescriptor& operator= ( const InputPortDescriptor< T > &  )
delete
int size ( ) const
inline

Here is the caller graph for this function:


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