OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Public Member Functions | Private Member Functions | List of all members
Channel Class Referenceabstract

Abstract interface for read/write access to variable. More...

#include <Channel.h>

Inheritance diagram for Channel:
Inheritance graph
[legend]
Collaboration diagram for Channel:
Collaboration graph
[legend]

Public Member Functions

 Channel ()
 
virtual ~Channel ()
 
virtual Channelclone () const =0
 Duplicate the channel. More...
 
double operator= (double value)
 Assign [b]value[/b] to channel. More...
 
double operator+= (double value)
 Add and assign [b]value[/b] to channel. More...
 
double operator-= (double value)
 Subtract and assign [b]value[/b] to channel. More...
 
virtual bool set (double value)=0
 Store [b]value[/b] into channel. More...
 
virtual bool isSettable () const
 Test if settable. More...
 
- Public Member Functions inherited from ConstChannel
 ConstChannel ()
 
virtual ~ConstChannel ()
 
virtual ConstChannelclone () const =0
 Duplicate the channel. More...
 
virtual bool get (double &value) const =0
 Read channel. More...
 
 operator double () const
 Read channel. More...
 
virtual bool isSettable () const
 Check if settable. More...
 

Private Member Functions

 Channel (const Channel &)
 
const Channeloperator= (const Channel &)
 

Detailed Description

Abstract interface for read/write access to variable.

Definition at line 32 of file Channel.h.

Constructor & Destructor Documentation

◆ Channel() [1/2]

Channel::Channel ( )

Definition at line 27 of file Channel.cpp.

◆ ~Channel()

Channel::~Channel ( )
virtual

Definition at line 32 of file Channel.cpp.

◆ Channel() [2/2]

Channel::Channel ( const Channel )
private

Member Function Documentation

◆ clone()

virtual Channel * Channel::clone ( ) const
pure virtual

Duplicate the channel.

Implements ConstChannel.

Implemented in DirectChannel, IndexedChannel< T >, and IndirectChannel< T >.

◆ isSettable()

bool Channel::isSettable ( ) const
virtual

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 Channel::operator+= ( double  value)
inline

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)
inline

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=() [1/2]

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

◆ operator=() [2/2]

double Channel::operator= ( double  value)
inline

Assign [b]value[/b] to channel.

Definition at line 43 of file Channel.h.

References set().

Here is the call graph for this function:

◆ set()

virtual bool Channel::set ( double  value)
pure virtual

Store [b]value[/b] into channel.

Implemented in DirectChannel, IndexedChannel< T >, and IndirectChannel< T >.

Referenced by operator+=(), operator-=(), and operator=().


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