openstudio::contam::ControlNode Class Reference

#include <PrjObjects.hpp>

Inheritance diagram for openstudio::contam::ControlNode:

Public Member Functions
virtual std::string	dataType () const =0
	Returns the node data type.
virtual std::string	desc () const =0
	Returns the element description.
virtual unsigned int	flags () const =0
	Returns the flags for offset & scale, time constant, and 1D sensor.
virtual int	inreq () const =0
	Returns the number of required inputs.
virtual int	n1 () const =0
	Returns the SketchPad number of input node #1.
virtual int	n2 () const =0
	Returns the SketchPad number of input node #2.
virtual std::string	name () const =0
	Returns the element name.
virtual int	nr () const =0
	Returns the node number, in order from 1 to the number of control nodes.
virtual int	seqnr () const =0
	Returns the computation sequence number, which is set in ContamW.
virtual void	setDesc (const std::string &desc)=0
	Sets the element description.
virtual void	setFlags (const unsigned int flags)=0
	Sets the flags for offset & scale, time constant, and 1D sensor.
virtual void	setInreq (const int inreq)=0
	Sets the number of required inputs.
virtual void	setN1 (const int n1)=0
	Sets the SketchPad number of input node #1.
virtual void	setN2 (const int n2)=0
	Sets the SketchPad number of input node #2.
virtual void	setName (const std::string &name)=0
	Sets the element name.
virtual void	setNr (const int nr)=0
	Sets the node number, in order from 1 to the number of control nodes.
virtual void	setSeqnr (const int seqnr)=0
	Sets the computation sequence number.
virtual std::string	write ()=0
	Write the object to a string.
virtual	~ControlNode ()=default
	Destroy the object.

Static Public Member Functions
static ControlNodeType	convertTag (const std::string &tag)
	Convert an input string into a control node type enum.
static ControlNode *	readElement (Reader &input)
	Read a control node element from a Reader object.

Detailed Description

The ControlNode object is the base class of all control node elements.

Constructor & Destructor Documentation

~ControlNode()

virtual openstudio::contam::ControlNode::~ControlNode ( )

virtualdefault

Destroy the object.

Member Function Documentation

convertTag()

static ControlNodeType openstudio::contam::ControlNode::convertTag ( const std::string & tag )

static

Convert an input string into a control node type enum.

dataType()

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

pure virtual

Returns the node data type.

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

desc()

virtual std::string openstudio::contam::ControlNode::desc ( ) const

pure virtual

Returns the element description.

Implemented in openstudio::contam::CdvDat.

flags()

virtual unsigned int openstudio::contam::ControlNode::flags ( ) const

pure virtual

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

Implemented in openstudio::contam::CdvDat.

inreq()

virtual int openstudio::contam::ControlNode::inreq ( ) const

pure virtual

Returns the number of required inputs.

Implemented in openstudio::contam::CdvDat.

n1()

virtual int openstudio::contam::ControlNode::n1 ( ) const

pure virtual

Returns the SketchPad number of input node #1.

Implemented in openstudio::contam::CdvDat.

n2()

virtual int openstudio::contam::ControlNode::n2 ( ) const

pure virtual

Returns the SketchPad number of input node #2.

Implemented in openstudio::contam::CdvDat.

name()

virtual std::string openstudio::contam::ControlNode::name ( ) const

pure virtual

Returns the element name.

Implemented in openstudio::contam::CdvDat.

nr()

virtual int openstudio::contam::ControlNode::nr ( ) const

pure virtual

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

Implemented in openstudio::contam::CdvDat.

readElement()

static ControlNode * openstudio::contam::ControlNode::readElement ( Reader & input )

static

Read a control node element from a Reader object.

seqnr()

virtual int openstudio::contam::ControlNode::seqnr ( ) const

pure virtual

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

Implemented in openstudio::contam::CdvDat.

setDesc()

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

pure virtual

Sets the element description.

Implemented in openstudio::contam::CdvDat.

setFlags()

virtual void openstudio::contam::ControlNode::setFlags ( const unsigned int flags )

pure virtual

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

Implemented in openstudio::contam::CdvDat.

setInreq()

virtual void openstudio::contam::ControlNode::setInreq ( const int inreq )

pure virtual

Sets the number of required inputs.

Implemented in openstudio::contam::CdvDat.

setN1()

virtual void openstudio::contam::ControlNode::setN1 ( const int n1 )

pure virtual

Sets the SketchPad number of input node #1.

Implemented in openstudio::contam::CdvDat.

setN2()

virtual void openstudio::contam::ControlNode::setN2 ( const int n2 )

pure virtual

Sets the SketchPad number of input node #2.

Implemented in openstudio::contam::CdvDat.

setName()

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

pure virtual

Sets the element name.

Implemented in openstudio::contam::CdvDat.

setNr()

virtual void openstudio::contam::ControlNode::setNr ( const int nr )

pure virtual

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

Implemented in openstudio::contam::CdvDat.

setSeqnr()

virtual void openstudio::contam::ControlNode::setSeqnr ( const int seqnr )

pure virtual

Sets the computation sequence number.

Implemented in openstudio::contam::CdvDat.

write()

virtual std::string openstudio::contam::ControlNode::write ( )

pure virtual

Write the object to a string.

Implemented in openstudio::contam::CdvDat.