plask::OnePointAxis Struct Reference

A trivial axis that contains only one point. More...

#include <plask/mesh/axis1d.hpp>

Inheritance diagram for plask::OnePointAxis:

Collaboration diagram for plask::OnePointAxis:

Public Member Functions
	OnePointAxis (double val)
	Create the trivial axis.
std::size_t	size () const override
double	at (std::size_t) const override
	Get point with given mesh index.
bool	isIncreasing () const override
Public Member Functions inherited from plask::MeshAxis
virtual shared_ptr< MeshAxis >	clone () const
	Create new mesh which has copy of data included in this.
virtual std::size_t	findIndex (double to_find) const
	Find index where to_find point could be inserted.
virtual std::size_t	findUpIndex (double to_find) const
	Find the lowest index for which coordinate is larger than to_find.
virtual std::size_t	findNearestIndex (double to_find) const
	Find index nearest to to_find.
virtual shared_ptr< MeshAxis >	getMidpointAxis () const
	Return an axis that enables iterating over middle points of the ranges.
Public Member Functions inherited from plask::MeshD< 1 >
LocalCoords	operator[] (std::size_t index) const
	Get point with given mesh index.
const_iterator	begin () const
const_iterator	end () const
	MeshD (const MeshD &PLASK_UNUSED(to_copy))
	Initialize this to be the same as to_copy but don't copy any changes observer.
	MeshD ()
MeshD &	operator= (const MeshD &PLASK_UNUSED(to_copy))
	Set this to be the same as to_copy but doesn't changed changes observer.
bool	operator== (const MeshD &to_compare) const
	Check if this mesh and to_compare represent the same sequence of points (have exactly the same points in the same order).
bool	operator!= (const MeshD &to_compare) const
	Check if this mesh and to_compare represent different sequences of points.
void	print (std::ostream &out) const override
	Print this to stream out.
Public Member Functions inherited from plask::Mesh
template<typename ClassT , typename methodT >
boost::signals2::connection	changedConnectMethod (ClassT *obj, methodT method, boost::signals2::connect_position at=boost::signals2::at_back)
	Connect a method to changed signal.
template<typename ClassT , typename methodT >
void	changedDisconnectMethod (ClassT *obj, methodT method)
template<typename EventT = Event, typename ... Args>
void	fireChanged (Args &&... event_constructor_params_without_source)
	Call changed with this as event source.
void	fireResized ()
	This method is called when the mesh is resized.
virtual bool	empty () const
virtual void	writeXML (XMLElement &object) const
	Write mesh to XML.
virtual	~Mesh ()
Public Member Functions inherited from plask::Printable
virtual	~Printable ()
std::string	str () const
	Get string representation of this using print method.
Public Member Functions inherited from plask::MeshBase
virtual	~MeshBase ()

Public Attributes
double	value
Public Attributes inherited from plask::Mesh
boost::signals2::signal< void(Event &)>	changed
	Changed signal, fired when mesh was changed.

Additional Inherited Members
Public Types inherited from plask::MeshD< 1 >
enum
	Number of dimensions. More...
typedef Primitive< DIM >::DVec	LocalCoords
	Type of vector representing coordinates in local space.
typedef IndexedIterator< const MeshD< dimension >, LocalCoords >	const_iterator
	Random access iterator type which allow iterate over all points in this mesh, in order appointed by operator[].
typedef const_iterator	iterator
typedef const_iterator	Iterator
Protected Member Functions inherited from plask::MeshAxis
void	beforeCalcMidpointMesh () const
	Throw exception if this mesh has less than two point.
Protected Member Functions inherited from plask::MeshD< 1 >
virtual bool	hasSameNodes (const MeshD< dimension > &to_compare) const
	Check if this mesh and to_compare represent the same sequence of points (have exactly the same points in the same order).
Protected Member Functions inherited from plask::Mesh
virtual void	onChange (const Event &evt)
	This method is called when the mesh is changed, just before changed signal.

Detailed Description

A trivial axis that contains only one point.

Definition at line 112 of file axis1d.hpp.

Constructor & Destructor Documentation

OnePointAxis()

plask::OnePointAxis::OnePointAxis ( double  val )

inline

Create the trivial axis.

Parameters

val	value of the single point in the axis

Definition at line 120 of file axis1d.hpp.

Member Function Documentation

at()

double plask::OnePointAxis::at ( std::size_t  index ) const

inlineoverridevirtual

Get point with given mesh index.

Parameters

index

index of point, from 0 to size()-1

Returns

point with given index

Implements plask::MeshD< 1 >.

Definition at line 124 of file axis1d.hpp.

isIncreasing()

bool plask::OnePointAxis::isIncreasing ( ) const

inlineoverridevirtual

Returns

true only if points are in increasing order, false if points are in decreasing order

Implements plask::MeshAxis.

Definition at line 126 of file axis1d.hpp.

size()

std::size_t plask::OnePointAxis::size ( ) const

inlineoverridevirtual

Returns

number of points in mesh

Implements plask::Mesh.

Definition at line 122 of file axis1d.hpp.

Member Data Documentation

value

double plask::OnePointAxis::value

Definition at line 114 of file axis1d.hpp.

---

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

• plask/mesh/axis1d.hpp