AGX Dynamics 2.42.1.1
Loading...
Searching...
No Matches
agxData::Scalar< T > Class Template Reference

Templated scalar. More...

#include <Scalar.h>

+ Inheritance diagram for agxData::Scalar< T >:

Public Types

typedef T Type
 

Public Member Functions

 Scalar (const Scalar< T > &other, agx::IndexRange localRange)
 
 Scalar (const T &value=T())
 
 Scalar (void *storage)
 
T & get ()
 
const T & get () const
 
 operator const T & () const
 
 operator T& ()
 
Scalar< T > & operator= (const Scalar< T > &value)
 
Scalar< T > & operator= (const T &value)
 
T & operator[] (size_t index)
 
const T & operator[] (size_t index) const
 
- Public Member Functions inherited from agxData::AbstractScalar
 AbstractScalar ()
 
 AbstractScalar (const AbstractScalar &other, agx::IndexRange localRange)
 
 AbstractScalar (void *storage)
 
template<typename T >
T & get ()
 
template<typename T >
const T & get () const
 
void setStorage (void *storage)
 Set the memory area for the scalar.
 
size_t size () const
 
- Public Member Functions inherited from agxData::Data
 Data (void *ptr=nullptr)
 
AbstractArrayasArray ()
 
template<typename T >
Array< T > & asArray ()
 
const AbstractArrayasArray () const
 
template<typename T >
const Array< T > & asArray () const
 
AbstractScalarasScalar ()
 
template<typename T >
Scalar< T > & asScalar ()
 
const AbstractScalarasScalar () const
 
template<typename T >
const Scalar< T > & asScalar () const
 
void * ptr ()
 
const void * ptr () const
 

Static Public Attributes

static const bool IsScalar = true
 

Additional Inherited Members

- Protected Attributes inherited from agxData::Data
void * m_ptr
 

Detailed Description

template<typename T>
class agxData::Scalar< T >

Templated scalar.

Definition at line 55 of file Scalar.h.

Member Typedef Documentation

◆ Type

template<typename T >
typedef T agxData::Scalar< T >::Type

Definition at line 58 of file Scalar.h.

Constructor & Destructor Documentation

◆ Scalar() [1/3]

template<typename T >
agxData::Scalar< T >::Scalar ( const T &  value = T())

Definition at line 145 of file Scalar.h.

◆ Scalar() [2/3]

template<typename T >
agxData::Scalar< T >::Scalar ( void *  storage)

Definition at line 148 of file Scalar.h.

◆ Scalar() [3/3]

template<typename T >
agxData::Scalar< T >::Scalar ( const Scalar< T > &  other,
agx::IndexRange  localRange 
)

Definition at line 151 of file Scalar.h.

Member Function Documentation

◆ get() [1/2]

template<typename T >
T & agxData::Scalar< T >::get
Returns
The data value

Definition at line 156 of file Scalar.h.

◆ get() [2/2]

template<typename T >
const T & agxData::Scalar< T >::get

Definition at line 159 of file Scalar.h.

◆ operator const T &()

template<typename T >
agxData::Scalar< T >::operator const T &

Definition at line 171 of file Scalar.h.

◆ operator T&()

template<typename T >
agxData::Scalar< T >::operator T&

Definition at line 168 of file Scalar.h.

◆ operator=() [1/2]

template<typename T >
Scalar< T > & agxData::Scalar< T >::operator= ( const Scalar< T > &  value)

Definition at line 174 of file Scalar.h.

References agxData::Data::m_ptr.

◆ operator=() [2/2]

template<typename T >
Scalar< T > & agxData::Scalar< T >::operator= ( const T &  value)

Definition at line 177 of file Scalar.h.

◆ operator[]() [1/2]

template<typename T >
T & agxData::Scalar< T >::operator[] ( size_t  index)
Returns
The data value (Used for template programming)

Definition at line 162 of file Scalar.h.

◆ operator[]() [2/2]

template<typename T >
const T & agxData::Scalar< T >::operator[] ( size_t  index) const

Definition at line 165 of file Scalar.h.

Member Data Documentation

◆ IsScalar

template<typename T >
const bool agxData::Scalar< T >::IsScalar = true
static

Definition at line 59 of file Scalar.h.


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