gtsam::GenericValue< T > Class Template Reference

Detailed Description

template<class T>
class gtsam::GenericValue< T >

Wraps any type T so it can play as a Value.

Inheritance diagram for gtsam::GenericValue< T >:

Public Member Functions
	GenericValue (const T &value)
	Construct from value.
const T &	value () const
	Return a constant value.
T &	value ()
	Return the value.
virtual	~GenericValue ()
	Destructor.
virtual bool	equals_ (const Value &p, double tol=1e-9) const
	equals implementing generic Value interface
bool	equals (const GenericValue &other, double tol=1e-9) const
	non virtual equals function, uses traits
virtual void	print (const std::string &str) const
	Virtual print function, uses traits.
virtual Value *	clone_ () const
	Create a duplicate object returned as a pointer to the generic Value interface. More...
virtual void	deallocate_ () const
	Destroy and deallocate this object, only if it was originally allocated using clone_().
virtual boost::shared_ptr< Value >	clone () const
	Clone this value (normal clone on the heap, delete with 'delete' operator)
virtual Value *	retract_ (const Vector &delta) const
	Generic Value interface version of retract.
virtual Vector	localCoordinates_ (const Value &value2) const
	Generic Value interface version of localCoordinates.
GenericValue	retract (const Vector &delta) const
	Non-virtual version of retract.
Vector	localCoordinates (const GenericValue &value2) const
	Non-virtual version of localCoordinates.
virtual size_t	dim () const
	Return run-time dimensionality.
virtual Value &	operator= (const Value &rhs)
	Assignment operator.
Public Member Functions inherited from gtsam::Value
template<typename ValueType >
const ValueType &	cast () const
	Cast to known ValueType.
virtual	~Value ()
	Virutal destructor.

Public Types
typedef T	type

Protected Member Functions
GenericValue< T > &	operator= (const GenericValue< T > &rhs)
	Assignment operator, protected because only the Value or DERIVED assignment operators should be used. More...

Protected Attributes
T	value_
	The wrapped value.

Friends
class	boost::serialization::access
	Serialization function.

Member Function Documentation

clone_()

template<class T>

virtual Value* gtsam::GenericValue< T >::clone_ ( ) const

inlinevirtual

Create a duplicate object returned as a pointer to the generic Value interface.

For the sake of performance, this function use singleton pool allocator instead of the normal heap allocator. The result must be deleted with Value::deallocate_, not with the 'delete' operator.

Implements gtsam::Value.

operator=()

template<class T>

GenericValue<T>& gtsam::GenericValue< T >::operator= ( const GenericValue< T > &  rhs )

inlineprotected

Assignment operator, protected because only the Value or DERIVED assignment operators should be used.

---

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

• /Users/dellaert/git/gtsam/gtsam/base/GenericValue.h