#include <Mesh/DataStructures/MeshModelInterface/streamlinedmeshelementsinterface.h>

Inheritance diagram for StreamlinedMeshElementsInterface< T >:

Public Member Functions
	StreamlinedMeshElementsInterface (const ElementType::Type &type)

	StreamlinedMeshElementsInterface (const StreamlinedMeshElementsInterface &)

ElementHandle	add (const NodeHandleList &nodes) override

void	clear () override

bool	digestContiguousFloatStateData (const ElementStateHandle &state, std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const double *data)> digestFunc) const override

bool	digestContiguousIntegerStateData (const ElementStateHandle &state, std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const int_type *data)> digestFunc) const override

bool	digestContiguousNodeIndexData (std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const ItemHandle::size_type *data)> digestFunc) const override

bool	digestContiguousUInt16StateData (const ElementStateHandle &state, std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const quint16 *data)> digestFunc) const override

bool	digestContiguousUInt8StateData (const ElementStateHandle &state, std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const quint8 *data)> digestFunc) const override

iterator	erase (const iterator &position) override

ContiguousDataAccessType	getContiguousDataAccessType () const override

NodeHandle	getNode (const ElementHandle &element, size_type index) const override

bool	getNodes (const ElementHandle &element, NodeHandleList &nodes) const override

bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, double &result) const override

bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, int_type &result) const override

bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint16 &result) const override

bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint8 &result) const override

bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, Vector3d &result) const override

bool	isStateTypeSupported (const DataExecution::DataFactory &dataFactory) const override

bool	load (MeshSerializer &serializer) override

StreamlinedMeshElementsInterface &	operator= (const StreamlinedMeshElementsInterface &)

void	remove (const ElementHandle &elementHandle) override

void	reserve (size_type n) override

bool	save (MeshSerializer &serializer, const NodeHandleIndexHash &nodeIds) const override

bool	setNode (const ElementHandle &element, const NodeHandle &node, size_type index) override

bool	setNodes (const ElementHandle &element, const NodeHandleList &nodes) override

bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, const DataExecution::DataObject &value) override

bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, const Vector3d &value) override

bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, double value) override

bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, int_type value) override

bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint16 value) override

bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint8 value) override

size_type	size () const override

Public Member Functions inherited from MeshElementsInterface
ElementHandle	add (const NodeHandle &node0, const NodeHandle &node1)

ElementHandle	add (const NodeHandle &node0, const NodeHandle &node1, const NodeHandle &node2)

ElementHandle	add (const NodeHandle &node0, const NodeHandle &node1, const NodeHandle &node2, const NodeHandle &node3)

ElementHandle	add (const NodeHandle &node0, const NodeHandle &node1, const NodeHandle &node2, const NodeHandle &node3, const NodeHandle &node4, const NodeHandle &node5, const NodeHandle &node6, const NodeHandle &node7)

virtual ElementHandle	add (const NodeHandleList &nodes)=0

const ElementStateHandle &	addState (const QString &name, const DataExecution::DataObject &defaultValue)

template<typename T >
const ElementStateHandle &	addState (const QString &name, const T &defaultValue)

iterator	begin ()

const_iterator	begin () const

virtual bool	canAddState (const DataExecution::DataObject &defaultValue)

virtual bool	canRemoveState (const ElementStateHandle &state)

virtual void	clear ()=0

virtual bool	digestContiguousFloatStateData (const ElementStateHandle &state, std::function< bool(size_type numElems, size_type nodesPerElem, size_type stride, const double *data)> digestFunc) const

virtual bool	digestContiguousIntegerStateData (const ElementStateHandle &state, std::function< bool(size_type numElems, size_type nodesPerElem, size_type stride, const int_type *data)> digestFunc) const

virtual bool	digestContiguousNodeIndexData (std::function< bool(size_type numElems, size_type nodesPerElem, size_type stride, const ItemHandle::size_type *data)> digestFunc) const

virtual bool	digestContiguousUInt16StateData (const ElementStateHandle &state, std::function< bool(size_type numElems, size_type nodesPerElem, size_type stride, const quint16 *data)> digestFunc) const

