Skip to content

Commit

Permalink
Fix visibility and add documentation (#1407)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Carroll <[email protected]>
  • Loading branch information
mjcarroll authored Mar 25, 2022
1 parent d316196 commit f6ba375
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions src/EntityComponentManagerDiff.hh
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,37 @@ namespace ignition
// Inline bracket to help doxygen filtering.
inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {

class EntityComponentManagerDiff
/// \\brief Used to track the changes in an EntityComponentManager
///
/// Tracks added and removed entities for the purpose of a reset
class IGNITION_GAZEBO_VISIBLE EntityComponentManagerDiff
{
/// \brief Add an added entity to the current diff
/// \param[in] _entity Entity that was added
public: void InsertAddedEntity(const Entity &_entity);

/// \brief Add a removed entity to the current diff
/// \param[in] _entity Entity that was removed
public: void InsertRemovedEntity(const Entity &_entity);

public: const std::vector<Entity> &RemovedEntities() const;
/// \brief Retrieve the list of added entities
/// \return Vector of Entity IDs added since construction/clear
public: const std::vector<Entity> &AddedEntities() const;

/// \brief Retrieve the list of removed entities
/// \return Vector of Entity IDs removed since construction/clear
public: const std::vector<Entity> &RemovedEntities() const;

/// \brief Clear the list of added entities
public: void ClearAddedEntities();

/// \brief Clear the list of removed entities
public: void ClearRemovedEntities();

/// \brief List of added entities
private: std::vector<Entity> addedEntities;

/// \brief List of removed entities
private: std::vector<Entity> removedEntities;
};
}
Expand Down

0 comments on commit f6ba375

Please sign in to comment.