YAP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ComplexComponentParameter Class Referenceabstract

Abstract base allowing access to the components of a ComplexParameter as a RealParameter. More...

#include <Parameter.h>

Inheritance diagram for ComplexComponentParameter:
RealParameter Parameter< double > ParameterBase ImaginaryComponentParameter RealComponentParameter

Public Member Functions

 ComplexComponentParameter (std::shared_ptr< ComplexParameter > par)
 
const double value () const override
 
void setValue (double val) override
 set value by accessing parent
 
std::shared_ptr< ComplexParameter > parent ()
 
- Public Member Functions inherited from RealParameter
 RealParameter (double t=0)
 constructor
 
const size_t size () const
 
void setValue (const std::vector< double > &V)
 Set value from vector.
 
- Public Member Functions inherited from Parameter< double >
 Parameter ()=default
 Default constructor.
 
 Parameter (doublet)
 Value-assigning constructor.
 
 Parameter (const Parameter &)=default
 copy constructor defaulted
 
 Parameter (Parameter &&)=default
 move constructor defaulted
 
 ~Parameter ()=default
 virtual destructor defaulted
 
Parameter & operator= (const Parameter &)=default
 copy assignment defaulted
 
Parameter & operator= (Parameter &&)=default
 move assignment defaulted
 
Parameter & operator= (typename std::conditional< std::is_fundamental< double >::value, const double, const double & >::type t)
 set value by operator
 
virtual void setValue (typename std::conditional< std::is_fundamental< double >::value, const double, const double & >::type val)
 set value
 
- Public Member Functions inherited from ParameterBase
VariableStatus & variableStatus ()
 
const VariableStatus variableStatus () const
 

Protected Member Functions

virtual double component (const std::complex< double > &c) const =0
 
virtual std::complex< double > setComponent (const std::complex< double > &c, double v) const =0
 
- Protected Member Functions inherited from ParameterBase
 ParameterBase ()
 Constructor.
 

Private Attributes

std::shared_ptr< ComplexParameter > Parent_
 ComplexParameter this object points to a component of.
 

Detailed Description

Abstract base allowing access to the components of a ComplexParameter as a RealParameter.

Author
Daniel Greenwald

Constructor & Destructor Documentation

ComplexComponentParameter ( std::shared_ptr< ComplexParameter >  par)

Constructor

Parameters
parshared_ptr to ComplexParameter to access

Member Function Documentation

virtual double component ( const std::complex< double > &  c) const
protectedpure virtual
Returns
component value from whole value

Implemented in ImaginaryComponentParameter, and RealComponentParameter.

std::shared_ptr<ComplexParameter> parent ( )
inline
Returns
shared_ptr to parent
virtual std::complex<double> setComponent ( const std::complex< double > &  c,
double  v 
) const
protectedpure virtual
Returns
complex value with component changed

Implemented in ImaginaryComponentParameter, and RealComponentParameter.

const double value ( void  ) const
inlineoverridevirtual
Returns
value of parameter by accessing parent

Reimplemented from Parameter< double >.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.6