virtual bool	digestContiguousUInt8StateData (const ElementStateHandle &state, std::function< bool(size_type numElems, size_type nodesPerElem, size_type stride, const quint8 *data)> digestFunc) const

bool	empty () const

iterator	end ()

const_iterator	end () const

bool	ensureAllStatesSupported (const ElementStateHandleList &states)

virtual iterator	erase (const iterator &position)=0

ElementStateHandleList	getAllStateHandles () const

virtual ContiguousDataAccessType	getContiguousDataAccessType () const

const ElementType::Type &	getElementType () const

virtual NodeHandle	getNode (const ElementHandle &element, size_type index) const =0

virtual int	getNodeIndex (const ElementHandle &element, const NodeHandle &node) const

virtual bool	getNodes (const ElementHandle &element, NodeHandleList &nodes) const =0

bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, DataExecution::DataObject &result)

bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, DataExecution::DataObject &result) const

virtual bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, double &result) const

virtual bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, int_type &result) const

virtual bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint16 &result) const

virtual bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint8 &result) const

virtual bool	getState (const ElementHandle &elementHandle, const ElementStateHandle &state, Vector3d &result) const

const ElementStateHandle &	getStateHandle (const QString &name) const

bool	hasState (const QString &name) const

virtual bool	isAttached (const ElementHandle &element, const NodeHandle &node) const

virtual bool	isStateTypeSupported (const DataExecution::DataFactory &dataFactory) const =0

virtual bool	isValid () const

virtual bool	load (MeshSerializer &serializer)

virtual void	remove (const ElementHandle &elementHandle)=0

bool	removeAllStates ()

bool	removeState (const ElementStateHandle &state)

bool	removeState (const QString &name)

bool	renameState (const QString &from, const QString &to)

virtual void	reserve (size_type n)

virtual bool	save (MeshSerializer &serializer, const NodeHandleIndexHash &nodeIds) const

virtual bool	setNode (const ElementHandle &element, const NodeHandle &node, size_type index)=0

virtual bool	setNodes (const ElementHandle &element, const NodeHandleList &nodes)=0

virtual bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, const DataExecution::DataObject &value)=0

virtual bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, const Vector3d &value)

virtual bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, double value)

virtual bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, int_type value)

virtual bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint16 value)

virtual bool	setState (const ElementHandle &elementHandle, const ElementStateHandle &state, quint8 value)

virtual size_type	size () const =0

Protected Member Functions
ElementStateHandle *	addStateToImplementation (const QString &name, const DataExecution::DataObject &defaultValue) override

ElementHandle	advance (const ElementHandle &elementHandle, size_type n) const override

ElementHandle	beginHandle () const override

ElementHandle	endHandle () const override

bool	getStateImpl (const ElementHandle &elementHandle, const ElementStateHandle &state, DataExecution::DataObject &result) const override

bool	getStateImpl (const ElementHandle &elementHandle, const ElementStateHandle &state, DataExecution::DataObject &result) override

bool	removeStateFromImplementation (const ElementStateHandle &state) override

Protected Member Functions inherited from MeshElementsInterface
	MeshElementsInterface (const ElementType::Type &type)

	MeshElementsInterface (const MeshElementsInterface &)

virtual	~MeshElementsInterface ()

virtual ElementStateHandle *	addStateToImplementation (const QString &name, const DataExecution::DataObject &defaultValue)=0

virtual ElementHandle	advance (const ElementHandle &elementHandle, size_type n) const =0

virtual ElementHandle	beginHandle () const

iterator	createIterator (const ElementHandle &handle) const

virtual ElementHandle	endHandle () const

virtual bool	getStateImpl (const ElementHandle &elementHandle, const ElementStateHandle &state, DataExecution::DataObject &result) const =0

virtual bool	getStateImpl (const ElementHandle &elementHandle, const ElementStateHandle &state, DataExecution::DataObject &result)=0

