class Gambit::BEvariable_bucket
An interface class for backend variables. More…
#include <safety_bucket.hpp>
Inherits from Gambit::BE_bucket_base, Gambit::safety_bucket_base
Public Functions
| Name | |
|---|---|
| BEvariable_bucket(str mym, str myf, str me, backend_functor< TYPE ()(), TYPE * > * functor_ptr_in =NULL) Constructor for BEvariable_bucket. | |
| void | initialize(backend_functor< TYPE ()(), TYPE * > * functor_ptr_in) Initialize this bucket with a functor pointer. |
| TYPE & | operator*() Dereference the variable pointer stored as a safe_variable_ptr. |
| TYPE * | operator->() Access member functions. |
| TYPE * | pointer() Get the underlying variable pointer. |
| safe_variable_ptr< TYPE > & | safe_pointer() Get the safe_variable_ptr. |
Protected Attributes
| Name | |
|---|---|
| backend_functor< TYPE ()(), TYPE * > * | _functor_ptr |
| safe_variable_ptr< TYPE > | _svptr |
Additional inherited members
Public Functions inherited from Gambit::BE_bucket_base
| Name | |
|---|---|
| BE_bucket_base(str mym, str myf, str me) Constructor for BE_bucket_base. | |
| str | backend() Get backend name. |
| str | version() Get version information. |
Public Functions inherited from Gambit::safety_bucket_base
| Name | |
|---|---|
| safety_bucket_base(str myinfo) Master constructor. | |
| bool | active() |
| str | name() Get capability name. |
| str | origin() Get name of origin (module/backend). |
Protected Functions inherited from Gambit::safety_bucket_base
| Name | |
|---|---|
| void | dieGracefully() const Failure message invoked when the user tries to access the object before it is initialized. |
Protected Attributes inherited from Gambit::safety_bucket_base
| Name | |
|---|---|
| functor * | _functor_base_ptr |
| bool | _initialized |
| const str | whoami |
Detailed Description
template <typename TYPE >
class Gambit::BEvariable_bucket;
An interface class for backend variables.
Public Functions Documentation
function BEvariable_bucket
inline BEvariable_bucket(
str mym,
str myf,
str me,
backend_functor< TYPE *(*)(), TYPE * > * functor_ptr_in =NULL
)
Constructor for BEvariable_bucket.
function initialize
inline void initialize(
backend_functor< TYPE *(*)(), TYPE * > * functor_ptr_in
)
Initialize this bucket with a functor pointer.
function operator*
inline TYPE & operator*()
Dereference the variable pointer stored as a safe_variable_ptr.
function operator->
inline TYPE * operator->()
Access member functions.
function pointer
inline TYPE * pointer()
Get the underlying variable pointer.
function safe_pointer
inline safe_variable_ptr< TYPE > & safe_pointer()
Get the safe_variable_ptr.
Protected Attributes Documentation
variable _functor_ptr
backend_functor< TYPE *(*)(), TYPE * > * _functor_ptr;
variable _svptr
safe_variable_ptr< TYPE > _svptr;
Updated on 2023-06-26 at 21:36:50 +0000