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

OSCAR::ObAvInfoRepository Class Reference
[ObstacleAvoidance]

ObAvInfoRepository is a repository which holds ObAvInfo 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 <ObAvInfoRepository.hpp>

Inheritance diagram for OSCAR::ObAvInfoRepository:

Inheritance graph
[legend]
List of all members.

Public Methods

 ObAvInfoRepository (unsigned int maxNoSolutions, unsigned int armIndex, WorkCell &workCell, const String &objectName=String())
 ObAvInfoRepository (unsigned int maxNoSolutions, const String &objectName=String())
 ObAvInfoRepository (const ObAvInfoRepository &repo)
ObAvInfoRepository & operator= (const ObAvInfoRepository &repo)
virtual ~ObAvInfoRepository ()
bool Create (unsigned int armIndex, WorkCell &cell)
bool Resize ()

Protected Attributes

unsigned int armIndex
WorkCell * cell
bool created

Detailed Description

Author:
Ethan Swint

Constructor & Destructor Documentation

OSCAR::ObAvInfoRepository::ObAvInfoRepository (  unsigned int    maxNoSolutions,
unsigned int    armIndex,
WorkCell &    workCell,
const String &    objectName = String()
) 
 

Constructor for ObAvInfoRepository This constructor creates a repository object ObAvInfoRepository . 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.
armIndex The index of the arm 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::ObAvInfoRepository::ObAvInfoRepository (  unsigned int    maxNoSolutions,
const String &    objectName = String()
) 
 

Constructor for ObAvInfoRepository This constructor creates a repository object ObAvInfoRepository . 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::ObAvInfoRepository::ObAvInfoRepository (  const ObAvInfoRepository &    repo ) 
 

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

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

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

Destructor for ObAvInfoRepository();.

Member Function Documentation

bool OSCAR::ObAvInfoRepository::Create (  unsigned int    armIndex,
WorkCell &    cell
) 
 

Allocates memory for the ObAvInfoRepository object Performs memory allocation for the object.

Returns:
true - successful, false otherwise
Parameters:
armIndex - index of arm in workcell for which this object will contain data
cell - WorkCell object which performs data calculations

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

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

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

bool OSCAR::ObAvInfoRepository::Resize (    ) 
 

Member Data Documentation

unsigned int OSCAR::ObAvInfoRepository::armIndex [protected]
 

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

bool OSCAR::ObAvInfoRepository::created [protected]
 

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