LeafOutputPort< T > Class Template Referencefinal
Detailed Description
template<typename T>
class maliput::drake::systems::LeafOutputPort< T >
(Advanced.) Implements an output port whose value is managed by a cache entry in the same LeafSystem as the port.
This is intended for internal use in implementing the DeclareOutputPort() variants in LeafSystem.
@tparam_default_scalar
#include <src/maliput/drake/systems/framework/leaf_output_port.h>
Inheritance diagram for LeafOutputPort< T >:
Public Types | |
| using | AllocCallback = ValueProducer::AllocateCallback |
| Signature of a function suitable for allocating an object that can hold a value of a particular output port. More... | |
| using | CalcCallback = std::function< void(const Context< T > &, AbstractValue *)> |
| Signature of a function suitable for calculating a value of a particular output port, given a place to put the value. More... | |
| using | CalcVectorCallback = std::function< void(const Context< T > &, BasicVector< T > *)> |
| Signature of a function suitable for calculating a value of a particular vector-valued output port, given a place to put the value. More... | |
Public Member Functions | |
| ~LeafOutputPort () final=default | |
| const CacheEntry & | cache_entry () const |
| Returns the cache entry associated with this output port. More... | |
| void | disable_caching_by_default () |
| (Debugging) Specifies that caching should be disabled for this output port when a Context is first allocated. More... | |
 Public Member Functions inherited from OutputPort< T > | |
