OpenStudioCore:airflow
 All Classes Namespaces Functions Enumerations Enumerator
List of all members
openstudio::contam::DvfDat Class Reference

#include <PrjObjects.hpp>

+ Inheritance diagram for openstudio::contam::DvfDat:

Public Member Functions

Constructors and Destructors
 DvfDat ()
 Create a new object with default values. More...
 
 DvfDat (int nr, int seqnr, unsigned int flags, int inreq, int n1, int n2, std::string name, std::string desc)
 Create a new object. More...
 
 DvfDat (int nr, int seqnr, unsigned int flags, int inreq, int n1, int n2, std::string name, std::string desc, std::string valuename)
 Create a new object. More...
 
Getters and Setters
std::string dataType () const override
 Returns the node data type. More...
 
- Public Member Functions inherited from openstudio::contam::CdvDat
 CdvDat ()
 Create a new object with default values. More...
 
 CdvDat (int nr, int seqnr, unsigned int flags, int inreq, int n1, int n2, std::string name, std::string desc)
 Create a new object. More...
 
 CdvDat (int nr, int seqnr, unsigned int flags, int inreq, int n1, int n2, std::string name, std::string desc, std::string valuename)
 Create a new object. More...
 
 CdvDat (const CdvDat &other)
 Create a new object from another object. More...
 
 ~CdvDat ()
 Destroy the object. More...
 
CdvDatoperator= (const CdvDat &other)
 Copy operator. More...
 
bool operator== (const CdvDat &other) const
 Equality operator. More...
 
bool operator!= (const CdvDat &other) const
 Inequality operator. More...
 
void read (Reader &input)
 Read an object from a Reader. More...
 
void readDetails (Reader &input)
 Read object details from a Reader. More...
 
std::string write () override
 Write the object to a string. More...
 
int nr () const override
 Returns the node number, in order from 1 to the number of control nodes. More...
 
void setNr (const int nr) override
 Sets the element number. More...
 
int seqnr () const override
 Returns the computation sequence number, which is set in ContamW. More...
 
void setSeqnr (const int seqnr) override
 Sets the computation sequence number. More...
 
unsigned int flags () const override
 Returns the flags for offset & scale, time constant, and 1D sensor. More...
 
void setFlags (const unsigned int flags) override
 Sets the flags for offset & scale, time constant, and 1D sensor. More...
 
int inreq () const override
 Returns the number of required inputs. More...
 
void setInreq (const int inreq) override
 Sets the number of required inputs. More...
 
int n1 () const override
 Returns the SketchPad number of input node #1. More...
 
void setN1 (const int n1) override
 Sets the SketchPad number of input node #1. More...
 
int n2 () const override
 Returns the SketchPad number of input node #2. More...
 
void setN2 (const int n2) override
 Sets the SketchPad number of input node #2. More...
 
std::string name () const override
 Returns the element name. More...
 
void setName (const std::string &name) override
 Sets the element name. More...
 
std::string desc () const override
 Returns the element description. More...
 
void setDesc (const std::string &desc) override
 Sets the element description. More...
 
std::string valuename () const
 Returns the name of the value read from the file. More...
 
void setValuename (const std::string &valuename)
 Sets the name of the value read from the file. More...
 
- Public Member Functions inherited from openstudio::contam::ControlNode
virtual ~ControlNode ()
 Destroy the object. More...
 

Additional Inherited Members

- Public Types inherited from openstudio::contam::ControlNode
enum  Type {
  CT_SNS =0, CT_SCH =1, CT_SET =2, CT_CVF =3,
  CT_DVF =4, CT_LOG =5, CT_PAS =6, CT_MOD =7,
  CT_HYS =8, CT_ABS =9, CT_BIN =10, CT_DLS =11,
  CT_DLX =12, CT_INT =13, CT_RAV =14, CT_INV =15,
  CT_AND =16, CT_OR =17, CT_XOR =18, CT_ADD =19,
  CT_SUB =20, CT_MUL =21, CT_DIV =22, CT_SUM =23,
  CT_AVG =24, CT_MAX =25, CT_MIN =26, CT_LLS =27,
  CT_ULS =28, CT_LBS =29, CT_UBS =30, CT_LLC =31,
  CT_ULC =32, CT_PC1 =33, CT_PI1 =34, CT_SUP =35,
  CT_SPH =37, UNKNOWN
}
 The Type enumeration is used to identify the various control node types. More...
 
- Static Public Member Functions inherited from openstudio::contam::ControlNode
static Type convertTag (std::string &string)
 Convert an input string into a control node type enum. More...
 
static ControlNodereadElement (Reader &input)
 Read a control node element from a Reader object. More...
 

Detailed Description

The DvfDat object represents a discrete values data file control node.

Constructor & Destructor Documentation

openstudio::contam::DvfDat::DvfDat ( )

Create a new object with default values.

openstudio::contam::DvfDat::DvfDat ( int  nr,
int  seqnr,
unsigned int  flags,
int  inreq,
int  n1,
int  n2,
std::string  name,
std::string  desc 
)

Create a new object.

openstudio::contam::DvfDat::DvfDat ( int  nr,
int  seqnr,
unsigned int  flags,
int  inreq,
int  n1,
int  n2,
std::string  name,
std::string  desc,
std::string  valuename 
)

Create a new object.

Member Function Documentation

std::string openstudio::contam::DvfDat::dataType ( ) const
inlineoverridevirtual

Returns the node data type.

Implements openstudio::contam::CdvDat.