Simbody  3.5
SimTK::ForceSubsystem::Guts Class Reference

Public declaration of internals for ForceSubsystem extension. More...

+ Inheritance diagram for SimTK::ForceSubsystem::Guts:

List of all members.

Public Member Functions

 Guts (const String &name, const String &version)
 This constructor is for use in the constructors of derived Subsystems.
virtual ~Guts ()
 Destructor is virtual to permit cleanup of derived classes.
const MultibodySystemgetMultibodySystem () const
virtual Real calcPotentialEnergy (const State &state) const =0
 Get this subsystem's contribution to the potential energy.
 SimTK_DOWNCAST (ForceSubsystem::Guts, Subsystem::Guts)

Detailed Description

Public declaration of internals for ForceSubsystem extension.


Constructor & Destructor Documentation

SimTK::ForceSubsystem::Guts::Guts ( const String name,
const String version 
) [inline]

This constructor is for use in the constructors of derived Subsystems.

This serves as a default constructor since both arguments have defaults. The name and version strings are not interpreted by Simbody in any way; they are simply stored and returned as given.

Reimplemented from SimTK::Subsystem::Guts.

virtual SimTK::ForceSubsystem::Guts::~Guts ( ) [inline, virtual]

Destructor is virtual to permit cleanup of derived classes.

Reimplemented from SimTK::Subsystem::Guts.


Member Function Documentation

virtual Real SimTK::ForceSubsystem::Guts::calcPotentialEnergy ( const State state) const [pure virtual]

Get this subsystem's contribution to the potential energy.

The state must be at Dynamics stage or later.


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