openstudio::contam::WindPressureProfile Class Reference

#include <PrjObjects.hpp>

Public Member Functions
Constructors and Destructors
	WindPressureProfile ()
	Create a new object with default values.
	WindPressureProfile (int nr, int type, std::string name, std::string desc, std::vector< PressureCoefficientPoint > coeffs)
	Create a new object.
	WindPressureProfile (const WindPressureProfile &other)
	Create a new object from another object.
	~WindPressureProfile ()=default
	Destroy the object.
Operators
WindPressureProfile &	operator= (const WindPressureProfile &other)
	Copy operator.
bool	operator== (const WindPressureProfile &other) const
	Equality operator.
bool	operator!= (const WindPressureProfile &other) const
	Inequality operator.
Input and Output
void	read (Reader &input)
	Read an object from a Reader.
std::string	write ()
	Write the object to a string.
Getters and Setters
int	nr () const
	Returns the profile number, in order from 1 to the number of profiles.
void	setNr (const int nr)
	Sets the profile number.
int	type () const
	Returns the profile type: 1 = linear, 2 = cubic spline, 3 = trigonometric.
void	setType (const int type)
	Sets the profile type: 1 = linear, 2 = cubic spline, 3 = trigonometric.
std::string	name () const
	Returns the profile name.
void	setName (const std::string &name)
	Sets the profile name.
std::string	desc () const
	Returns the profile description.
void	setDesc (const std::string &desc)
	Sets the profile description.
std::vector< PressureCoefficientPoint >	coeffs () const
	Returns the wind pressure coefficient data points as a vector.
void	setCoeffs (const std::vector< PressureCoefficientPoint > &coeffs)
	Sets the wind pressure coefficient data point vector.

Detailed Description

WindPressureProfile objects store pressure coefficient as a function of angle from north.

Constructor & Destructor Documentation

WindPressureProfile() [1/3]

openstudio::contam::WindPressureProfile::WindPressureProfile

(

)

Create a new object with default values.

WindPressureProfile() [2/3]

openstudio::contam::WindPressureProfile::WindPressureProfile	(	int	nr,
		int	type,
		std::string	name,
		std::string	desc,
		std::vector< PressureCoefficientPoint >	coeffs )

Create a new object.

WindPressureProfile() [3/3]

openstudio::contam::WindPressureProfile::WindPressureProfile

(

const WindPressureProfile &

other

)

Create a new object from another object.

~WindPressureProfile()

openstudio::contam::WindPressureProfile::~WindPressureProfile ( )

default

Destroy the object.

Member Function Documentation

coeffs()

std::vector< PressureCoefficientPoint > openstudio::contam::WindPressureProfile::coeffs

(

)

const

Returns the wind pressure coefficient data points as a vector.

desc()

std::string openstudio::contam::WindPressureProfile::desc

(

)

const

Returns the profile description.

name()

std::string openstudio::contam::WindPressureProfile::name

(

)

const

Returns the profile name.

nr()

int openstudio::contam::WindPressureProfile::nr

(

)

const

Returns the profile number, in order from 1 to the number of profiles.

operator!=()

bool openstudio::contam::WindPressureProfile::operator!=

(

const WindPressureProfile &

other

)

const

Inequality operator.

operator=()

WindPressureProfile & openstudio::contam::WindPressureProfile::operator=

(

const WindPressureProfile &

other

)

Copy operator.

operator==()

bool openstudio::contam::WindPressureProfile::operator==

(

const WindPressureProfile &

other

)

const

Equality operator.

read()

void openstudio::contam::WindPressureProfile::read

(

Reader &

input

)

Read an object from a Reader.

setCoeffs()

void openstudio::contam::WindPressureProfile::setCoeffs

(

const std::vector< PressureCoefficientPoint > &

coeffs

)

Sets the wind pressure coefficient data point vector.

setDesc()

void openstudio::contam::WindPressureProfile::setDesc

(

const std::string &

desc

)

Sets the profile description.

setName()

void openstudio::contam::WindPressureProfile::setName

(

const std::string &

name

)

Sets the profile name.

setNr()

void openstudio::contam::WindPressureProfile::setNr

(

const int

nr

)

Sets the profile number.

This should only be done with care.

setType()

void openstudio::contam::WindPressureProfile::setType

(

const int

type

)

Sets the profile type: 1 = linear, 2 = cubic spline, 3 = trigonometric.

type()

int openstudio::contam::WindPressureProfile::type

(

)

const

Returns the profile type: 1 = linear, 2 = cubic spline, 3 = trigonometric.

write()

std::string openstudio::contam::WindPressureProfile::write

(

)

Write the object to a string.