OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
DirectChannel Class Reference

Direct access to a [b]double[/b] variable. More...

#include <DirectChannel.h>

Inheritance diagram for DirectChannel:
Collaboration diagram for DirectChannel:

Public Member Functions

 DirectChannel (double &value)
 Constructor.
 DirectChannel (const DirectChannel &)
virtual ~DirectChannel ()
virtual DirectChannelclone () const
 Duplicate the channel.
virtual bool set (double)
 Store into channel.
virtual bool get (double &) const
 Fetch from channel.
double operator+= (double value)
 Add and assign [b]value[/b] to channel.
double operator-= (double value)
 Subtract and assign [b]value[/b] to channel.
virtual bool isSettable () const
 Test if settable.
 operator double () const
 Read channel.

Private Member Functions

 DirectChannel ()
const DirectChanneloperator= (const DirectChannel &)

Private Attributes

double & reference

Detailed Description

Direct access to a [b]double[/b] variable.

Definition at line 31 of file DirectChannel.h.

Constructor & Destructor Documentation

◆ DirectChannel() [1/3]

DirectChannel::DirectChannel ( double & value)
inlineexplicit

Constructor.

Definition at line 69 of file DirectChannel.h.

References reference.

Referenced by clone(), DirectChannel(), and operator=().

◆ DirectChannel() [2/3]

DirectChannel::DirectChannel ( const DirectChannel & rhs)
inline

Definition at line 74 of file DirectChannel.h.

References Channel::Channel(), DirectChannel(), and reference.

Here is the call graph for this function:

◆ ~DirectChannel()

DirectChannel::~DirectChannel ( )
inlinevirtual

Definition at line 80 of file DirectChannel.h.

◆ DirectChannel() [3/3]

DirectChannel::DirectChannel ( )
private

Referenced by clone().

Member Function Documentation

◆ clone()

DirectChannel * DirectChannel::clone ( ) const
inlinevirtual

Duplicate the channel.

Implements Channel.

Definition at line 84 of file DirectChannel.h.

References DirectChannel(), and DirectChannel().

Here is the call graph for this function:

◆ get()

bool DirectChannel::get ( double & value) const
inlinevirtual

Fetch from channel.

Implements ConstChannel.

Definition at line 95 of file DirectChannel.h.

References reference.

◆ isSettable()

bool Channel::isSettable ( ) const
virtualinherited

Test if settable.

Reimplemented from ConstChannel.

Reimplemented in IndexedChannel< T >, and IndirectChannel< T >.

Definition at line 36 of file Channel.cpp.

Referenced by ElementBase::setAttribute().

◆ operator double()

ConstChannel::operator double ( ) const
inlineinherited

Read channel.

Definition at line 46 of file ConstChannel.h.

References get().

Here is the call graph for this function:

◆ operator+=()

double Channel::operator+= ( double value)
inlineinherited

Add and assign [b]value[/b] to channel.

Definition at line 47 of file Channel.h.

References ConstChannel::get(), and set().

Here is the call graph for this function:

◆ operator-=()

double Channel::operator-= ( double value)
inlineinherited

Subtract and assign [b]value[/b] to channel.

Definition at line 51 of file Channel.h.

References ConstChannel::get(), and set().

Here is the call graph for this function:

◆ operator=()

const DirectChannel & DirectChannel::operator= ( const DirectChannel & )
private

References DirectChannel().

Here is the call graph for this function:

◆ set()

bool DirectChannel::set ( double value)
inlinevirtual

Store into channel.

Implements Channel.

Definition at line 89 of file DirectChannel.h.

References reference.

Member Data Documentation

◆ reference

double& DirectChannel::reference
private

Definition at line 65 of file DirectChannel.h.

Referenced by DirectChannel(), DirectChannel(), get(), and set().


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