Tesseract 0.28.4
Loading...
Searching...
No Matches
AllowedCollisionMatrix Class Reference

Public Types

using Ptr = std::shared_ptr<AllowedCollisionMatrix>
using ConstPtr = std::shared_ptr<const AllowedCollisionMatrix>

Public Member Functions

 AllowedCollisionMatrix (const AllowedCollisionEntries &entries)
 AllowedCollisionMatrix (const AllowedCollisionMatrix &)=default
 AllowedCollisionMatrix (AllowedCollisionMatrix &&)=default
AllowedCollisionMatrix & operator= (const AllowedCollisionMatrix &)=default
AllowedCollisionMatrix & operator= (AllowedCollisionMatrix &&)=default
virtual void addAllowedCollision (const LinkId &link_id1, const LinkId &link_id2, const std::string &reason)
 Disable collision between two collision objects.
virtual void addAllowedCollision (const LinkIdPair &pair, const std::string &reason)
 Disable collision for a pre-built canonical pair.
const AllowedCollisionEntries & getAllAllowedCollisions () const
 Get all of the entries in the allowed collision matrix.
virtual void removeAllowedCollision (const LinkId &link_id1, const LinkId &link_id2)
 Remove disabled collision pair from allowed collision matrix.
virtual void removeAllowedCollision (const LinkIdPair &pair)
 Remove disabled collision pair from allowed collision matrix using a pre-built canonical pair.
virtual void removeAllowedCollision (const LinkId &link_id)
 Remove disabled collision for any pair with link_id from allowed collision matrix.
virtual bool isCollisionAllowed (const LinkIdPair &pair) const
 This checks if a link pair is allowed to be in collision.
void clearAllowedCollisions ()
 Clears the list of allowed collisions, so that no collision will be allowed.
void insertAllowedCollisionMatrix (const AllowedCollisionMatrix &acm)
 Inserts an allowable collision matrix.
void reserveAllowedCollisionMatrix (std::size_t size)
 Reserve space for the internal data storage.
bool operator== (const AllowedCollisionMatrix &rhs) const
bool operator!= (const AllowedCollisionMatrix &rhs) const

Friends

template<class Archive>
friend void::tesseract::common::serialize (Archive &ar, AllowedCollisionMatrix &obj)

Member Function Documentation

◆ addAllowedCollision() [1/2]

void tesseract::common::AllowedCollisionMatrix::addAllowedCollision ( const LinkId & link_id1,
const LinkId & link_id2,
const std::string & reason )
virtual

Disable collision between two collision objects.

Parameters
link_id1Collision object LinkId
link_id2Collision object LinkId
reasonThe reason for disabling collision

◆ addAllowedCollision() [2/2]

void tesseract::common::AllowedCollisionMatrix::addAllowedCollision ( const LinkIdPair & pair,
const std::string & reason )
virtual

Disable collision for a pre-built canonical pair.

Useful when iterating an existing AllowedCollisionEntries map and re-inserting {key, reason} pairs without reconstructing LinkId objects from strings.

Parameters
pairCanonically ordered link-id pair (the map key)
reasonThe reason for disabling collision

◆ getAllAllowedCollisions()

const AllowedCollisionEntries & tesseract::common::AllowedCollisionMatrix::getAllAllowedCollisions ( ) const

Get all of the entries in the allowed collision matrix.

Returns
AllowedCollisionEntries keyed by LinkIdPair with the reason as the value

◆ removeAllowedCollision() [1/3]

void tesseract::common::AllowedCollisionMatrix::removeAllowedCollision ( const LinkId & link_id1,
const LinkId & link_id2 )
virtual

Remove disabled collision pair from allowed collision matrix.

Parameters
link_id1Collision object LinkId
link_id2Collision object LinkId

◆ removeAllowedCollision() [2/3]

Remove disabled collision pair from allowed collision matrix using a pre-built canonical pair.

Useful when iterating an existing AllowedCollisionEntries map and erasing by key without reconstructing LinkId objects from strings.

Parameters
pairCanonically ordered link-id pair (the map key)

◆ removeAllowedCollision() [3/3]

Remove disabled collision for any pair with link_id from allowed collision matrix.

Parameters
link_idCollision object LinkId

◆ isCollisionAllowed()

bool tesseract::common::AllowedCollisionMatrix::isCollisionAllowed ( const LinkIdPair & pair) const
virtual

This checks if a link pair is allowed to be in collision.

Parameters
pairCanonically ordered link-id pair
Returns
True if allowed to be in collision, otherwise false

◆ insertAllowedCollisionMatrix()

Inserts an allowable collision matrix.

A pair present in both matrices takes its reason from acm: a later statement of a pair overrides an earlier one, matching the single-pair add and the YAML decoder.

Parameters
acmACM to be inserted

◆ reserveAllowedCollisionMatrix()

Reserve space for the internal data storage.

Parameters
sizeThe size to reserve