ug4
Public Types | Public Member Functions | Private Attributes | List of all members
ug::VertexDescriptor Class Reference

This descriptor is mainly useful to avoid compilation errors in templated code. More...

#include <grid_base_objects.h>

Public Types

typedef Vertex *const * ConstVertexArray
 

Public Member Functions

virtual size_t num_vertices () const
 
VertexDescriptor & operator= (const VertexDescriptor &d)
 
Vertex * operator[] (size_t) const
 
void set_vertex (uint, Vertex *v)
 
void set_vertex (Vertex *v)
 
size_t size () const
 returns the number of vertices. More...
 
Vertex * vertex () const
 
virtual Vertex * vertex (size_t) const
 
 VertexDescriptor ()
 
 VertexDescriptor (const VertexDescriptor &d)
 
 VertexDescriptor (Vertex *v)
 
virtual ConstVertexArray vertices () const
 

Private Attributes

Vertex * m_v
 

Detailed Description

This descriptor is mainly useful to avoid compilation errors in templated code.

Note
Most methods here are only provided to avoid issues with other descriptors in templated code.
The only valid index is '0' for any method taking indices. If a higher index is passed, the index is ignored and '0' is used instead.

Member Typedef Documentation

◆ ConstVertexArray

typedef Vertex* const* ug::VertexDescriptor::ConstVertexArray

Constructor & Destructor Documentation

◆ VertexDescriptor() [1/3]

ug::VertexDescriptor::VertexDescriptor ( )
inline

◆ VertexDescriptor() [2/3]

ug::VertexDescriptor::VertexDescriptor ( Vertex *  v)
inline

◆ VertexDescriptor() [3/3]

ug::VertexDescriptor::VertexDescriptor ( const VertexDescriptor &  d)
inline

Member Function Documentation

◆ num_vertices()

virtual size_t ug::VertexDescriptor::num_vertices ( ) const
inlinevirtual

◆ operator=()

VertexDescriptor& ug::VertexDescriptor::operator= ( const VertexDescriptor &  d)
inline

References m_v.

◆ operator[]()

Vertex* ug::VertexDescriptor::operator[] ( size_t  ) const
inline

◆ set_vertex() [1/2]

void ug::VertexDescriptor::set_vertex ( uint  ,
Vertex *  v 
)
inline

◆ set_vertex() [2/2]

void ug::VertexDescriptor::set_vertex ( Vertex *  v)
inline

◆ size()

size_t ug::VertexDescriptor::size ( ) const
inline

returns the number of vertices.

◆ vertex() [1/2]

Vertex* ug::VertexDescriptor::vertex ( ) const
inline

Referenced by ug::Grid::get_element().

◆ vertex() [2/2]

virtual Vertex* ug::VertexDescriptor::vertex ( size_t  ) const
inlinevirtual

◆ vertices()

virtual ConstVertexArray ug::VertexDescriptor::vertices ( ) const
inlinevirtual

Member Data Documentation

◆ m_v

Vertex* ug::VertexDescriptor::m_v
private

Referenced by operator=().

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