SIM_OptionsUser Class Reference

#include <SIM_OptionsUser.h>

Inheritance diagram for SIM_OptionsUser:

List of all members.

Public Member Functions
	SIM_OptionsUser (SIM_Data *owner)
virtual	~SIM_OptionsUser ()
void	optionChanged (const char *name)
Protected Member Functions
const SIM_Options &	getOptions () const
SIM_Options &	getOptions ()
virtual void	optionChangedSubclass (const char *name)

---

Detailed Description

This class can be included as a base class of any SIM_Data subclass. Doing so provides an easy way to establish and store a set of simple values that define that data type. The macros at the end of this file make it easy to create get and set access functions for this data.

Examples:

SIM/SIM_ElectricalProperties.C, SIM/SIM_ElectricalProperties.h, SIM/SIM_ForceOrbit.C, SIM/SIM_ForceOrbit.h, SIM/SIM_SolverHair.C, SIM/SIM_SolverHair.h, SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 26 of file SIM_OptionsUser.h.

---

Constructor & Destructor Documentation

SIM_OptionsUser::SIM_OptionsUser

(

SIM_Data *

owner

)

virtual SIM_OptionsUser::~SIM_OptionsUser

(

)

[virtual]

---

Member Function Documentation

SIM_Options& SIM_OptionsUser::getOptions

(

)

[protected]

const SIM_Options& SIM_OptionsUser::getOptions

(

)

const [protected]

void SIM_OptionsUser::optionChanged

(

const char *

name

)

This callback function that is run by SIM_Options::optionChanged(). It calls the virtual optionChangedSubclass().

virtual void SIM_OptionsUser::optionChangedSubclass

(

const char *

name

)

[protected, virtual]

Reimplemented in RBD_State, SIM_IndexField, SIM_MatrixField, SIM_NoiseStandard, SIM_PositionSimple, SIM_ScalarField, SIM_SlicePlane, SIM_VectorField, and HDK_Sample::SNOW_VoxelArray.

---

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

• SIM/SIM_OptionsUser.h