openstudio::contam::ControlNode Class Reference

#include <PrjObjects.hpp>

Inheritance diagram for openstudio::contam::ControlNode:

Public Types
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...

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

Static Public Member Functions
static Type	convertTag (std::string &string)
	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 ControlNode object is the base class of all control node elements.

Member Enumeration Documentation

enum openstudio::contam::ControlNode::Type

The Type enumeration is used to identify the various control node types.

Enumerator
CT_SNS
CT_SCH
CT_SET
CT_CVF
CT_DVF
CT_LOG
CT_PAS
CT_MOD
CT_HYS
CT_ABS
CT_BIN
CT_DLS
CT_DLX
CT_INT
CT_RAV
CT_INV
CT_AND
CT_OR
CT_XOR
CT_ADD
CT_SUB
CT_MUL
CT_DIV
CT_SUM
CT_AVG
CT_MAX
CT_MIN
CT_LLS
CT_ULS
CT_LBS
CT_UBS
CT_LLC
CT_ULC
CT_PC1
CT_PI1
CT_SUP
CT_SPH
UNKNOWN

Constructor & Destructor Documentation

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

inlinevirtual

Destroy the object.

Member Function Documentation

static Type openstudio::contam::ControlNode::convertTag ( std::string &  string )

static

Convert an input string into a control node type enum.

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

pure virtual

Returns the node data type.

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

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

pure virtual

Returns the element description.

Implemented in openstudio::contam::CdvDat.

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.

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

pure virtual

Returns the number of required inputs.

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Returns the SketchPad number of input node #1.

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Returns the SketchPad number of input node #2.

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Returns the element name.

Implemented in openstudio::contam::CdvDat.

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.

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

static

Read a control node element from a Reader object.

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

pure virtual

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

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Sets the element description.

Implemented in openstudio::contam::CdvDat.

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.

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

pure virtual

Sets the number of required inputs.

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Sets the SketchPad number of input node #1.

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Sets the SketchPad number of input node #2.

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Sets the element name.

Implemented in openstudio::contam::CdvDat.

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.

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

pure virtual

Sets the computation sequence number.

Implemented in openstudio::contam::CdvDat.

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

pure virtual

Write the object to a string.

Implemented in openstudio::contam::CdvDat.