Base class to all grid types, e.g. More...

#include <WGrid.h>

Inheritance diagram for WGrid:

Collaboration diagram for WGrid:

Public Member Functions
	WGrid (size_t size)
	Constructs a new WGrid instance. More...

virtual	~WGrid ()
	Since WGrid is a base class and thus should be polymorphic we add virtual destructor. More...

size_t	size () const
	The number of positions in this grid. More...

virtual WBoundingBox	getBoundingBox () const =0
	Axis aligned Bounding Box that encloses this grid. More...

std::shared_ptr< WPropertyGroup >	getInformationProperties () const
	Returns a pointer to the information properties object of the grid. More...

Protected Attributes
std::shared_ptr< WPropertyGroup >	m_infoProperties
	The property object for the grid containing only props whose purpose is "PV_PURPOSE_INFORMNATION". More...

Private Attributes
size_t	m_size
	Stores the number of positions. More...

Detailed Description

Base class to all grid types, e.g.

a regular grid.

Definition at line 42 of file WGrid.h.

Constructor & Destructor Documentation

◆ WGrid()

WGrid::WGrid ( size_t size )

explicit

Constructs a new WGrid instance.

Parameters

size	number of positions in grid

Definition at line 32 of file WGrid.cpp.

References m_infoProperties, and m_size.

◆ ~WGrid()

WGrid::~WGrid ( )

virtual

Since WGrid is a base class and thus should be polymorphic we add virtual destructor.

Definition at line 40 of file WGrid.cpp.

Member Function Documentation

◆ getBoundingBox()

virtual WBoundingBox WGrid::getBoundingBox ( ) const

pure virtual

Axis aligned Bounding Box that encloses this grid.

Returns: Axis aligned Bounding Box that encloses this grid.

Implemented in WGridRegular3DTemplate< T >, and Dummy.

◆ getInformationProperties()

std::shared_ptr< WProperties > WGrid::getInformationProperties ( ) const

Returns a pointer to the information properties object of the grid.

The grid intends these properties to not be modified.

Returns: the properties.

Definition at line 49 of file WGrid.cpp.

References m_infoProperties.

◆ size()

size_t WGrid::size ( ) const

The number of positions in this grid.

Returns: The number of positions in this grid.

Definition at line 44 of file WGrid.cpp.

References m_size.

Referenced by WGridRegular3DTest::testOrientation(), and WGridRegular3DTest::testSize().

Here is the caller graph for this function:

Member Data Documentation

◆ m_infoProperties

std::shared_ptr< WPropertyGroup > WGrid::m_infoProperties

protected

The property object for the grid containing only props whose purpose is "PV_PURPOSE_INFORMNATION".

It is useful to define some property to only be of informational nature. The GUI does not modify them.

Definition at line 83 of file WGrid.h.

Referenced by getInformationProperties(), and WGrid().

◆ m_size

size_t WGrid::m_size

private

Stores the number of positions.

Definition at line 89 of file WGrid.h.

Referenced by size(), and WGrid().

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

Public Member Functions

Protected Attributes

Private Attributes