framework_common.h File Reference

#include <algorithm>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <variant>
#include <vector>
#include "maliput/drake/common/drake_assert.h"
#include "maliput/drake/common/drake_deprecated.h"
#include "maliput/drake/common/identifier.h"
#include "maliput/drake/common/type_safe_index.h"
#include "maliput/drake/common/value.h"

Include dependency graph for framework_common.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	UseDefaultName
	(Advanced.) Tag type that indicates a system or port should use a default name, instead of a user-provided name. More...
class	FrameworkFactory
class	SystemMessageInterface
class	ContextMessageInterface
class	SystemParentServiceInterface
struct	OutputPortPrerequisite

Namespaces
	maliput
	Code in this file is inspired by: https://github.com/RobotLocomotion/drake/blob/master/common/text_logging.h.
	maliput::drake
	maliput::drake::systems
	maliput::drake::systems::internal

Typedefs
using	DependencyTicket = TypeSafeIndex< class DependencyTag >
	Identifies a particular source value or computation for purposes of declaring and managing dependencies. More...
using	CacheIndex = TypeSafeIndex< class CacheTag >
	Serves as a unique identifier for a particular CacheEntry in a System and the corresponding CacheEntryValue in that System's Context. More...
using	SubsystemIndex = TypeSafeIndex< class SubsystemIndexTag >
	Serves as a local index for a child subsystem within a parent Diagram, or a child subcontext within a parent DiagramContext. More...
using	InputPortIndex = TypeSafeIndex< class InputPortTag >
	Serves as the local index for the input ports of a given System. More...
using	OutputPortIndex = TypeSafeIndex< class OutputPortTag >
	Serves as the local index for the output ports of a given System. More...
using	ContinuousStateIndex = TypeSafeIndex< class ContinuousStateTag >
	Placeholder for future use. More...
using	DiscreteStateIndex = TypeSafeIndex< class DiscreteStateTag >
	Serves as the local index for discrete state groups within a given System and its corresponding Context. More...
using	AbstractStateIndex = TypeSafeIndex< class AbstractStateTag >
	Serves as the local index for abstract state variables within a given System and its corresponding Context. More...
using	NumericParameterIndex = TypeSafeIndex< class NumericParameterTag >
	Serves as the local index for numeric parameter groups within a given System and its corresponding Context. More...
using	AbstractParameterIndex = TypeSafeIndex< class AbstractParameterTag >
	Serves as the local index for abstract parameters within a given System and its corresponding Context. More...
using	SystemConstraintIndex = TypeSafeIndex< class SystemConstraintTag >
	Serves as the local index for constraints declared on a given System. More...
using	SystemId = maliput::drake::Identifier< class SystemIdTag >

Enumerations
enum	PortDataType { kVectorValued = 0, kAbstractValued = 1 }
	All system ports are either vectors of Eigen scalars, or black-box AbstractValues which may contain any type. More...
enum	InputPortSelection { kNoInput = -1, kUseFirstInputIfItExists = -2 }
	Intended for use in e.g. More...
enum	OutputPortSelection { kNoOutput = -1, kUseFirstOutputIfItExists = -2 }
	Intended for use in e.g. More...
enum	BuiltInTicketNumbers {   kNothingTicket = 0, kTimeTicket = 1, kAccuracyTicket = 2, kQTicket = 3,   kVTicket = 4, kZTicket = 5, kXcTicket = 6, kXdTicket = 7,   kXaTicket = 8, kXTicket = 9, kPnTicket = 10, kPaTicket = 11,   kAllParametersTicket = 12, kAllSourcesExceptInputPortsTicket = 13, kAllInputPortsTicket = 14, kAllSourcesTicket = 15,   kConfigurationTicket = 16, kKinematicsTicket = 17, kLastSourceTicket = kKinematicsTicket, kXcdotTicket = 18,   kPeTicket = 19, kKeTicket = 20, kPcTicket = 21, kPncTicket = 22,   kNextAvailableTicket = kPncTicket + 1 }

Functions
bool	operator== (const std::variant< std::string, UseDefaultName > &value, const UseDefaultName &)
	(Advanced.) Sugar that compares a variant against kUseDefaultName. More...
template<typename U >
std::vector< U * >	Unpack (const std::vector< std::unique_ptr< U >> &in)
template<typename PtrType >
bool	IsNonNull (const std::vector< PtrType > &pointers)

Variables
constexpr UseDefaultName	kUseDefaultName = {}
	Name to use when you want a default one generated. More...