physics::HeightField Class Reference

Inheritance diagram for physics::HeightField:

[legend]Collaboration diagram for physics::HeightField:

[legend]List of all members.

Public Member Functions
	HeightField ()
	HeightField (const HeightField &heightfield)
	HeightField (Int nx, Int ny, Real dx, Real dy) throw (std::invalid_argument)
	HeightField (ref< base::VFile > file) throw (std::invalid_argument, base::io_error)
virtual	~HeightField ()
virtual String	className () const
virtual base::Object &	clone () const
Real &	height (Real x, Real y) throw (std::out_of_range)
const Real &	height (Real x, Real y) const throw (std::out_of_range)
Real &	at (Real x, Real y) throw (std::out_of_range)
const Real &	at (Real x, Real y) const throw (std::out_of_range)
Real &	height (Int xi, Int yi) throw ()
const Real &	height (Int xi, Int yi) const throw ()
Real	operator[] (Int i) const throw ()
Real &	operator[] (Int i) throw ()
Real	dx () const throw ()
Real	dy () const throw ()
Int	nx () const throw ()
Int	ny () const throw ()
Real	xsize () const throw ()
Real	ysize () const throw ()
void	setResolution (Real dx, Real dy) throw (std::invalid_argument)
void	load (ref< base::VFile > file) throw (std::invalid_argument, base::io_error)
void	save (ref< base::VFile > file) throw (std::invalid_argument, base::io_error)
void	scale (Real s)
void	scaleHeights (Real s)
Real	maxHeight ()
Real	minHeight ()
virtual bool	isSameKindAs (const ReferencedObject &) const
virtual bool	isSameKindAs (const Object &) const
void	reference () const
bool	unreference () const
const int	referenceCount () const
void	enableOnUnreferenceCall (bool enabled)
virtual void	onUnreference () const
Protected Member Functions
void	loadDATFile (std::istream &in) throw (base::io_error)
void	loadTHFFile (std::istream &in) throw (base::io_error)
Protected Attributes
Int	_nx
Int	_ny
Real	_dx
Real	_dy
std::valarray< Real > *	hf
int	_refCount
bool	onUnreferenceEnabled

---

Constructor & Destructor Documentation

physics::HeightField::HeightField (   )

Referenced by clone().

physics::HeightField::HeightField (  const HeightField &  heightfield  )

physics::HeightField::HeightField (  Int  nx, Int  ny, Real  dx, Real  dy )  throw (std::invalid_argument)

physics::HeightField::HeightField (  ref< base::VFile >  file  )  throw (std::invalid_argument, base::io_error)

virtual physics::HeightField::~HeightField (   )  [virtual]

---

Member Function Documentation

const Real& physics::HeightField::at (  Real  x, Real  y )  const throw (std::out_of_range) [inline]

Definition at line 54 of file HeightField. References height().

Real& physics::HeightField::at (  Real  x, Real  y )  throw (std::out_of_range) [inline]

Definition at line 53 of file HeightField. References height().

virtual String physics::HeightField::className (   )  const [inline, virtual]

return the name of the object's class type. Must be defined by derived classes. Implements base::Object. Definition at line 48 of file HeightField. Referenced by clone().

virtual base::Object& physics::HeightField::clone (   )  const [inline, virtual]

Definition at line 49 of file HeightField. References className(), HeightField(), and NewNamedObj.

Real physics::HeightField::dx (   )  const throw () [inline]

Definition at line 62 of file HeightField. References _dx.

Real physics::HeightField::dy (   )  const throw () [inline]

Definition at line 63 of file HeightField. References _dy.

void base::Referenced::enableOnUnreferenceCall (  bool  enabled  )  [inline, inherited]

If enabled, each call to unreference() will also call virtual method onUnreference() Definition at line 115 of file Referenced. References base::Referenced::onUnreferenceEnabled.

const Real& physics::HeightField::height (  Int  xi, Int  yi )  const throw () [inline]

Definition at line 58 of file HeightField. References _nx.

Real& physics::HeightField::height (  Int  xi, Int  yi )  throw () [inline]

Definition at line 57 of file HeightField. References _nx.

const Real& physics::HeightField::height (  Real  x, Real  y )  const throw (std::out_of_range)

Real& physics::HeightField::height (  Real  x, Real  y )  throw (std::out_of_range)

