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

OSCAR::PCInertialFrobeniusNorm Class Reference
[PerformanceCriteria]

PCInertialFrobeniusNorm takes the frobenius norm of the iStar inertia matrix. Minimizing the effective inertia matrix leads to a decrease in the kinetic energy of the system. PCGeneralizedTorqueMinimization is derived from PCInertia. More...

#include <PCInertialFrobeniusNorm.h>

Inheritance diagram for OSCAR::PCInertialFrobeniusNorm:

Inheritance graph
[legend]
List of all members.

Public Methods

 PCInertialFrobeniusNorm (IDStandAlone *idObject, MinOrMax minOrMax=Minimize, double criticalLimit=-1, double weight=1.0, double exponent=1.0, const String &criteriaName=String("IFN"))
 PCInertialFrobeniusNorm (const PCInertialFrobeniusNorm &crit)
PCInertialFrobeniusNorm & operator= (const PCInertialFrobeniusNorm &crit)
virtual ~PCInertialFrobeniusNorm ()

Protected Methods

virtual bool computeCriteria (RepositoryList &repoList)

Detailed Description

Author:
Mark Tisius and Chetan Kapoor

Constructor & Destructor Documentation

OSCAR::PCInertialFrobeniusNorm::PCInertialFrobeniusNorm (  IDStandAlone *    idObject,
MinOrMax    minOrMax = Minimize,
double    criticalLimit = -1,
double    weight = 1.0,
double    exponent = 1.0,
const String &    criteriaName = String("IFN")
) 
 

Constructor for PCInertialFrobeniusNorm This constructor creates a PCInertialFrobeniusNorm object.

Parameters:
idObject Pointer to a IDStandAlone object which calculates the inertia matrix
minOrMax Sets whether the criteria should be minimized or maximized. The default for vector limits criteria is MINIMIZE
criticalLimit The criticalLimit for the criteria which will be used to check validity and to normalize.
weight The weight of the criteria. The default is 1.0.
exponent The exponent of the criteria. The default is 1.0.
criteriaName The name of the criteria. The default is "IFN".

OSCAR::PCInertialFrobeniusNorm::PCInertialFrobeniusNorm (  const PCInertialFrobeniusNorm &    crit ) 
 

Copy Constructor for PCInertialFrobeniusNorm Use this to create a PCInertialFrobeniusNorm object whose defaults are set via the constructor argument. Note: The idLagrange, fkVelocity, and repository pointers are copied so changes to them will be seen by both criteria. Different repositories will not be used to store the data unless a different RepositoryList is sent to update().

Parameters:
crit A PCInertialFrobeniusNorm object that is used to create the new object

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

Destructor for PCInertialFrobeniusNorm();.

Member Function Documentation

virtual bool OSCAR::PCInertialFrobeniusNorm::computeCriteria (  RepositoryList &    repoList )  [protected, virtual]
 

Implements OSCAR::PerformanceCriteria.

PCInertialFrobeniusNorm& OSCAR::PCInertialFrobeniusNorm::operator= (  const PCInertialFrobeniusNorm &    crit ) 
 

Copy operator for PCInertialFrobeniusNorm Use this to copy one PCInertialFrobeniusNorm object into another. Note: The idLagrange, fkVelocity, and repository pointers are copied so changes to them will be seen by both criteria. Different repositories will not be used to store the data unless a different RepositoryList is sent to update().

Returns:
A reference to itself
Parameters:
crit A PCInertialFrobeniusNorm object that is copied into the calling object.

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