Skip to content

Fix visibility and add documentation #1407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 25, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/EntityComponentManagerDiff.hh
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,35 @@ 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
public: const std::vector<Entity> &AddedEntities() const;

/// \brief Retrieve the list of removed entities
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