CurveSigmoid Class Reference

#include "CurveSigmoid.hpp"

Inheritance diagram for openstudio::model::CurveSigmoid:

Public Member Functions
	CurveSigmoid (const Model &model)
virtual	~CurveSigmoid ()
double	coefficient1C1 () const
double	coefficient2C2 () const
double	coefficient3C3 () const
double	coefficient4C4 () const
double	coefficient5C5 () const
double	minimumValueofx () const
double	maximumValueofx () const
boost::optional< double >	minimumCurveOutput () const
boost::optional< double >	maximumCurveOutput () const
std::string	inputUnitTypeforx () const
bool	isInputUnitTypeforxDefaulted () const
std::string	outputUnitType () const
bool	isOutputUnitTypeDefaulted () const
bool	setCoefficient1C1 (double coefficient1C1)
bool	setCoefficient2C2 (double coefficient2C2)
bool	setCoefficient3C3 (double coefficient3C3)
bool	setCoefficient4C4 (double coefficient4C4)
bool	setCoefficient5C5 (double coefficient5C5)
bool	setMinimumValueofx (double minimumValueofx)
bool	setMaximumValueofx (double maximumValueofx)
bool	setMinimumCurveOutput (double minimumCurveOutput)
void	resetMinimumCurveOutput ()
bool	setMaximumCurveOutput (double maximumCurveOutput)
void	resetMaximumCurveOutput ()
bool	setInputUnitTypeforx (std::string inputUnitTypeforx)
void	resetInputUnitTypeforx ()
bool	setOutputUnitType (std::string outputUnitType)
void	resetOutputUnitType ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validInputUnitTypeforxValues ()
static std::vector< std::string >	validOutputUnitTypeValues ()

Related Functions
typedef std::vector< CurveSigmoid >	CurveSigmoidVector
typedef boost::optional < CurveSigmoid >	OptionalCurveSigmoid

Detailed Description

CurveSigmoid is a Curve that wraps the OpenStudio IDD object 'OS:Curve:Sigmoid'.

The functional form is $\displaystyle f(x) = c_1 + \frac{c_2}{\left(1 + e^\left[\frac{c_3 - x}{c_4}\right]\right)^{c_5}}$

Constructor & Destructor Documentation

openstudio::model::CurveSigmoid::CurveSigmoid ( const Model &  model )

explicit

Initializes $c_1 = 0.0,\ c_2 = c_3 = c_4 = c_5 = 1.0,\ xmin = 0.0,\ xmax = 1.0$.

virtual openstudio::model::CurveSigmoid::~CurveSigmoid ( )

inlinevirtual

Member Function Documentation

double openstudio::model::CurveSigmoid::coefficient1C1

(

)

const

double openstudio::model::CurveSigmoid::coefficient2C2

(

)

const

double openstudio::model::CurveSigmoid::coefficient3C3

(

)

const

double openstudio::model::CurveSigmoid::coefficient4C4

(

)

const

double openstudio::model::CurveSigmoid::coefficient5C5

(

)

const

static IddObjectType openstudio::model::CurveSigmoid::iddObjectType ( )

static

std::string openstudio::model::CurveSigmoid::inputUnitTypeforx

(

)

const

bool openstudio::model::CurveSigmoid::isInputUnitTypeforxDefaulted

(

)

const

bool openstudio::model::CurveSigmoid::isOutputUnitTypeDefaulted

(

)

const

boost::optional<double> openstudio::model::CurveSigmoid::maximumCurveOutput

(

)

const

double openstudio::model::CurveSigmoid::maximumValueofx

(

)

const

boost::optional<double> openstudio::model::CurveSigmoid::minimumCurveOutput

(

)

const

double openstudio::model::CurveSigmoid::minimumValueofx

(

)

const

std::string openstudio::model::CurveSigmoid::outputUnitType

(

)

const

void openstudio::model::CurveSigmoid::resetInputUnitTypeforx

(

)

void openstudio::model::CurveSigmoid::resetMaximumCurveOutput

(

)

void openstudio::model::CurveSigmoid::resetMinimumCurveOutput

(

)

void openstudio::model::CurveSigmoid::resetOutputUnitType

(

)

bool openstudio::model::CurveSigmoid::setCoefficient1C1

(

double

coefficient1C1

)

bool openstudio::model::CurveSigmoid::setCoefficient2C2

(

double

coefficient2C2

)

bool openstudio::model::CurveSigmoid::setCoefficient3C3

(

double

coefficient3C3

)

bool openstudio::model::CurveSigmoid::setCoefficient4C4

(

double

coefficient4C4

)

bool openstudio::model::CurveSigmoid::setCoefficient5C5

(

double

coefficient5C5

)

bool openstudio::model::CurveSigmoid::setInputUnitTypeforx

(

std::string

inputUnitTypeforx

)

bool openstudio::model::CurveSigmoid::setMaximumCurveOutput

(

double

maximumCurveOutput

)

bool openstudio::model::CurveSigmoid::setMaximumValueofx

(

double

maximumValueofx

)

bool openstudio::model::CurveSigmoid::setMinimumCurveOutput

(

double

minimumCurveOutput

)

bool openstudio::model::CurveSigmoid::setMinimumValueofx

(

double

minimumValueofx

)

bool openstudio::model::CurveSigmoid::setOutputUnitType

(

std::string

outputUnitType

)

static std::vector<std::string> openstudio::model::CurveSigmoid::validInputUnitTypeforxValues ( )

static

static std::vector<std::string> openstudio::model::CurveSigmoid::validOutputUnitTypeValues ( )

static

Friends And Related Function Documentation

typedef std::vector<CurveSigmoid> CurveSigmoidVector

related

typedef boost::optional<CurveSigmoid> OptionalCurveSigmoid

related