Jpp 20.0.0-rc.9-22-g74b57fa79
the software that should make you happy
Loading...
Searching...
No Matches
JASTRONOMY::JNuisance Struct Referenceabstract

Interface for nuisance parameter. More...

#include <JNuisance.hh>

Inheritance diagram for JASTRONOMY::JNuisance:
JLANG::JClonable< JClonable_t, JDerived_t > JLANG::JTitle

Public Types

typedef JClonable< JClonable_t >::clone_type clone_type
 

Public Member Functions

virtual ~JNuisance ()
 Virtual destructor.
 
virtual std::istream & read (std::istream &in)=0
 Read nuisance from input stream.
 
virtual std::ostream & write (std::ostream &out) const =0
 Write nuisance to output stream.
 
virtual double get () const =0
 Get value.
 
virtual clone_type clone () const override
 Get clone of this object.
 
const std::string & getTitle () const
 Get title.
 
void setTitle (const std::string &title)
 Set title.
 

Static Public Attributes

static constexpr double FACTOR = 1.0
 Central value.
 

Protected Attributes

std::string title
 

Friends

std::istream & operator>> (std::istream &in, JNuisance &nuisance)
 Read nuisance from input stream.
 
std::ostream & operator<< (std::ostream &out, const JNuisance &nuisance)
 Write nuisance to output stream.
 

Detailed Description

Interface for nuisance parameter.

Definition at line 44 of file JNuisance.hh.

Member Typedef Documentation

◆ clone_type

template<class JClonable_t , class JDerived_t >
JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type
inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

◆ ~JNuisance()

virtual JASTRONOMY::JNuisance::~JNuisance ( )
inlinevirtual

Virtual destructor.

Definition at line 56 of file JNuisance.hh.

57 {}

Member Function Documentation

◆ read()

virtual std::istream & JASTRONOMY::JNuisance::read ( std::istream & in)
pure virtual

Read nuisance from input stream.

Parameters
ininput stream
Returns
input stream

◆ write()

virtual std::ostream & JASTRONOMY::JNuisance::write ( std::ostream & out) const
pure virtual

Write nuisance to output stream.

Parameters
outoutput stream
Returns
output stream

◆ get()

virtual double JASTRONOMY::JNuisance::get ( ) const
pure virtual

Get value.

Returns
value

◆ clone()

template<class JClonable_t , class JDerived_t >
virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const
inlineoverridevirtualinherited

◆ getTitle()

const std::string & JLANG::JTitle::getTitle ( ) const
inlineinherited

Get title.

Returns
title

Definition at line 55 of file JTitle.hh.

56 {
57 return this->title;
58 }
std::string title
Definition JTitle.hh:73

◆ setTitle()

void JLANG::JTitle::setTitle ( const std::string & title)
inlineinherited

Set title.

Parameters
titletitle

Definition at line 66 of file JTitle.hh.

67 {
68 this->title = title;
69 }

Friends And Related Symbol Documentation

◆ operator>>

std::istream & operator>> ( std::istream & in,
JNuisance & nuisance )
friend

Read nuisance from input stream.

Parameters
ininput stream
nuisancenuisance
Returns
input stream

Definition at line 93 of file JNuisance.hh.

94 {
95 return nuisance.read(in);
96 }

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const JNuisance & nuisance )
friend

Write nuisance to output stream.

Parameters
outoutput stream
nuisancenuisance
Returns
output stream

Definition at line 106 of file JNuisance.hh.

107 {
108 return nuisance.write(out);
109 }

Member Data Documentation

◆ FACTOR

double JASTRONOMY::JNuisance::FACTOR = 1.0
staticconstexpr

Central value.

Definition at line 51 of file JNuisance.hh.

◆ title

std::string JLANG::JTitle::title
protectedinherited

Definition at line 73 of file JTitle.hh.


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