MeshElementsInterface &	operator= (const MeshElementsInterface &)

bool	registerExistingState (MeshModelInterface::size_type index, const QString &name, const DataExecution::DataObject &defaultValue)

virtual bool	removeStateFromImplementation (const ElementStateHandle &state)=0

virtual bool	stateBeingRenamed (const ElementStateHandle &state, const QString &to)

Additional Inherited Members
Public Types inherited from MeshElementsInterface
enum	ContiguousDataAccessType { DirectBufferAccess , CopiedBufferAccess }
	The type of access that a particular implementation provides to contiguous data. More...

using	int_type = MeshModelInterface::int_type

using	ItemHandleListType = ElementHandleList

using	ItemHandleType = ElementHandle

using	size_type = MeshModelInterface::size_type

using	StateHandleListType = ElementStateHandleList

using	StateHandleType = ElementStateHandle

Static Public Member Functions inherited from MeshElementsInterface
static MeshElementsInterface &	getNullMeshElementsInterface ()

Constructor & Destructor Documentation

◆ StreamlinedMeshElementsInterface() [1/2]

StreamlinedMeshElementsInterface ( const ElementType::Type & type )

◆ StreamlinedMeshElementsInterface() [2/2]

StreamlinedMeshElementsInterface ( const StreamlinedMeshElementsInterface< T > & other )

Member Function Documentation

◆ add()

ElementHandle add ( const NodeHandleList & nodes )

overridevirtual

Returns: An ElementHandle to the newly added element or an invalid ElementHandle if a new element could not be added. Subclass implementations can return an invalid handle simply by returning a default-constructed ElementHandle.

Implements MeshElementsInterface.

◆ addStateToImplementation()

ElementStateHandle * addStateToImplementation	(	const QString &	name,
		const DataExecution::DataObject &	defaultValue
	)

overrideprotectedvirtual

Parameters

name	Name of the state
defaultValue	A default value for this state

Derived classes must implement this method, returning the handle they will use to refer to this state. name and defaultValue are only passed to the derived class in case it also wants to do something with these parameters. The base class already stores these so most implementations will probably ignore them and simply worry about the handle.

Returns: An new ElementStateHandle with the index the implementation has associated with this state and the dataFactory of defaultValue.getDataFactory(). The caller will take ownership of this newed object. The indices assigned to states by the derived class do not have to be unique across all states or even all states for a particular a\ elementType but must be unquie amongst all states of a given DataFactory of a given ElementType::Type. Hence the dataFactory and ElementType together form the unique ID. If the state could not be added a NULL pointer should be returned.

See also: isStateTypeSupported

Implements MeshElementsInterface.

◆ advance()

ElementHandle advance	(	const ElementHandle &	elementHandle,
		size_type	n
	)		const

overrideprotectedvirtual

Returns: An ElementHandle n elements past elementHandle or endHandle() if it's past the last element.

See also: endHandle

Implements MeshElementsInterface.

◆ beginHandle()

ElementHandle beginHandle

overrideprotectedvirtual

Returns: A handle that represents the first element or endHandle() if there are no elements.

See also: begin()

Reimplemented from MeshElementsInterface.

◆ clear()

void clear ( )

overridevirtual

Clears all element data. Defined states must be removed separately via removeAllStates.

See also: removeAllStates

Implements MeshElementsInterface.

◆ digestContiguousFloatStateData()

bool digestContiguousFloatStateData	(	const ElementStateHandle &	state,
		std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const double *data)>	digestFunc
	)		const

override

Parameters

state	Handle of the state to digest.
digestFunc	Function that will digest the read-only state data from a contiguous buffer.

Returns: True if the digest function completed successfully, false otherwise.

◆ digestContiguousIntegerStateData()

bool digestContiguousIntegerStateData	(	const ElementStateHandle &	state,
		std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const int_type *data)>	digestFunc
	)		const

override

Parameters

state	Handle of the state to digest.
digestFunc	Function that will digest the read-only state data from a contiguous buffer.

Returns: True if the digest function completed successfully, false otherwise.

