#include <LinearFunction.hpp>

Inheritance diagram for openstudio::analysis::LinearFunction:

Public Member Functions
Constructors
	LinearFunction (const std::string &name, const std::vector< Variable > &variables, const std::vector< double > &coefficients=std::vector< double >())
	Construct linear function of variables. More...

	LinearFunction (const UUID &uuid, const UUID &versionUUID, const std::string &name, const std::string &displayName, const std::string &description, const std::vector< Variable > &variables, const std::vector< double > &coefficients)

virtual	~LinearFunction ()

Getters
std::vector< double >	coefficients () const

Setters
bool	setCoefficients (const std::vector< double > &coefficients)

Public Member Functions inherited from openstudio::analysis::Function
virtual	~Function ()

std::vector< Variable >	variables () const

double	getValue (const DataPoint &dataPoint) const

Public Member Functions inherited from openstudio::analysis::AnalysisObject
virtual	~AnalysisObject ()

AnalysisObject	clone () const
	Deep copy. More...

std::string	name () const

std::string	displayName () const

std::string	description () const

openstudio::UUID	uuid () const

openstudio::UUID	versionUUID () const

bool	isDirty () const
	Returns true if this object has been changed since its dirty flag was last cleared. More...

bool	operator== (const AnalysisObject &other) const
	Compare impls. More...

bool	operator!= (const AnalysisObject &other) const

bool	uuidEqual (const AnalysisObject &other) const

bool	uuidAndVersionEqual (const AnalysisObject &other) const

boost::optional< AnalysisObject >	parent () const

void	setName (const std::string &newName)

void	setDisplayName (const std::string &newDisplayName)

void	setDescription (const std::string &newDescription)

bool	clearDirtyFlag ()
	Call this method to reset the dirty flag of this object and all its children. More...

bool	connect (const char signal, const QObject receiver, const char *slot, Qt::ConnectionType type=Qt::AutoConnection) const
	Connect signal from this AnalysisObject to slot on receiver. More...

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *slot=nullptr) const

template<typename T >
T	cast () const
	Cast to type T. More...

template<typename T >
boost::optional< T >	optionalCast () const
	Cast to boost::optional<T>. More...

Related Functions
(Note that these are not member functions.)
typedef std::vector < LinearFunction >	LinearFunctionVector

typedef boost::optional < LinearFunction >	OptionalLinearFunction

Related Functions inherited from openstudio::analysis::Function
typedef std::vector< Function >	FunctionVector

typedef boost::optional< Function >	OptionalFunction

Related Functions inherited from openstudio::analysis::AnalysisObject
typedef std::vector < AnalysisObject >	AnalysisObjectVector

typedef boost::optional < AnalysisObject >	OptionalAnalysisObject

Detailed Description

LinearFunction is a Function of the form a1*x1 + a2*x2 + ...

an*xn where xi is the value of a Variable at a DataPoint, and ai is a coefficient value.

Constructor & Destructor Documentation

openstudio::analysis::LinearFunction::LinearFunction	(	const std::string &	name,
		const std::vector< Variable > &	variables,
		const std::vector< double > &	coefficients = `std::vector< double >()`
	)

Construct linear function of variables.

Throws openstudio::Exception if !coefficients.empty() and variables.size() != coefficients.size().

openstudio::analysis::LinearFunction::LinearFunction	(	const UUID &	uuid,
		const UUID &	versionUUID,
		const std::string &	name,
		const std::string &	displayName,
		const std::string &	description,
		const std::vector< Variable > &	variables,
		const std::vector< double > &	coefficients
	)

virtual openstudio::analysis::LinearFunction::~LinearFunction ( )

inlinevirtual

Member Function Documentation

std::vector<double> openstudio::analysis::LinearFunction::coefficients ( ) const

bool openstudio::analysis::LinearFunction::setCoefficients ( const std::vector< double > & coefficients )

Friends And Related Function Documentation

typedef std::vector<LinearFunction> LinearFunctionVector

Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation