opal::AttractorMotorData Class Reference

A data structure describing an AttractorMotor. More...

#include <AttractorMotorData.h>

Inheritance diagram for opal::AttractorMotorData:

List of all members.

Public Member Functions
OPAL_DECL	AttractorMotorData ()
OPAL_DECL	AttractorMotorData (const AttractorMotorData &data)
virtual OPAL_DECL	~AttractorMotorData ()
virtual OPAL_DECL void OPAL_CALL	operator= (const AttractorMotorData &data)
Public Attributes
Solid *	solid0
Solid *	solid1
int	internal_solid0Index
int	internal_solid1Index
std::string	solid0BlueprintRefName
std::string	solid1BlueprintRefName
real	strength
real	exponent

---

Detailed Description

A data structure describing an AttractorMotor.

Definition at line 37 of file AttractorMotorData.h.

---

Constructor & Destructor Documentation

OPAL_DECL opal::AttractorMotorData::AttractorMotorData (   )  [inline]

Definition at line 40 of file AttractorMotorData.h. References opal::ATTRACTOR_MOTOR, opal::defaults::motor::attractor::exponent, exponent, internal_solid0Index, internal_solid1Index, opal::MotorData::mType, solid0, solid0BlueprintRefName, solid1, solid1BlueprintRefName, opal::defaults::motor::attractor::strength, and strength.

OPAL_DECL opal::AttractorMotorData::AttractorMotorData (  const AttractorMotorData &  data  )  [inline]

Copy constructor. Definition at line 55 of file AttractorMotorData.h.

virtual OPAL_DECL opal::AttractorMotorData::~AttractorMotorData (   )  [inline, virtual]

Definition at line 60 of file AttractorMotorData.h.

---

Member Function Documentation

virtual OPAL_DECL void OPAL_CALL opal::AttractorMotorData::operator= (  const AttractorMotorData &  data  )  [inline, virtual]

Makes a deep copy. Definition at line 65 of file AttractorMotorData.h. References opal::MotorData::enabled, exponent, internal_solid0Index, internal_solid1Index, opal::MotorData::mType, opal::MotorData::name, solid0, solid0BlueprintRefName, solid1, solid1BlueprintRefName, and strength.

---

Member Data Documentation

real opal::AttractorMotorData::exponent

Determines exponential relationship of attraction/repulsion. Definition at line 103 of file AttractorMotorData.h. Referenced by AttractorMotorData(), opal::AttractorMotor::getExponent(), opal::AttractorMotor::internal_update(), operator=(), and opal::AttractorMotor::setExponent().

int opal::AttractorMotorData::internal_solid0Index

Internal data used for Blueprint instantiation. Definition at line 88 of file AttractorMotorData.h. Referenced by AttractorMotorData(), and operator=().

int opal::AttractorMotorData::internal_solid1Index

Internal data used for Blueprint instantiation. Definition at line 91 of file AttractorMotorData.h. Referenced by AttractorMotorData(), and operator=().

Solid* opal::AttractorMotorData::solid0

Pointer to Solid 0. Definition at line 82 of file AttractorMotorData.h. Referenced by AttractorMotorData(), opal::AttractorMotor::init(), opal::AttractorMotor::internal_dependsOnSolid(), opal::AttractorMotor::internal_update(), and operator=().

std::string opal::AttractorMotorData::solid0BlueprintRefName

String used for for intra-Blueprint references. Definition at line 94 of file AttractorMotorData.h. Referenced by AttractorMotorData(), and operator=().

Solid* opal::AttractorMotorData::solid1

Pointer to Solid 1. Definition at line 85 of file AttractorMotorData.h. Referenced by AttractorMotorData(), opal::AttractorMotor::init(), opal::AttractorMotor::internal_dependsOnSolid(), opal::AttractorMotor::internal_update(), and operator=().

std::string opal::AttractorMotorData::solid1BlueprintRefName

String used for for intra-Blueprint references. Definition at line 97 of file AttractorMotorData.h. Referenced by AttractorMotorData(), and operator=().

real opal::AttractorMotorData::strength

Constant used to scale attraction (repulsion if strength < 0). Definition at line 100 of file AttractorMotorData.h. Referenced by AttractorMotorData(), opal::AttractorMotor::getStrength(), opal::AttractorMotor::init(), operator=(), and opal::AttractorMotor::setStrength().

---

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

• AttractorMotorData.h

---