Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OSCAR::DistanceResultsRepository Class Reference
[ObstacleAvoidance]

DistanceResultsRepository is a repository which holds DistanceResults objects, which in turn contain the witness points between manipulators and their surroundings, unit vectors pointing from the manipulator witness points, the magnitude of the distance between witness points, and the G and H functions of the witness points. More...

#include <DistanceResultsRepository.h>

Inheritance diagram for OSCAR::DistanceResultsRepository:

Inheritance graph
[legend]
List of all members.

Public Methods

 DistanceResultsRepository (unsigned int maxNoSolutions, Node *manipulator, WorkCell &workCell, const String &objectName=String())
 DistanceResultsRepository (unsigned int maxNoSolutions, const String &objectName=String())
 DistanceResultsRepository (const DistanceResultsRepository &repo)
DistanceResultsRepository & operator= (const DistanceResultsRepository &repo)
virtual ~DistanceResultsRepository ()

Protected Attributes

WorkCell * cell
Node * arm
bool created

Detailed Description

Author:
Ethan Swint

Constructor & Destructor Documentation

OSCAR::DistanceResultsRepository::DistanceResultsRepository (  unsigned int    maxNoSolutions,
Node *    manipulator,
WorkCell &    workCell,
const String &    objectName = String()
) 
 

Constructor for DistanceResultsRepository This constructor creates a repository object DistanceResultsRepository . It is derived from TypeRepository and templetized to store pointers to a set of doubles. This is a storage only - all computational ability is relegated to the criteria.

Parameters:
maxNoSolutions Unsigned int that specifies the maximum number of solutions for memory allocation.
manipulator A pointer to the manipulator to which this repository will apply
workCell A reference to the WorkCell which this arm is in.
objectName String which specifies the name of the Repository object.

OSCAR::DistanceResultsRepository::DistanceResultsRepository (  unsigned int    maxNoSolutions,
const String &    objectName = String()
) 
 

Constructor for DistanceResultsRepository This constructor creates a repository object DistanceResultsRepository . It is derived from TypeRepository and templetized to store pointers to a set of doubles. This is a storage only - all computational ability is relegated to the criteria.

Parameters:
maxNoSolutions Unsigned int that specifies the maximum number of solutions for memory allocation.
objectName String which specifies the name of the Repository object.

OSCAR::DistanceResultsRepository::DistanceResultsRepository (  const DistanceResultsRepository &    repo ) 
 

Copy Constructor for DistanceResultsRepository Use this to create a DistanceResultsRepository object whose defaults are set via the constructor argument.

Parameters:
repo A DistanceResultsRepository object that is used to create the new object

virtual OSCAR::DistanceResultsRepository::~DistanceResultsRepository (    )  [virtual]
 

Destructor for DistanceResultsRepository();.

Member Function Documentation

DistanceResultsRepository& OSCAR::DistanceResultsRepository::operator= (  const DistanceResultsRepository &    repo ) 
 

Copy operator for DistanceResultsRepository Use this to copy one DistanceResultsRepository object into another.

Returns:
A reference to itself
Parameters:
repo A DistanceResultsRepository object that is copied into the calling object.

Member Data Documentation

Node* OSCAR::DistanceResultsRepository::arm [protected]
 

WorkCell* OSCAR::DistanceResultsRepository::cell [protected]
 

bool OSCAR::DistanceResultsRepository::created [protected]
 

The documentation for this class was generated from the following file:
RRG Homepage OSCAR Overview OSCAR Tutorials Simulations