| ~OutputPort () override=default | |
| Eigen::VectorBlock< const VectorX< T > > | Eval (const Context< T > &context) const |
| Returns a reference to the up-to-date value of this output port contained in the given Context. More... | |
| template<typename ValueType , typename = std::enable_if_t<std::is_same_v<AbstractValue, ValueType>>> | |
| const AbstractValue & | Eval (const Context< T > &context) const |
| template<typename ValueType , typename = std::enable_if_t<!std::is_same_v<AbstractValue, ValueType> && (!std::is_base_of_v<BasicVector<T>, ValueType> || std::is_same_v<BasicVector<T>, ValueType>)>> | |
| const ValueType & | Eval (const Context< T > &context) const |
| template<typename ValueType , typename = std::enable_if_t<std::is_base_of_v<BasicVector<T>, ValueType> && !std::is_same_v<BasicVector<T>, ValueType>>> | |
| const ValueType & | Eval (const Context< T > &context, int=0) const |
| std::unique_ptr< AbstractValue > | Allocate () const |
| Allocates a concrete object suitable for holding the value to be exposed by this output port, and returns that as an AbstractValue. More... | |
| void | Calc (const Context< T > &context, AbstractValue *value) const |
| Unconditionally computes the value of this output port with respect to the given context, into an already-allocated AbstractValue object whose concrete type must be exactly the same as the type returned by this port's allocator. More... | |
| const System< T > & | get_system () const |
| Returns a reference to the System that owns this output port. More... | |
| OutputPortIndex | get_index () const |
| Returns the index of this output port within the owning System. More... | |
| PortDataType | get_data_type () const |
| Returns the port data type. More... | |
| const std::string & | get_name () const |
| Get port name. More... | |
| std::string | GetFullDescription () const |
| Returns a verbose human-readable description of port. More... | |
| int | size () const |
| Returns the fixed size expected for a vector-valued port. More... | |
| DependencyTicket | ticket () const |
| (Advanced.) Returns the DependencyTicket for this port within the owning System. More... | |
| Public Member Functions inherited from OutputPortBase | |
| ~OutputPortBase () override | |
| OutputPortIndex | get_index () const |
| Returns the index of this output port within the owning System. More... | |
| internal::OutputPortPrerequisite | GetPrerequisite () const |
| PortDataType | get_data_type () const |
| Returns the port data type. More... | |
| const std::string & | get_name () const |
| Get port name. More... | |
| std::string | GetFullDescription () const |
| Returns a verbose human-readable description of port. More... | |
| int | size () const |
| Returns the fixed size expected for a vector-valued port. More... | |
| DependencyTicket | ticket () const |
| (Advanced.) Returns the DependencyTicket for this port within the owning System. More... | |
| Public Member Functions inherited from PortBase | |
| virtual | ~PortBase () |
| const std::string & | get_name () const |
| Get port name. More... | |
| std::string | GetFullDescription () const |
| Returns a verbose human-readable description of 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 port. More... | |
| const internal::SystemMessageInterface & | get_system_interface () const |
| DependencyTicket | ticket () const |
| (Advanced.) Returns the DependencyTicket for this port within the owning System. More... | |
Friends | |
| class | internal::FrameworkFactory |
Additional Inherited Members | |
| Protected Member Functions inherited from OutputPort< T > | |
| OutputPort (const System< T > *system, internal::SystemMessageInterface *system_interface, internal::SystemId system_id, 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... | |
| Protected Member Functions inherited from OutputPortBase | |
| OutputPortBase (internal::SystemMessageInterface *owning_system, internal::SystemId owning_system_id, 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... | |
| Protected Member Functions inherited from PortBase | |
| PortBase (const char *kind_string, internal::SystemMessageInterface *owning_system, internal::SystemId owning_system_id, std::string name, int index, DependencyTicket ticket, PortDataType data_type, int size) | |
| Provides derived classes the ability to set the base class members at construction. More... | |
| int | get_int_index () const |
| Returns the index of this port within the owning System (i.e., an InputPortIndex or OutputPortIndex, but as a bare integer). More... | |
| internal::SystemMessageInterface & | get_mutable_system_interface () |
| Returns get_system_interface(), but without the const. More... | |
| void | ValidateSystemId (internal::SystemId id) const |
| (Internal use only) Checks whether the given id (nominally obtained from a Context passed to this port) was created for the system that owns this port. More... | |
| void | ThrowValidateContextMismatch () const |
| (Internal use only) Throws std::exception with a message that the sanity check(s) related to ValidateContext have failed. More... | |
| template<typename ValueType > | |
| const ValueType & | PortEvalCast (const AbstractValue &abstract) const |
| Pull a value of a given type from an abstract value or issue a nice message if the type is not correct. More... | |
| template<typename ValueType , typename T > | |
| const ValueType & | PortEvalCast (const BasicVector< T > &basic) const |
| Downcast a basic vector to a more specific subclass (e.g., as generated by //tools/vector_gen) or issue a nice message if the type is not correct. More... | |
| template<typename ValueType > | |
| const ValueType & | ThrowBadCast (const AbstractValue &abstract) const |
| Reports that the user provided a bad ValueType argument to Eval. More... | |
| template<typename ValueType , typename T > | |
| const ValueType & | ThrowBadCast (const BasicVector< T > &basic) const |
| Reports that the user provided a bad ValueType argument to Eval. More... | |
| void | ThrowBadCast (const std::string &value_typename, const std::string &eval_typename) const |
| Reports that the user provided a bad ValueType argument to Eval. More... | |
| Static Protected Member Functions inherited from OutputPort< T > | |
| static void | ThrowIfInvalidPortValueType (const OutputPort< T > &port, const Context< T > &context, const AbstractValue &proposed_value) |
| Static method allows DiagramOutputPort to call this recursively. More... | |
Member Typedef Documentation
◆ AllocCallback
Signature of a function suitable for allocating an object that can hold a value of a particular output port.
The result is returned as an AbstractValue even if this is a vector-valued port.
◆ CalcCallback
| using CalcCallback = std::function<void(const Context<T>&, AbstractValue*)> |
Signature of a function suitable for calculating a value of a particular output port, given a place to put the value.
◆ CalcVectorCallback
| using CalcVectorCallback = std::function<void(const Context<T>&, BasicVector<T>*)> |
Signature of a function suitable for calculating a value of a particular vector-valued output port, given a place to put the value.
Constructor & Destructor Documentation
◆ ~LeafOutputPort()
|
finaldefault |
Member Function Documentation
◆ cache_entry()
| const CacheEntry& cache_entry | ( | ) | const |
Returns the cache entry associated with this output port.
◆ disable_caching_by_default()
| void disable_caching_by_default | ( | ) |
(Debugging) Specifies that caching should be disabled for this output port when a Context is first allocated.
This is useful if you have observed different behavior with caching on or off and would like to determine if the problem is caused by this port.
Friends And Related Function Documentation
◆ internal::FrameworkFactory
|
friend |
The documentation for this class was generated from the following files:
