agxPowerLine::LinearLookupTable Class Reference

Linear interpolation between the inserted variable/value pairs. More...

#include <PowerLineUtils.h>

Inheritance diagram for agxPowerLine::LinearLookupTable:

Public Member Functions
	LinearLookupTable (agxPowerLine::PhysicalDimension *dimension)
	Constructor.
	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxPowerLine::LinearLookupTable)
virtual agx::Real	lookup (const agx::Real x) const override
	Lookup a specific value.
virtual bool	restore (agxStream::StorageStream &str) override
	Restores internal data from stream.
virtual bool	store (agxStream::StorageStream &str) const override
	Stores internal data into stream.
Public Member Functions inherited from agxPowerLine::LookupTable
	LookupTable (agxPowerLine::PhysicalDimension *dimension)
	Create a lookup table.
	AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxPowerLine::LookupTable)
agx::Real	lookupCurrent () const
	Lookup the current value (given the dimension set.)
virtual void	restore (agxStream::InputArchive &in) override
virtual bool	restore (agxStream::StorageStream &str)
	Restores internal data from stream.
void	setDimension (agxPowerLine::PhysicalDimension *dimension)
	change dependent physical dimension
virtual void	store (agxStream::OutputArchive &out) const override
virtual bool	store (agxStream::StorageStream &str) const
	Stores internal data into stream.
virtual agx::Real	variableLookupFunction () const
	Implement this in any child class to define the lookup variable.
Public Member Functions inherited from agx::LookupTable
	LookupTable ()
	Create a lookup table.
virtual void	clear ()
	clear all data
agx::Real	getDefaultValue () const
size_t	getNumValues () const
	return the number of values in the lookup table
RealPairList::const_iterator	getValueEndIterator () const
RealPairList::const_iterator	getValueIterator () const
virtual void	insertValue (const agx::Real x, const agx::Real y)
	insert a value to the lookup table.
virtual agx::Real	lookup (const agx::Real x) const =0
	Lookup a specific value.
virtual agx::Real	resultScalerFunction () const
	Scale the found value.
void	setDefaultValue (agx::Real defaultValue)
	Set the default return value, if the table has been cleared.
virtual void	setValues (RealPairVector const &values)
	Set all lookup values at the same time (all previous will be removed.)
Public Member Functions inherited from agx::Referenced
	Referenced ()
	Default constructor.
	Referenced (const Referenced &)
template<typename T >
T *	as ()
	Subclass casting.
template<typename T >
const T *	as () const
template<typename T >
T *	asSafe ()
	Safe subclass casting, return nullptr if template type does not match.
template<typename T >
const T *	asSafe () const
int	getReferenceCount () const
template<typename T >
bool	is () const
	Subclass test.
Referenced &	operator= (const Referenced &)
	Assignment operator. Will increment the number of references to the referenced object.
void	reference (void *ptr=nullptr) const
	Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
void	unreference (void *ptr=nullptr) const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
void	unreference_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
Public Member Functions inherited from agxStream::Serializable
virtual	~Serializable ()
	Destructor for normal C++ use but hidden from SWIG bindings.
virtual const char *	getClassName () const
bool	getEnableSerialization () const
bool	getEnableUuidGeneration ()
agx::UInt32	getIndex () const
	This index is given at creation of this object.
virtual StorageAgent *	getStorageAgent () const =0
agx::Uuid	getUuid () const
bool	isFinished () const
void	setEnableSerialization (bool flag)
	Set to false to disable serialization of this object.
void	setFinished ()
	Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
void	setUuid (const agx::Uuid &uuid)
	Explicitly set a Uuid on a serializable object.
Public Member Functions inherited from agx::LinearLookupTable
	LinearLookupTable ()
	Constructor.
	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agx::LinearLookupTable)
virtual agx::Real	lookup (const agx::Real x) const override
	Lookup a specific value.

Static Public Member Functions
static agxStream::Serializable *	create (agxStream::InputArchive &)
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)
Static Public Member Functions inherited from agxStream::Serializable
static void	setEnableUuidGeneration (bool flag)
	Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
Static Public Member Functions inherited from agx::LinearLookupTable
static agxStream::Serializable *	create (agxStream::InputArchive &)

Protected Member Functions
	LinearLookupTable ()
virtual	~LinearLookupTable ()
Protected Member Functions inherited from agxPowerLine::LookupTable
	LookupTable ()
virtual	~LookupTable ()
virtual	~LookupTable ()
Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.
void	allocateObserverVector () const
void	deleteUsingDeleteHandler () const
Protected Member Functions inherited from agxStream::Serializable
	Serializable ()
	Default constructor.
	Serializable (const Serializable &other)
	Copy constructor.
void	generateUuid ()
virtual	~LinearLookupTable ()

Additional Inherited Members
Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler *	getDeleteHandler ()
static void	setDeleteHandler (DeleteHandler *handler)
	Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
Protected Attributes inherited from agxPowerLine::LookupTable
agx::observer_ptr< PhysicalDimension >	m_dimension
Protected Attributes inherited from agx::LookupTable
agx::Real	m_defaultValue
RealPairList	m_xyPair
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Detailed Description

Linear interpolation between the inserted variable/value pairs.

Values looked up outside the set range will be interpolated using the tangent at that end of the table.

Definition at line 118 of file PowerLineUtils.h.

Constructor & Destructor Documentation

LinearLookupTable() [1/2]

agxPowerLine::LinearLookupTable::LinearLookupTable

(

agxPowerLine::PhysicalDimension *

dimension

)

Constructor.

LinearLookupTable() [2/2]

agxPowerLine::LinearLookupTable::LinearLookupTable ( )

protected

~LinearLookupTable()

virtual agxPowerLine::LinearLookupTable::~LinearLookupTable ( )

protectedvirtual

Reimplemented from agx::LinearLookupTable.

Member Function Documentation

AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agxPowerLine::LinearLookupTable::AGXSTREAM_DECLARE_SERIALIZABLE_BASE

(

agxPowerLine::LinearLookupTable

)

create()

static agxStream::Serializable * agxPowerLine::LinearLookupTable::create ( agxStream::InputArchive &  )

inlinestatic

Definition at line 141 of file PowerLineUtils.h.

lookup()

virtual agx::Real agxPowerLine::LinearLookupTable::lookup ( const agx::Real  x ) const

overridevirtual

Lookup a specific value.

Reimplemented from agx::LinearLookupTable.

restore()

virtual bool agxPowerLine::LinearLookupTable::restore ( agxStream::StorageStream &  str )

overridevirtual

Restores internal data from stream.

Reimplemented from agxPowerLine::LookupTable.

Reimplemented in agxDriveTrain::deprecated::TorqueConverterSpeedRatioLookup, and agxPowerLine::PowerTimeIntegralLookupTable.

store()

virtual bool agxPowerLine::LinearLookupTable::store ( agxStream::StorageStream &  str ) const

overridevirtual

Stores internal data into stream.

Reimplemented from agxPowerLine::LookupTable.

Reimplemented in agxDriveTrain::deprecated::TorqueConverterSpeedRatioLookup, and agxPowerLine::PowerTimeIntegralLookupTable.

---

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

• PowerLineUtils.h