delphyne
IgnSubscriberSystem< IGN_TYPE > Class Template Reference

Detailed Description

template<class IGN_TYPE>
class delphyne::IgnSubscriberSystem< IGN_TYPE >

This class is the counterpart of Drake's LcmSubscriberSystem.

Most of the code has been taken from that class and adapted to the types of values that we use.

Template Parameters
IGN_TYPEmust be a valid ignition message type.

#include <src/backend/ign_subscriber_system.h>

Inheritance diagram for IgnSubscriberSystem< IGN_TYPE >:
[legend]

Public Member Functions

 IgnSubscriberSystem (const std::string &topic_name)
 Default constructor. More...
 
 ~IgnSubscriberSystem () override
 
std::unique_ptr< drake::AbstractValue > AllocateDefaultAbstractValue () const
 
void SetDefaultState (const drake::systems::Context< double > &, drake::systems::State< double > *state) const override
 
const std::string & get_topic_name ()
 Returns the topic name it is subscribed to. More...
 
int GetMessageCount (const drake::systems::Context< double > &context) const
 Returns the message counter stored in context. More...
 

Protected Member Functions

void HandleMessage (const IGN_TYPE &ignition_message)
 
void DoCalcNextUpdateTime (const drake::systems::Context< double > &context, drake::systems::CompositeEventCollection< double > *events, double *time) const override
 
void DoCalcUnrestrictedUpdate (const drake::systems::Context< double > &, const std::vector< const drake::systems::UnrestrictedUpdateEvent< double > * > &, drake::systems::State< double > *state) const override
 
void ProcessMessageAndStoreToAbstractState (drake::systems::AbstractValues *abstract_state) const
 
void CalcIgnMessage (const drake::systems::Context< double > &context, drake::AbstractValue *output_value) const
 

Constructor & Destructor Documentation

◆ IgnSubscriberSystem()

IgnSubscriberSystem ( const std::string &  topic_name)
explicit

Default constructor.

Parameters
[in]topic_nameThe name of the ignition topic this system will be subscribed to.

◆ ~IgnSubscriberSystem()

~IgnSubscriberSystem ( )
override

Member Function Documentation

◆ AllocateDefaultAbstractValue()

std::unique_ptr<drake::AbstractValue> AllocateDefaultAbstractValue ( ) const

◆ CalcIgnMessage()

void CalcIgnMessage ( const drake::systems::Context< double > &  context,
drake::AbstractValue *  output_value 
) const
protected

◆ DoCalcNextUpdateTime()

void DoCalcNextUpdateTime ( const drake::systems::Context< double > &  context,
drake::systems::CompositeEventCollection< double > *  events,
double *  time 
) const
overrideprotected

◆ DoCalcUnrestrictedUpdate()

void DoCalcUnrestrictedUpdate ( const drake::systems::Context< double > &  ,
const std::vector< const drake::systems::UnrestrictedUpdateEvent< double > * > &  ,
drake::systems::State< double > *  state 
) const
overrideprotected

◆ get_topic_name()

const std::string& get_topic_name ( )

Returns the topic name it is subscribed to.

◆ GetMessageCount()

int GetMessageCount ( const drake::systems::Context< double > &  context) const

Returns the message counter stored in context.

◆ HandleMessage()

void HandleMessage ( const IGN_TYPE &  ignition_message)
protected

◆ ProcessMessageAndStoreToAbstractState()

void ProcessMessageAndStoreToAbstractState ( drake::systems::AbstractValues *  abstract_state) const
protected

◆ SetDefaultState()

void SetDefaultState ( const drake::systems::Context< double > &  ,
drake::systems::State< double > *  state 
) const
override

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