tasks::qp::ContactId Struct Reference

#include <Tasks/QPContacts.h>

Public Member Functions

 ContactId ()
 
 ContactId (int r1Index, int r2Index, const std::string &r1BodyName, const std::string &r2BodyName, int ambiguityId=-1)
 
bool operator== (const ContactId &cId) const
 
bool operator!= (const ContactId &cId) const
 
bool operator< (const ContactId &cId) const
 

Public Attributes

int r1Index
 
int r2Index
 
std::string r1BodyName
 
std::string r2BodyName
 
int ambiguityId
 

Detailed Description

Unique identifier for a contact.

Constructor & Destructor Documentation

◆ ContactId() [1/2]

tasks::qp::ContactId::ContactId ( )

◆ ContactId() [2/2]

tasks::qp::ContactId::ContactId ( int  r1Index,
int  r2Index,
const std::string &  r1BodyName,
const std::string &  r2BodyName,
int  ambiguityId = -1 
)
Parameters
r1IndexFirst robot imply in the contact.
r2IndexSecond robot imply in the contact.
r1BodyNameBody name of robot r1Index imply in the contact.
r2BodyNameBody name of robot r2Index imply in the contact.
ambiguityIdIf two or more contacts have the same r1Index, r2Index, r1BodyId, r2BodyId the ambiguityId is used to dissociate them.

Member Function Documentation

◆ operator!=()

bool tasks::qp::ContactId::operator!= ( const ContactId cId) const

◆ operator<()

bool tasks::qp::ContactId::operator< ( const ContactId cId) const

◆ operator==()

bool tasks::qp::ContactId::operator== ( const ContactId cId) const

Member Data Documentation

◆ ambiguityId

int tasks::qp::ContactId::ambiguityId

◆ r1BodyName

std::string tasks::qp::ContactId::r1BodyName

◆ r1Index

int tasks::qp::ContactId::r1Index

◆ r2BodyName

std::string tasks::qp::ContactId::r2BodyName

◆ r2Index

int tasks::qp::ContactId::r2Index

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