#include <PrjObjects.hpp>

Inheritance diagram for openstudio::contam::CdvDat:

Public Member Functions
Constructors and Destructors
	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...

virtual	~CdvDat () override=default
	Destroy the object. More...

Operators
CdvDat &	operator= (const CdvDat &other)
	Copy operator. More...

bool	operator== (const CdvDat &other) const
	Equality operator. More...

bool	operator!= (const CdvDat &other) const
	Inequality operator. More...

Input and Output
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...

Getters and Setters
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...

virtual std::string	dataType () const override=0
	Returns the node data type. 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 ()=default
	Destroy the object. More...

Additional Inherited Members
Static Public Member Functions inherited from openstudio::contam::ControlNode
static ControlNodeType	convertTag (const std::string &tag)
	Convert an input string into a control node type enum. More...

static ControlNode *	readElement (Reader &input)
	Read a control node element from a Reader object. More...

Detailed Description

The CdvDat object is the base class of the file control nodes.

Constructor & Destructor Documentation

openstudio::contam::CdvDat::CdvDat ( )

Create a new object with default values.

openstudio::contam::CdvDat::CdvDat	(	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::CdvDat::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.

openstudio::contam::CdvDat::CdvDat ( const CdvDat & other )

Create a new object from another object.

virtual openstudio::contam::CdvDat::~CdvDat ( )

overridevirtualdefault

Destroy the object.

Member Function Documentation

virtual std::string openstudio::contam::CdvDat::dataType ( ) const

overridepure virtual

Returns the node data type.

Implements openstudio::contam::ControlNode.

Implemented in openstudio::contam::DvfDat, and openstudio::contam::CvfDat.

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

overridevirtual

Returns the element description.

Implements openstudio::contam::ControlNode.

unsigned int openstudio::contam::CdvDat::flags ( ) const

overridevirtual

Returns the flags for offset & scale, time constant, and 1D sensor.

Implements openstudio::contam::ControlNode.

int openstudio::contam::CdvDat::inreq ( ) const

overridevirtual

Returns the number of required inputs.

Implements openstudio::contam::ControlNode.

int openstudio::contam::CdvDat::n1 ( ) const

overridevirtual

Returns the SketchPad number of input node #1.

Implements openstudio::contam::ControlNode.

int openstudio::contam::CdvDat::n2 ( ) const

overridevirtual

Returns the SketchPad number of input node #2.

Implements openstudio::contam::ControlNode.

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

overridevirtual

Returns the element name.

Implements openstudio::contam::ControlNode.

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

overridevirtual

Returns the node number, in order from 1 to the number of control nodes.

Implements openstudio::contam::ControlNode.

bool openstudio::contam::CdvDat::operator!= ( const CdvDat & other ) const

Inequality operator.

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

Copy operator.

bool openstudio::contam::CdvDat::operator== ( const CdvDat & other ) const

Equality operator.

void openstudio::contam::CdvDat::read ( Reader & input )

Read an object from a Reader.

void openstudio::contam::CdvDat::readDetails ( Reader & input )

Read object details from a Reader.

int openstudio::contam::CdvDat::seqnr ( ) const

overridevirtual

Returns the computation sequence number, which is set in ContamW.

Implements openstudio::contam::ControlNode.

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

overridevirtual

Sets the element description.

Implements openstudio::contam::ControlNode.

void openstudio::contam::CdvDat::setFlags ( const unsigned int flags )

overridevirtual

Sets the flags for offset & scale, time constant, and 1D sensor.

Implements openstudio::contam::ControlNode.

void openstudio::contam::CdvDat::setInreq ( const int inreq )

overridevirtual

Sets the number of required inputs.

Implements openstudio::contam::ControlNode.

void openstudio::contam::CdvDat::setN1 ( const int n1 )

overridevirtual

Sets the SketchPad number of input node #1.

Implements openstudio::contam::ControlNode.

void openstudio::contam::CdvDat::setN2 ( const int n2 )

overridevirtual

Sets the SketchPad number of input node #2.

Implements openstudio::contam::ControlNode.

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

overridevirtual

Sets the element name.

Implements openstudio::contam::ControlNode.

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

overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::ControlNode.

void openstudio::contam::CdvDat::setSeqnr ( const int seqnr )

overridevirtual

Sets the computation sequence number.

Implements openstudio::contam::ControlNode.

void openstudio::contam::CdvDat::setValuename ( const std::string & valuename )

Sets the name of the value read from the file.

std::string openstudio::contam::CdvDat::valuename ( ) const

Returns the name of the value read from the file.

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

overridevirtual

Write the object to a string.

Implements openstudio::contam::ControlNode.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation