Swarm API

Public Member Functions
swarm::CommsModel Class Reference

Class used to store information about the communication model. More...

#include <CommsModel.hh>

Public Member Functions

 CommsModel (SwarmMembershipPtr _swarm, gazebo::physics::WorldPtr _world, sdf::ElementPtr _sdf)
 Class constructor. More...
 
virtual ~CommsModel ()=default
 Class destructor. More...
 
void Update ()
 Update the state of the communication model (outages, visibility between nodes and neighbors). More...
 

Detailed Description

Class used to store information about the communication model.

Constructor & Destructor Documentation

swarm::CommsModel::CommsModel ( SwarmMembershipPtr  _swarm,
gazebo::physics::WorldPtr  _world,
sdf::ElementPtr  _sdf 
)

Class constructor.

Parameters
[in]_swarmPointer to the swarm.
[in]_worldPointer to the Gazebo world.
[in]_sdfPointer to the SDF element of the plugin.
virtual swarm::CommsModel::~CommsModel ( )
virtualdefault

Class destructor.

Member Function Documentation

void swarm::CommsModel::Update ( )

Update the state of the communication model (outages, visibility between nodes and neighbors).


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