◆ digestContiguousNodeIndexData()

bool digestContiguousNodeIndexData ( std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const ItemHandle::size_type *data)> digestFunc ) const

override

Parameters

digestFunc Function that will digest the read-only position data from a contiguous buffer.

Returns: True if the digest function completed successfully, false otherwise.

◆ digestContiguousUInt16StateData()

bool digestContiguousUInt16StateData	(	const ElementStateHandle &	state,
		std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const quint16 *data)>	digestFunc
	)		const

override

Parameters

state	Handle of the state to digest.
digestFunc	Function that will digest the read-only state data from a contiguous buffer.

Returns: True if the digest function completed successfully, false otherwise.

◆ digestContiguousUInt8StateData()

bool digestContiguousUInt8StateData	(	const ElementStateHandle &	state,
		std::function< bool(size_type numElements, size_type nodesPerElement, size_type stride, const quint8 *data)>	digestFunc
	)		const

override

Parameters

state	Handle of the state to digest.
digestFunc	Function that will digest the read-only state data from a contiguous buffer.

Returns: True if the digest function completed successfully, false otherwise.

◆ endHandle()

CSIRO::Mesh::ElementHandle endHandle

overrideprotectedvirtual

Returns: A handle that represents the element "one past the end". Ie. An index analogous to std::container::end()

See also: elements_end()

Reimplemented from MeshElementsInterface.

◆ erase()

MeshElementsInterface::iterator erase ( const iterator & position )

overridevirtual

Returns: An iterator for the next element or end() if the erased element was at the end.

Implements MeshElementsInterface.

◆ getContiguousDataAccessType()

MeshElementsInterface::ContiguousDataAccessType getContiguousDataAccessType

overridevirtual

Returns: The type of contiguous data access permitted by this implementation.

Reimplemented from MeshElementsInterface.

◆ getNode()

NodeHandle getNode	(	const ElementHandle &	element,
		size_type	index
	)		const

overridevirtual

Parameters

element	The element handle we're requesting the nodes for
index	Which node of the given element is being requested

Implements MeshElementsInterface.

◆ getNodes()

bool getNodes	(	const ElementHandle &	element,
		NodeHandleList &	nodes
	)		const

overridevirtual

Parameters

element	The element handle we're requesting the nodes for
nodes	A node list to write the results to

Returns: Whether the requested nodes were retrieved

Implements MeshElementsInterface.

◆ getState() [1/5]

bool getState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		double &	result
	)		const

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ getState() [2/5]

bool getState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		int_type &	result
	)		const

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ getState() [3/5]

bool getState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		quint16 &	result
	)		const

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ getState() [4/5]

bool getState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		quint8 &	result
	)		const

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ getState() [5/5]

bool getState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		Vector3d &	result
	)		const

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ getStateImpl() [1/2]

bool getStateImpl	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		DataExecution::DataObject &	result
	)		const

overrideprotectedvirtual

Parameters

elementHandle	The element we're requesting the state of
state	The state we're requesting
result	A DataObject to store the result in (must be of type state.getDataObject() unless the implementation can convert)

Should be implmented as the const equivalent to getState()

This method is free to return shared data in result as it is only ever called by the public const getState method which will clone any shared data. As this is the case derived class should be able to implement the non-const getState() pure virtual as a simple call to this method as long as the only non-const thing this method does is return shared data.

See also: getState

Implements MeshElementsInterface.

◆ getStateImpl() [2/2]

bool getStateImpl	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		DataExecution::DataObject &	result
	)

overrideprotectedvirtual

Parameters

elementHandle	The element we're requesting the state of
state	The state we're requesting
result	A DataObject to store the result in (must be of type state.getDataObject() unless the implementation can convert)

See also: getState

Implements MeshElementsInterface.

◆ isStateTypeSupported()

bool isStateTypeSupported ( const DataExecution::DataFactory & dataFactory ) const

overridevirtual

Parameters

dataFactory The DataFactory for the type of state we're checking support for

Returns: Whether the implementation supports element states of this type for this element type.

