OpenStudio:airflow
 All Classes Namespaces Functions Typedefs Enumerations Enumerator
List of all members
openstudio::contam::WindPressureProfile Class Reference

#include <PrjObjects.hpp>

Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

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

Create a new object with default values.

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

Create a new object.

openstudio::contam::WindPressureProfile::WindPressureProfile ( const WindPressureProfile other)

Create a new object from another object.

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

Destroy the object.

Member Function Documentation

std::vector<PressureCoefficientPoint> openstudio::contam::WindPressureProfile::coeffs ( ) const

Returns the wind pressure coefficient data points as a vector.

std::string openstudio::contam::WindPressureProfile::desc ( ) const

Returns the profile description.

std::string openstudio::contam::WindPressureProfile::name ( ) const

Returns the profile name.

int openstudio::contam::WindPressureProfile::nr ( ) const

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

bool openstudio::contam::WindPressureProfile::operator!= ( const WindPressureProfile other) const

Inequality operator.

WindPressureProfile& openstudio::contam::WindPressureProfile::operator= ( const WindPressureProfile other)

Copy operator.

bool openstudio::contam::WindPressureProfile::operator== ( const WindPressureProfile other) const

Equality operator.

void openstudio::contam::WindPressureProfile::read ( Reader input)

Read an object from a Reader.

void openstudio::contam::WindPressureProfile::setCoeffs ( const std::vector< PressureCoefficientPoint > &  coeffs)

Sets the wind pressure coefficient data point vector.

void openstudio::contam::WindPressureProfile::setDesc ( const std::string &  desc)

Sets the profile description.

void openstudio::contam::WindPressureProfile::setName ( const std::string &  name)

Sets the profile name.

void openstudio::contam::WindPressureProfile::setNr ( const int  nr)

Sets the profile number.

This should only be done with care.

void openstudio::contam::WindPressureProfile::setType ( const int  type)

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

int openstudio::contam::WindPressureProfile::type ( ) const

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

std::string openstudio::contam::WindPressureProfile::write ( )

Write the object to a string.