iCub-main
Public Member Functions | List of all members
iCub::skinDynLib::skinContactList Class Reference

#include <skinContactList.h>

+ Inheritance diagram for iCub::skinDynLib::skinContactList:

Public Member Functions

 skinContactList ()
 
 skinContactList (const size_type &n, const skinContact &value=skinContact())
 
virtual skinContactList filterBodyPart (const BodyPart &bp)
 Select all the contacts that have the specified body part. More...
 
virtual std::map< BodyPart, skinContactListsplitPerBodyPart ()
 Split the list in N lists dividing the contacts per body part. More...
 
virtual std::map< SkinPart, skinContactListsplitPerSkinPart ()
 Split the list in N lists dividing the contacts per skin part. More...
 
virtual bool read (yarp::os::ConnectionReader &connection)
 
virtual bool write (yarp::os::ConnectionWriter &connection) const
 Write skinContactList to a connection. More...
 
virtual dynContactList toDynContactList () const
 Convert this skinContactList to a dynContactList casting all its elements to dynContact. More...
 
virtual std::string toString (const int &precision=-1) const
 Create a skinContactList starting from a dynContactList. More...
 

Detailed Description

Class representing a list of external contacts acting on the iCub' skin.

Definition at line 44 of file skinContactList.h.

Constructor & Destructor Documentation

◆ skinContactList() [1/2]

skinContactList::skinContactList ( )

Definition at line 27 of file skinContactList.cpp.

◆ skinContactList() [2/2]

skinContactList::skinContactList ( const size_type &  n,
const skinContact value = skinContact() 
)

Definition at line 30 of file skinContactList.cpp.

Member Function Documentation

◆ filterBodyPart()

skinContactList skinContactList::filterBodyPart ( const BodyPart bp)
virtual

Select all the contacts that have the specified body part.

Parameters
bpthe interested body part
Returns
a list containing only the skin contacts with the specified body part

Definition at line 33 of file skinContactList.cpp.

◆ read()

bool skinContactList::read ( yarp::os::ConnectionReader &  connection)
virtual

Definition at line 60 of file skinContactList.cpp.

◆ splitPerBodyPart()

map< BodyPart, skinContactList > skinContactList::splitPerBodyPart ( )
virtual

Split the list in N lists dividing the contacts per body part.

Definition at line 42 of file skinContactList.cpp.

◆ splitPerSkinPart()

map< SkinPart, skinContactList > skinContactList::splitPerSkinPart ( )
virtual

Split the list in N lists dividing the contacts per skin part.

Definition at line 50 of file skinContactList.cpp.

◆ toDynContactList()

dynContactList skinContactList::toDynContactList ( ) const
virtual

Convert this skinContactList to a dynContactList casting all its elements to dynContact.

Definition at line 94 of file skinContactList.cpp.

◆ toString()

string skinContactList::toString ( const int &  precision = -1) const
virtual

Create a skinContactList starting from a dynContactList.

Returns
true if operation succeeded, false otherwise Useful to print some information.

Definition at line 114 of file skinContactList.cpp.

◆ write()

bool skinContactList::write ( yarp::os::ConnectionWriter &  connection) const
virtual

Write skinContactList to a connection.

return true iff a skinContactList was written correctly

Definition at line 80 of file skinContactList.cpp.


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