Referenced by at().

virtual bool base::Object::isSameKindAs (  const Object &   )  const [inline, virtual, inherited]

Definition at line 47 of file Object.

virtual bool base::ReferencedObject::isSameKindAs (  const ReferencedObject &   )  const [inline, virtual, inherited]

Definition at line 52 of file ReferencedObject.

void physics::HeightField::load (  ref< base::VFile >  file  )  throw (std::invalid_argument, base::io_error)

void physics::HeightField::loadDATFile (  std::istream &  in  )  throw (base::io_error) [protected]

void physics::HeightField::loadTHFFile (  std::istream &  in  )  throw (base::io_error) [protected]

Real physics::HeightField::maxHeight (   )

Real physics::HeightField::minHeight (   )

Int physics::HeightField::nx (   )  const throw () [inline]

Definition at line 64 of file HeightField. References _nx.

Int physics::HeightField::ny (   )  const throw () [inline]

Definition at line 65 of file HeightField. References _ny.

virtual void base::Referenced::onUnreference (   )  const [inline, virtual, inherited]

Called by unreference() if enabled via enableOnUnreferenceCall(true). Typically overridden in subclasses that wish to know about unreference() calls - for example to handle manually breaking cyclic references Reimplemented in robot::control::ControllableAdaptor::AdaptorControlInterface, and robot::control::ControllableAdaptor. Definition at line 121 of file Referenced. Referenced by base::Referenced::unreference().

Real& physics::HeightField::operator[] (  Int  i  )  throw () [inline]

Definition at line 60 of file HeightField.

Real physics::HeightField::operator[] (  Int  i  )  const throw () [inline]

Definition at line 59 of file HeightField.

void base::Referenced::reference (   )  const [inline, inherited]

Increment the reference count by one, indicating that this object has another pointer which is referencing it. Definition at line 65 of file Referenced. References base::Referenced::_refCount.

const int base::Referenced::referenceCount (   )  const [inline, inherited]

Return the number pointers currently referencing this object. Definition at line 112 of file Referenced. References base::Referenced::_refCount. Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::onUnreference().

void physics::HeightField::save (  ref< base::VFile >  file  )  throw (std::invalid_argument, base::io_error)

void physics::HeightField::scale (  Real  s  )

void physics::HeightField::scaleHeights (  Real  s  )

void physics::HeightField::setResolution (  Real  dx, Real  dy )  throw (std::invalid_argument)

bool base::Referenced::unreference (   )  const [inline, inherited]

Decrement the reference count by one, indicating that a pointer to this object is referencing it. If the refence count goes to zero, it is assumed that this object is nolonger referenced and is automatically deleted. Definition at line 81 of file Referenced. References base::Referenced::_refCount, Exception, base::Referenced::onUnreference(), and base::Referenced::onUnreferenceEnabled.

Real physics::HeightField::xsize (   )  const throw () [inline]

Definition at line 66 of file HeightField. References _dx, and _nx.

Real physics::HeightField::ysize (   )  const throw () [inline]

Definition at line 67 of file HeightField. References _dy, and _ny.

---

Member Data Documentation

Real physics::HeightField::_dx [protected]

Definition at line 81 of file HeightField. Referenced by dx(), and xsize().

Real physics::HeightField::_dy [protected]

Definition at line 81 of file HeightField. Referenced by dy(), and ysize().

Int physics::HeightField::_nx [protected]

Definition at line 80 of file HeightField. Referenced by height(), nx(), and xsize().

Int physics::HeightField::_ny [protected]

Definition at line 80 of file HeightField. Referenced by ny(), and ysize().

int base::Referenced::_refCount [mutable, protected, inherited]

Definition at line 136 of file Referenced. Referenced by base::Referenced::reference(), base::Referenced::referenceCount(), base::Referenced::Referenced(), base::Referenced::unreference(), and base::Referenced::~Referenced().

std::valarray<Real>* physics::HeightField::hf [protected]

Definition at line 82 of file HeightField.

bool base::Referenced::onUnreferenceEnabled [protected, inherited]

Definition at line 137 of file Referenced. Referenced by base::Referenced::enableOnUnreferenceCall(), base::Referenced::Referenced(), and base::Referenced::unreference().

---

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

• physics/HeightField

---