HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DT_Value Class Reference

Opaque data type to pass values of any type across boundaries. More...

#include <DT_Plugin.h>

+ Inheritance diagram for DT_Value:

Public Member Functions

 DT_Value ()
 
template<typename T >
 DT_Value (const T &value)
 
template<typename T >
DT_Valueoperator= (const T &value)
 
void copy (const DT_Value &v)
 
void clear ()
 Reset the DT_Value object to be empty. More...
 
template<typename T >
const Tget () const
 

Detailed Description

Opaque data type to pass values of any type across boundaries.

Definition at line 115 of file DT_Plugin.h.

Constructor & Destructor Documentation

DT_Value::DT_Value ( )
inline

Create a new, empty DT_Value object. A value can be assigned to it later using the assignment operator.

Definition at line 120 of file DT_Plugin.h.

template<typename T >
DT_Value::DT_Value ( const T value)
inline

Create a new DT_Value from the given value. A copy of the incoming value will be stored, rather than a reference to it.

Definition at line 125 of file DT_Plugin.h.

Member Function Documentation

void DT_Value::clear ( )
inline

Reset the DT_Value object to be empty.

Definition at line 143 of file DT_Plugin.h.

void DT_Value::copy ( const DT_Value v)
inline

An explicit copy function to copy in a new DT_Value. The call is explicit, rather than using the implicit assignment operator, to avoid arbitrary copying, which can get expensive for large objects.

Definition at line 139 of file DT_Plugin.h.

template<typename T >
const T& DT_Value::get ( ) const
inline

Return a reference to the value contained within. It is important that the type matches, otherwise an exception is thrown.

Definition at line 157 of file DT_Plugin.h.

template<typename T >
DT_Value& DT_Value::operator= ( const T value)
inline

Assign a new value to this DT_Value. Any previous value will be destroyed, and a copy made of the incoming value.

Definition at line 130 of file DT_Plugin.h.


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