AnimatSim::Gains Namespace Reference

Contains the different gain type classes that can be used. More...

Classes
class	BellGain
	Bell gain class. More...
class	EquationGain
	Equation gain. More...
class	Gain
	The Gain base class. More...
class	LengthTensionGain
	Length-Tension muscle gain. More...
class	PolynomialGain
	Polynomial gain. More...
class	SigmoidGain
	Sigmoid gain. More...

Functions
Gain *	LoadGain (Simulator *lpSim, std::string strName, CStdXml &oXml)
Gain *	LoadGain (Simulator *lpSim, std::string strName, CStdXml &oXml)
	Loads a gain object. More...

Detailed Description

Contains the different gain type classes that can be used.

A gain is essentially an equation to convert one parameter into a different value. It is used extensively throughout the system, for example in the adapters.

Function Documentation

Gain* AnimatSim::Gains::LoadGain	(	Simulator *	lpSim,
		std::string	strName,
		CStdXml &	oXml
	)

Loads a gain object.

Author

dcofer

Date

3/16/2011

Parameters

[in,out]	lpSim	Pointer to a simulation.
	strName	Name of the xml element.
[in,out]	oXml	The xml being loaded.

Returns

Pointer to the loaded gain.

Exceptions

Throws

an exception if there is a problem during the load.

Definition at line 287 of file Gain.cpp.

References AnimatSim::Simulator::CreateObject(), StdUtils::CStdXml::GetChildString(), StdUtils::CStdXml::IntoChildElement(), StdUtils::CStdErrorInfo::m_lError, StdUtils::CStdErrorInfo::m_strError, StdUtils::CStdXml::OutOfElem(), and AnimatSim::AnimatBase::SetSystemPointers().

Referenced by AnimatSim::Robotics::PassThroughLinkage::AddGain(), AnimatSim::Robotics::RobotPartInterface::AddGain(), AnimatSim::Adapters::Adapter::AddGain(), FiringRateSim::Neurons::RandomNeuron::BurstLengthDistribution(), FiringRateSim::Neurons::RandomNeuron::CurrentDistribution(), IntegrateFireSim::IonChannel::Hinf(), FiringRateSim::Neurons::RandomNeuron::InterbusrtLengthDistribution(), IntegrateFireSim::IonChannel::Minf(), FiringRateSim::Synapses::ModulateNeuronPropSynapse::ModulationGain(), IntegrateFireSim::IonChannel::Th(), and IntegrateFireSim::IonChannel::Tm().

Here is the call graph for this function:

Here is the caller graph for this function: