PIDController Class

Inheritance Hierarchy

SystemObject
  DWSIM.SharedClasses.UnitOperationsBaseClass
    DWSIM.UnitOperations.UnitOperationsSpecialOpBaseClass
      DWSIM.UnitOperations.SpecialOpsPIDController

Namespace: DWSIM.UnitOperations.SpecialOps
Assembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 8.8.1.0

Syntax

Copy

[SerializableAttribute]
public class PIDController : SpecialOpBaseClass, 
	IAdjust, IControllableObject

<SerializableAttribute>
Public Class PIDController
	Inherits SpecialOpBaseClass
	Implements IAdjust, IControllableObject

Request Example View Source

The PIDController type exposes the following members.

Constructors

	Name	Description
	PIDController
	PIDController(String, String)

Top

Properties

	Name	Description
	Active
	AdjustValue
	AdjustVarType	If an Adjust object is attached to this object, returns a variable describing how this object is used by it (manipulated, controlled or reference). (Inherited from BaseClass)
	Annotation	(Inherited from BaseClass)
	AttachedAdjustId	If an Adjust object is attached to this object, returns its ID. (Inherited from BaseClass)
	AttachedSpecId	If an Specification object is attached to this object, returns its ID. (Inherited from BaseClass)
	AttachedUtilities	(Inherited from BaseClass)
	Calculated	(Inherited from BaseClass)
	CanUsePreviousResults	(Inherited from BaseClass)
	ComponentDescription	(Inherited from BaseClass)
	ComponentName	(Inherited from BaseClass)
	ControlledObject
	ControlledObjectData
	ControlledVariable
	ControlPanel
	CreateChartAction	(Inherited from BaseClass)
	CumulativeError
	CurrentError
	CvOk
	DebugMode	(Inherited from BaseClass)
	DebugText	(Inherited from BaseClass)
	DetailedDebugReport	(Inherited from BaseClass)
	DTerm
	DynamicsOnly	(Inherited from BaseClass)
	DynamicsSpec	(Inherited from BaseClass)
	EnergyFlow	Energy Flow property. Only implemented for Energy Streams. (Inherited from BaseClass)
	ErrorMessage	Gets or sets the error message regarding the last calculation attempt. (Inherited from BaseClass)
	ExtraProperties	(Inherited from BaseClass)
	ExtraPropertiesDescriptions	(Inherited from BaseClass)
	ExtraPropertiesTypes	(Inherited from BaseClass)
	ExtraPropertiesUnitTypes	(Inherited from BaseClass)
	FlowSheet	Gets the current flowsheet where this object is located. (Inherited from BaseClass)
	GHGEmissionData	(Inherited from BaseClass)
	GraphicObject	Gets or sets the graphic object representation of this object in the flowsheet. (Inherited from BaseClass)
	HasPropertiesForDynamicMode	(Inherited from BaseClass)
	InitialEstimate
	IsAdjustAttached	Checks if an Adjust operation is attached to this object. (Inherited from BaseClass)
	IsDirty	(Inherited from BaseClass)
	IsFunctional	(Inherited from BaseClass)
	IsSink	(Inherited from BaseClass)
	IsSource	(Inherited from BaseClass)
	IsSpecAttached	Checks if an Specification operation is attached to this object. (Inherited from BaseClass)
	ITerm
	Kd
	Ki
	Kp
	LastError
	LastSolutionInputSnapshot	(Inherited from BaseClass)
	LastUpdated	(Inherited from BaseClass)
	ManipulatedObject
	ManipulatedObjectData
	ManipulatedVariable
	ManualOverride
	MaximumIterations
	MaxVal
	MinVal
	MobileCompatible	(Overrides BaseClassMobileCompatible)
	MVHistory
	MvOk
	MVValue
	Name	Object's Unique ID (Name) (Inherited from BaseClass)
	ObjectClass	(Overrides SpecialOpBaseClassObjectClass)
	Offset
	Output
	OutputAbs
	OutputMax
	OutputMin
	OverrideCalculationRoutine	(Inherited from BaseClass)
	Phases	Phase collection, only implemented for Material Streams. (Inherited from BaseClass)
	PreferredFlashAlgorithmTag	(Inherited from BaseClass)
	ProductAssembly	(Inherited from BaseClass)
	ProductAuthor	(Inherited from BaseClass)
	ProductContactInfo	(Inherited from BaseClass)
	ProductDescription	(Inherited from BaseClass)
	ProductName	(Inherited from BaseClass)
	ProductPage	(Inherited from BaseClass)
	ProductVersion	(Inherited from BaseClass)
	PropertyPackage	(Inherited from BaseClass)
	PTerm
	PVHistory
	PVValue
	Referenced
	ReferencedObjectData
	ReferenceObject
	ReferenceVariable
	ReverseActing
	RvOk
	SetPoint
	SimultaneousAdjust
	SpecVarType	If an Specification object is attached to this object, returns a variable describing how this object is used by it (target or source). (Inherited from BaseClass)
	SPHistory
	SPValue
	Status
	StepSize
	StoreDetailedDebugReport	(Inherited from BaseClass)
	SupportsDynamicMode	(Overrides BaseClassSupportsDynamicMode)
	Tolerance
	UserDefinedChartNames	(Inherited from BaseClass)
	Visible	(Inherited from BaseClass)
	WindupGuard

Top

Methods

	Name	Description
	AddDynamicProperty	(Inherited from BaseClass)
	AddExtraProperty	(Inherited from BaseClass)
	AppendDebugLine	(Inherited from BaseClass)
	Calculate	(Overrides BaseClassCalculate(Object))
	CheckDirtyStatus	(Inherited from BaseClass)
	CheckSpec	Checks if a value is valid. (Inherited from BaseClass)
	ClearExtraProperties	(Inherited from BaseClass)
	ClearPropertyPackageInstance	(Inherited from BaseClass)
	Clone	Clones the current object, returning a new one with identical properties. (Inherited from BaseClass)
	CloneJSON	(Overrides BaseClassCloneJSON)
	CloneXML	(Overrides BaseClassCloneXML)
	CloseDynamicsEditForm	(Inherited from BaseClass)
	CloseEditForm	(Overrides BaseClassCloseEditForm)
	ConnectEnergyStream	(Inherited from BaseClass)
	ConnectFeedEnergyStream	(Inherited from BaseClass)
	ConnectFeedMaterialStream	(Inherited from BaseClass)
	ConnectProductEnergyStream	(Inherited from BaseClass)
	ConnectProductMaterialStream	(Inherited from BaseClass)
	CopyDataToClipboard	Copies the object properties to the Clipboard. (Inherited from BaseClass)
	CreateDynamicProperties	(Inherited from BaseClass)
	CreateNew	(Inherited from BaseClass)
	DeCalculate	(Inherited from BaseClass)
	DisplayDynamicsEditForm	(Inherited from BaseClass)
	DisplayEditForm	(Overrides BaseClassDisplayEditForm)
	DisplayExtraPropertiesEditForm	(Inherited from BaseClass)
	Dispose	(Inherited from BaseClass)
	Dispose(Boolean)	(Inherited from BaseClass)
	EstimateParameters
	FT	Formats a property string, adding its units in parenthesis. (Inherited from BaseClass)
	GetAsObject	(Inherited from BaseClass)
	GetChartModel	(Overrides BaseClassGetChartModel(String))
	GetChartModelNames	(Overrides BaseClassGetChartModelNames)
	GetConnectionPortsInfo	(Inherited from BaseClass)
	GetConnectionPortsList	(Inherited from BaseClass)
	GetDebugReport	(Inherited from BaseClass)
	GetDebugWriter	(Inherited from BaseClass)
	GetDefaultProperties	(Inherited from BaseClass)
	GetDisplayDescription	(Overrides BaseClassGetDisplayDescription)
	GetDisplayName	(Overrides BaseClassGetDisplayName)
	GetDynamicContents	(Inherited from BaseClass)
	GetDynamicProperty	(Inherited from BaseClass)
	GetDynamicPropertyUnitType	(Inherited from BaseClass)
	GetDynamicResidenceTime	(Inherited from BaseClass)
	GetDynamicVolume	(Inherited from BaseClass)
	GetEditingForm	(Overrides BaseClassGetEditingForm)
	GetEnergyBalanceResidual	(Inherited from BaseClass)
	GetEnergyConsumption	(Inherited from BaseClass)
	GetExtraPropertyValue	(Inherited from BaseClass)
	GetFlowsheet	(Inherited from BaseClass)
	GetIconBitmap	(Overrides BaseClassGetIconBitmap)
	GetMassBalanceResidual	(Inherited from BaseClass)
	GetPowerGeneratedOrConsumed	(Inherited from BaseClass)
	GetPreferredGraphicObjectHeight	(Inherited from BaseClass)
	GetPreferredGraphicObjectWidth	(Inherited from BaseClass)
	GetProperties	(Overrides BaseClassGetProperties(PropertyType))
	GetPropertyDescription	(Inherited from BaseClass)
	GetPropertyUnit	(Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure))
	GetPropertyValue	(Overrides BaseClassGetPropertyValue(String, IUnitsOfMeasure))
	GetReport	(Inherited from BaseClass)
	GetStructuredReport	(Inherited from BaseClass)
	GetVersion	(Inherited from BaseClass)
	IsDynamicProperty	(Inherited from BaseClass)
	LoadData	(Overrides BaseClassLoadData(ListXElement))
	ObjectCopy	(Inherited from BaseClass)
	PerformPostCalcValidation	(Inherited from BaseClass)
	RemoveDynamicProperty	(Inherited from BaseClass)
	RemoveExtraProperty	(Inherited from BaseClass)
	Reset
	RunDynamicModel	(Inherited from BaseClass)
	SaveData	(Overrides BaseClassSaveData)
	SetCanUsePreviousResults	(Inherited from BaseClass)
	SetDirtyStatus	(Inherited from BaseClass)
	SetDynamicProperty	(Inherited from BaseClass)
	SetExtraPropertyValue	(Inherited from BaseClass)
	SetFlowsheet	Sets the Flowsheet to which this object belongs to. (Inherited from BaseClass)
	SetPropertyPackageInstance	(Inherited from BaseClass)
	SetPropertyValue	(Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure))
	Solve	(Inherited from BaseClass)
	StoreDebugReport	(Inherited from BaseClass)
	ToString	(Inherited from BaseClass)
	TransferAdditionalSolidData	(Inherited from BaseClass)
	UpdateDynamicsEditForm	(Inherited from BaseClass)
	UpdateEditForm	(Overrides BaseClassUpdateEditForm)
	UpdateExtraPropertiesEditForm	(Inherited from BaseClass)
	Validate	Validates the object, checking its connections and other parameters. (Inherited from BaseClass)

