OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
AbstractVar Class Referenceabstract

Abstract base for a matching variable. More...

#include <AbstractVar.h>

Inheritance diagram for AbstractVar:
Inheritance graph
[legend]

Public Member Functions

 AbstractVar (const std::string &name)
 Constructor. More...
 
virtual ~AbstractVar ()
 
virtual const std::string & getName () const
 Get the variable name. More...
 
virtual double getInternalValue () const =0
 Get the current internal parameter value. More...
 
virtual void setInternalValue (double)=0
 Set the current internal parameter value. More...
 
virtual double getExternalValue () const =0
 Get the current external parameter value. More...
 
virtual void setExternalValue (double)=0
 Set the current external parameter value. More...
 
virtual void print (std::ostream &) const =0
 Print the variable name and value. More...
 

Protected Attributes

const std::string itsName
 Name of the variable. More...
 

Private Member Functions

 AbstractVar ()
 
 AbstractVar (const AbstractVar &)
 
void operator= (const AbstractVar &)
 

Detailed Description

Abstract base for a matching variable.

Definition at line 31 of file AbstractVar.h.

Constructor & Destructor Documentation

AbstractVar::AbstractVar ( const std::string &  name)

Constructor.

Definition at line 27 of file AbstractVar.cpp.

AbstractVar::~AbstractVar ( )
virtual

Definition at line 32 of file AbstractVar.cpp.

AbstractVar::AbstractVar ( )
private
AbstractVar::AbstractVar ( const AbstractVar )
private

Member Function Documentation

virtual double AbstractVar::getExternalValue ( ) const
pure virtual

Get the current external parameter value.

Implemented in ConcreteVar.

virtual double AbstractVar::getInternalValue ( ) const
pure virtual

Get the current internal parameter value.

Implemented in ConcreteVar.

const std::string & AbstractVar::getName ( ) const
virtual

Get the variable name.

Definition at line 36 of file AbstractVar.cpp.

References itsName.

void AbstractVar::operator= ( const AbstractVar )
private
virtual void AbstractVar::print ( std::ostream &  ) const
pure virtual

Print the variable name and value.

Implemented in ConcreteVar.

virtual void AbstractVar::setExternalValue ( double  )
pure virtual

Set the current external parameter value.

Implemented in ConcreteVar.

virtual void AbstractVar::setInternalValue ( double  )
pure virtual

Set the current internal parameter value.

Implemented in ConcreteVar.

Member Data Documentation

const std::string AbstractVar::itsName
protected

Name of the variable.

Definition at line 62 of file AbstractVar.h.

Referenced by getName(), and ConcreteVar::print().


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