See also: addState(const QString& name, const T& defaultValue)

Implements MeshElementsInterface.

◆ load()

bool load ( MeshSerializer & serializer )

overridevirtual

Reimplemented from MeshElementsInterface.

◆ operator=()

StreamlinedMeshElementsInterface< T > & operator= ( const StreamlinedMeshElementsInterface< T > & other )

◆ remove()

void remove ( const ElementHandle & elementHandle )

overridevirtual

Implements MeshElementsInterface.

◆ removeStateFromImplementation()

bool removeStateFromImplementation ( const ElementStateHandle & state )

overrideprotectedvirtual

Derived classes must implement this method, deleting the state.

Returns: true if the state was removed or false if there was an error.

Implements MeshElementsInterface.

◆ reserve()

void reserve ( size_type n )

overridevirtual

Default implementation does nothing

Reimplemented from MeshElementsInterface.

◆ save()

bool save	(	MeshSerializer &	serializer,
		const NodeHandleIndexHash &	nodeIds
	)		const

overridevirtual

Reimplemented from MeshElementsInterface.

◆ setNode()

bool setNode	(	const ElementHandle &	element,
		const NodeHandle &	node,
		size_type	index
	)

overridevirtual

Parameters

element	The element handle we're setting the nodes for
node	The node to set
index	The index to set the node for this element

Returns: Whether the requested nodes were set

Implements MeshElementsInterface.

◆ setNodes()

bool setNodes	(	const ElementHandle &	element,
		const NodeHandleList &	nodes
	)

overridevirtual

Parameters

element	The element handle we're setting the nodes for
nodes	A node list containing the nodes to set

Returns: Whether the requested nodes were set

Implements MeshElementsInterface.

◆ setState() [1/6]

bool setState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		const DataExecution::DataObject &	value
	)

overridevirtual

Parameters

elementHandle	The element we're setting the state of
state	The state we're setting
value	A DataObject containing the data to set (must be of type state.getDataObject() unless the implementation can convert)

Implements MeshElementsInterface.

◆ setState() [2/6]

bool setState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		const Vector3d &	value
	)

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ setState() [3/6]

bool setState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		double	value
	)

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ setState() [4/6]

bool setState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		int_type	value
	)

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ setState() [5/6]

bool setState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		quint16	value
	)

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ setState() [6/6]

bool setState	(	const ElementHandle &	elementHandle,
		const ElementStateHandle &	state,
		quint8	value
	)

overridevirtual

Convenience function for common type that avoids client needing to use a DataObject. This method still uses an internal TypedObject to call the implementations corresponding method unless the implementation overrides this virtual method and handles this type directly.

Reimplemented from MeshElementsInterface.

◆ size()

MeshElementsInterface::size_type size

overridevirtual

Implements MeshElementsInterface.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ StreamlinedMeshElementsInterface() [1/2]

◆ StreamlinedMeshElementsInterface() [2/2]

Member Function Documentation

◆ add()

◆ addStateToImplementation()

◆ advance()

◆ beginHandle()

◆ clear()

◆ digestContiguousFloatStateData()

◆ digestContiguousIntegerStateData()

◆ digestContiguousNodeIndexData()

◆ digestContiguousUInt16StateData()

◆ digestContiguousUInt8StateData()

◆ endHandle()

◆ erase()

◆ getContiguousDataAccessType()

◆ getNode()

◆ getNodes()

◆ getState() [1/5]

◆ getState() [2/5]

◆ getState() [3/5]

◆ getState() [4/5]

◆ getState() [5/5]

◆ getStateImpl() [1/2]

◆ getStateImpl() [2/2]

◆ isStateTypeSupported()

◆ load()

◆ operator=()

◆ remove()

◆ removeStateFromImplementation()

◆ reserve()

◆ save()

◆ setNode()

◆ setNodes()

◆ setState() [1/6]

◆ setState() [2/6]

◆ setState() [3/6]

◆ setState() [4/6]

◆ setState() [5/6]

◆ setState() [6/6]

◆ size()