EnergyStream Class

Inheritance Hierarchy

SystemObject
DWSIM.SharedClasses.UnitOperationsBaseClass
DWSIM.UnitOperations.StreamsEnergyStream

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

Syntax

Copy

[SerializableAttribute]
[ComVisibleAttribute(true)]
public class EnergyStream : BaseClass, 
	ICapeIdentification, ICapeCollection, IEnergyStream, ECapeUser, ECapeUnknown, 
	ECapeRoot

<SerializableAttribute>
<ComVisibleAttribute(true)>
Public Class EnergyStream
	Inherits BaseClass
	Implements ICapeIdentification, ICapeCollection, IEnergyStream, ECapeUser, 
	ECapeUnknown, ECapeRoot

Request Example View Source

The EnergyStream type exposes the following members.

Constructors

	Name	Description
	EnergyStream
	EnergyStream(String, String)

Top

Properties

	Name	Description
	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)
	code
	ComponentDescription	(Overrides BaseClassComponentDescription)
	ComponentName	(Overrides BaseClassComponentName)
	CreateChartAction	(Inherited from BaseClass)
	DebugMode	(Inherited from BaseClass)
	DebugText	(Inherited from BaseClass)
	description
	DetailedDebugReport	(Inherited from BaseClass)
	DynamicsOnly	(Inherited from BaseClass)
	DynamicsSpec	(Inherited from BaseClass)
	EnergyFlow	Power (energy) associated with this stream. (Overrides BaseClassEnergyFlow)
	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	(Overrides BaseClassHasPropertiesForDynamicMode)
	interfaceName
	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)
	LastSolutionInputSnapshot	(Inherited from BaseClass)
	LastUpdated	(Inherited from BaseClass)
	MobileCompatible	(Overrides BaseClassMobileCompatible)
	moreInfo
	Name	Object's Unique ID (Name) (Inherited from BaseClass)
	Name2
	ObjectClass	(Overrides BaseClassObjectClass)
	operation
	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)
	scope
	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)
	StoreDetailedDebugReport	(Inherited from BaseClass)
	SupportsDynamicMode	(Overrides BaseClassSupportsDynamicMode)
	UserDefinedChartNames	(Inherited from BaseClass)
	Visible	(Inherited from BaseClass)

Top

Methods

	Name	Description
	AddDynamicProperty	(Inherited from BaseClass)
	AddExtraProperty	(Inherited from BaseClass)
	AppendDebugLine	(Inherited from BaseClass)
	Assign
	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)
	Count
	CreateDynamicProperties	(Inherited from BaseClass)
	CreateNew	(Inherited from BaseClass)
	CreateParamCol
	DeCalculate	(Inherited from BaseClass)
	DisplayDynamicsEditForm	(Inherited from BaseClass)
	DisplayEditForm	(Overrides BaseClassDisplayEditForm)
	DisplayExtraPropertiesEditForm	(Inherited from BaseClass)
	Dispose	(Inherited from BaseClass)
	Dispose(Boolean)	(Inherited from BaseClass)
	FT	Formats a property string, adding its units in parenthesis. (Inherited from BaseClass)
	GetAsObject	(Inherited from BaseClass)
	GetChartModel	(Inherited from BaseClass)
	GetChartModelNames	(Inherited from BaseClass)
	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	(Inherited from BaseClass)
	GetEnergyBalanceResidual	(Inherited from BaseClass)
	GetEnergyConsumption	(Overrides BaseClassGetEnergyConsumption)
	GetEnergyFlow
	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	(Overrides BaseClassGetPropertyDescription(String))
	GetPropertyUnit	(Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure))
	GetPropertyValue	(Overrides BaseClassGetPropertyValue(String, IUnitsOfMeasure))
	GetReport	(Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String))
	GetStructuredReport	(Overrides BaseClassGetStructuredReport)
	GetVersion	(Inherited from BaseClass)
	Init
	IsDynamicProperty	(Inherited from BaseClass)
	Item
	LoadData	Loads object data stored in a collection of XML elements. (Inherited from BaseClass)
	m_work_OnParameterValueChanged
	ObjectCopy	(Inherited from BaseClass)
	PerformPostCalcValidation	(Inherited from BaseClass)
	RemoveDynamicProperty	(Inherited from BaseClass)
	RemoveExtraProperty	(Inherited from BaseClass)
	RunDynamicModel	(Overrides BaseClassRunDynamicModel)
	SaveData	Saves object data in a collection of XML elements. (Inherited from BaseClass)
	SetCanUsePreviousResults	(Inherited from BaseClass)
	SetDirtyStatus	(Inherited from BaseClass)
	SetDynamicProperty	(Inherited from BaseClass)
	SetEnergyFlow
	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))
	SetValue
	Solve	(Inherited from BaseClass)
	StoreDebugReport	(Inherited from BaseClass)
	ThrowCAPEException
	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)
	_code
	_description
	_eflow
	_interfacename
	_IsDirty	(Inherited from BaseClass)
	_moreinfo
	_operation
	_scope
	CalculationRoutineOverride	(Inherited from BaseClass)
	disposedValue	(Inherited from BaseClass)
	ExtraPropertiesEditor	(Inherited from BaseClass)
	f
	fd	(Inherited from BaseClass)
	initialized
	LaunchExternalPropertyEditor	(Inherited from BaseClass)
	m_flowsheet	(Inherited from BaseClass)

Top

Extension Methods

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

Top

Explicit Interface Implementations

	Name	Description
	m_tLow
	m_tUp
	m_work

Top

Reference

DWSIM.UnitOperations.Streams Namespace