Top

Fields

	Name	Description
	_CanUsePreviousResults	(Inherited from BaseClass)
	_IsDirty	(Inherited from BaseClass)
	BaseSP
	CalculationRoutineOverride	(Inherited from BaseClass)
	disposedValue	(Inherited from BaseClass)
	ExtraPropertiesEditor	(Inherited from BaseClass)
	f
	fd	(Inherited from BaseClass)
	LaunchExternalPropertyEditor	(Inherited from BaseClass)
	m_AdjustValue
	m_ControlledObject
	m_ControlledObjectData
	m_ControlledVariable
	m_CV_OK
	m_flowsheet	(Inherited from BaseClass)
	m_initialEstimate
	m_IsReferenced
	m_IsSimultAdjustEnabled
	m_ManipulatedObject
	m_ManipulatedObjectData
	m_ManipulatedVariable
	m_MaxIterations
	m_maxVal
	m_minVal
	m_MV_OK
	m_ReferencedObjectData
	m_ReferenceObject
	m_ReferenceVariable
	m_RV_OK
	m_Status
	m_StepSize
	m_Tolerance

Top

Extension Methods

	Name	Description
	GetEnumNames	(Defined by General)
	IsValidDouble	(Defined by General)

Top

Reference

DWSIM.UnitOperations.SpecialOps Namespace