trick/trick_models/Ball++/L1/include/Ball.hh
Alex Lin 14a75508a3 Cleaning up once include variables and copyright cleanup.
Changed all header file once include variables to follow the same naming
convention and not start with any underscores.  Also deleted old
incorrect copyright notices.  Also removed $Id: tags from all files.

Fixes #14.  Fixes #22.
2015-03-23 16:03:14 -05:00

85 lines
1.8 KiB
C++

/**
@file
@verbatim
PURPOSE:
(Ball model EOM state parameter definition.)
LANGUAGE:
(C++)
REFERENCES:
(((Bailey, R.W, and Paddock, E.J.)
(Trick Simulation Environment) (NASA:JSC #37943)
(JSC/Engineering Directorate/Automation, Robotics and Simulation Division)
(March 1997)))
ASSUMPTIONS AND LIMITATIONS:
((2 dimensional space)
(Translational EOM only))
LIBRARY DEPENDENCY:
((../src/Ball.cpp)
(../src/BallStateDeriv.cpp)
(../src/BallStateInit.cpp)
(../src/BallStateInteg.cpp)
(../src/BallStatePrint.cpp)
(../src/BallForceField.cpp)
(../src/BallShutdown.cpp))
PROGRAMMERS:
(((Robert W. Bailey) (Sweet Systems Inc) (March 1997) (Tutorial Lesson 1))
((Edwin Z. Crues)(Titan Systems Corp.)(Jan 2002)(Crude C++ translation)))
@endverbatim
*******************************************************************************/
#ifndef BALL_HH
#define BALL_HH
// System include files.
#include <iostream>
// Model include files.
#include "BallState.hh"
#include "BallForce.hh"
/** @class Ball
@brief ball in C++
*/
#include "sim_services/include/mm_macros.hh"
class Ball {
TRICK_MM_INTERFACE(Ball, Ball)
public:
// Default constructor and destructor.
Ball();
~Ball();
// Initialization functions.
int state_init();
// Derivative class jobs.
int force_field();
int state_deriv();
// Integration class jobs.
int state_integ();
int state_print() ;
int shutdown() ;
// Trick requires all logged data to be public.
BallState state; /**< -- Ball state object. */
BallForce force; /**< -- Ball force object. */
};
#ifdef SWIG
// This SWIG statement give us the capability to print the entire Ball class with a single print
%struct_str(Ball)
#endif
#endif /* _BALL_HH_ */