Actuatorport Class Reference

#include <Actuatorport.h>

List of all members.

Public Member Functions

 Actuatorport (const std::string &name, Actuator *actuator, int portId, double minValue, double maxValue)
std::string getName () const
void setValue (double value)
double getMinValue () const
double getMaxValue () const

Private Attributes

std::string name
Actuatoractuator
int portId
double minValue
double maxValue


Detailed Description

A class representing an actuatorport

Definition at line 21 of file Actuatorport.h.


Constructor & Destructor Documentation

Actuatorport::Actuatorport ( const std::string &  name,
Actuator actuator,
int  portId,
double  minValue,
double  maxValue 
)

Constructor

Parameters:
name The name of the actuatorport
actuator A pointer to the actuator
portId The id of the port
minValue The minimum value to be set
maxValue The maximum value to be set

Definition at line 12 of file Actuatorport.cpp.

References actuator, and SimObject::getFullName().


Member Function Documentation

double Actuatorport::getMaxValue (  )  const [inline]

Returns the maximum value to be set

Returns:
The value

Definition at line 64 of file Actuatorport.h.

References maxValue.

double Actuatorport::getMinValue (  )  const [inline]

Returns the minimum value to be set

Returns:
The value

Definition at line 59 of file Actuatorport.h.

References minValue.

std::string Actuatorport::getName (  )  const [inline]

Returns the name

Returns:
The name

Definition at line 49 of file Actuatorport.h.

References name.

void Actuatorport::setValue ( double  value  ) 

Sets the value of the actuatorport

Parameters:
value The value

Definition at line 22 of file Actuatorport.cpp.

References actuator, maxValue, minValue, portId, and Actuator::setValue().


Member Data Documentation

Actuator* Actuatorport::actuator [private]

A pointer to the actuator

Definition at line 27 of file Actuatorport.h.

Referenced by Actuatorport(), and setValue().

double Actuatorport::maxValue [private]

The maximum value to be set

Definition at line 33 of file Actuatorport.h.

Referenced by getMaxValue(), and setValue().

double Actuatorport::minValue [private]

The minimum value to be set

Definition at line 31 of file Actuatorport.h.

Referenced by getMinValue(), and setValue().

std::string Actuatorport::name [private]

The name of the port

Definition at line 25 of file Actuatorport.h.

Referenced by getName().

int Actuatorport::portId [private]

The id of the port

Definition at line 29 of file Actuatorport.h.

Referenced by setValue().


The documentation for this class was generated from the following files:
Generated on Thu Dec 7 01:18:48 2006 for DT2005.panorama by  doxygen 1.4.7