Stg::PowerPack Class Reference

#include <stage.hh>

List of all members.

Classes

class  DissipationVis

Public Member Functions

void Add (stg_joules_t j)
void ChargeStart ()
void ChargeStop ()
void Dissipate (stg_joules_t j, const Pose &p)
void Dissipate (stg_joules_t j)
stg_joules_t GetCapacity () const
bool GetCharging () const
stg_joules_t GetDissipated () const
stg_joules_t GetStored () const
 PowerPack (Model *mod)
void Print (const char *prefix) const
void Print (char *prefix) const
double ProportionRemaining () const
stg_joules_t RemainingCapacity () const
void SetCapacity (stg_joules_t j)
void SetStored (stg_joules_t j)
void Subtract (stg_joules_t j)
void TransferTo (PowerPack *dest, stg_joules_t amount)
void Visualize (Camera *cam)
 ~PowerPack ()

Protected Attributes

stg_joules_t capacity
bool charging
stg_joules_t dissipated
Stg::PowerPack::DissipationVis event_vis
stg_joules_t last_joules
stg_usec_t last_time
stg_watts_t last_watts
Modelmod
StripPlotVis output_vis
stg_joules_t stored
StripPlotVis stored_vis

Static Protected Attributes

static stg_joules_t global_capacity
static stg_joules_t global_dissipated
static stg_joules_t global_input
static stg_joules_t global_stored

Friends

class Canvas
class WorldGui

Detailed Description

Definition at line 1469 of file stage.hh.


Constructor & Destructor Documentation

Stg::PowerPack::PowerPack ( Model mod  ) 
Stg::PowerPack::~PowerPack (  ) 

Member Function Documentation

void Stg::PowerPack::Add ( stg_joules_t  j  ) 

Add to the energy store

void Stg::PowerPack::ChargeStart (  )  [inline]

Definition at line 1567 of file stage.hh.

void Stg::PowerPack::ChargeStop (  )  [inline]

Definition at line 1568 of file stage.hh.

void Stg::PowerPack::Dissipate ( stg_joules_t  j,
const Pose p 
)

Lose energy as work or heat, and record the event

void Stg::PowerPack::Dissipate ( stg_joules_t  j  ) 

Lose energy as work or heat

stg_joules_t Stg::PowerPack::GetCapacity (  )  const
bool Stg::PowerPack::GetCharging (  )  const [inline]

Returns true iff the device received energy at the last timestep

Definition at line 1565 of file stage.hh.

stg_joules_t Stg::PowerPack::GetDissipated (  )  const
stg_joules_t Stg::PowerPack::GetStored (  )  const
void Stg::PowerPack::Print ( const char *  prefix  )  const [inline]

Definition at line 1555 of file stage.hh.

void Stg::PowerPack::Print ( char *  prefix  )  const

Print human-readable status on stdout, prefixed with the argument string

double Stg::PowerPack::ProportionRemaining (  )  const [inline]

Definition at line 1552 of file stage.hh.

stg_joules_t Stg::PowerPack::RemainingCapacity (  )  const

Returns the energy capacity minus the current amount stored

void Stg::PowerPack::SetCapacity ( stg_joules_t  j  ) 
void Stg::PowerPack::SetStored ( stg_joules_t  j  ) 
void Stg::PowerPack::Subtract ( stg_joules_t  j  ) 

Subtract from the energy store

void Stg::PowerPack::TransferTo ( PowerPack dest,
stg_joules_t  amount 
)

Transfer some stored energy to another power pack

void Stg::PowerPack::Visualize ( Camera cam  ) 

OpenGL visualization of the powerpack state


Friends And Related Function Documentation

friend class Canvas [friend]

Definition at line 1472 of file stage.hh.

friend class WorldGui [friend]

Definition at line 1471 of file stage.hh.


Member Data Documentation

Energy capacity

Definition at line 1511 of file stage.hh.

bool Stg::PowerPack::charging [protected]

TRUE iff the device is receiving energy

Definition at line 1514 of file stage.hh.

Energy dissipated

Definition at line 1517 of file stage.hh.

Definition at line 1525 of file stage.hh.

Definition at line 1526 of file stage.hh.

Definition at line 1527 of file stage.hh.

Definition at line 1524 of file stage.hh.

Definition at line 1521 of file stage.hh.

Definition at line 1520 of file stage.hh.

Definition at line 1522 of file stage.hh.

Model* Stg::PowerPack::mod [protected]

The model that owns this object

Definition at line 1505 of file stage.hh.

Definition at line 1501 of file stage.hh.

Energy stored

Definition at line 1508 of file stage.hh.

Definition at line 1502 of file stage.hh.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


stage
Author(s): Richard Vaughan, with contributions from many others. See web page for a full credits list.
autogenerated on Fri Jan 11 10:03:40 2013