EnergyStream Class

Represents an energy stream that carries a heat or power flow between unit operations in a flowsheet. Implements CAPE-OPEN identification and collection interfaces.

Definition

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

C#Request Example

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

VBRequest Example

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

Inheritance: Object BaseClass EnergyStream

Implements: ECapeRoot, ECapeUnknown, ECapeUser, ICapeCollection, ICapeIdentification, IEnergyStream

Constructors

EnergyStream	Initializes a new default instance of the EnergyStream class.
EnergyStream(String, String)	Initializes a new instance of the EnergyStream class with a name and description.

Properties

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)
AttachedInfoCarrierId	(Inherited from BaseClass)
AttachedSpecId	If an Specification object is attached to this object, returns its ID. (Inherited from BaseClass)
AttachedUtilities	(Inherited from BaseClass)
Bottom	(Inherited from BaseClass)
Calculated	(Inherited from BaseClass)
CanUsePreviousResults	(Inherited from BaseClass)
code	Gets the CAPE-OPEN error code from the most recent exception thrown by this object.
ComponentDescription	Gets or sets the CAPE-OPEN component description for this energy stream. (Overrides BaseClassComponentDescription)
ComponentName	Gets or sets the CAPE-OPEN component name for this energy stream. (Overrides BaseClassComponentName)
CreateChartAction	(Inherited from BaseClass)
DebugMode	(Inherited from BaseClass)
DebugText	(Inherited from BaseClass)
description	Gets the CAPE-OPEN error description from the most recent exception thrown by this object.
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	Gets a value indicating whether this energy stream exposes properties specific to dynamic mode. (Overrides BaseClassHasPropertiesForDynamicMode)
Height	(Inherited from BaseClass)
InfoCarrierVarType	(Inherited from BaseClass)
interfaceName	Gets the name of the CAPE-OPEN interface that raised the most recent exception.
IsAdjustAttached	Checks if an Adjust operation is attached to this object. (Inherited from BaseClass)
IsDirty	(Inherited from BaseClass)
IsFunctional	(Inherited from BaseClass)
IsInfoCarrierAttached	(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)
Left	(Inherited from BaseClass)
m_tLow
m_tUp
m_work
MobileCompatible	Gets a value indicating whether this energy stream is compatible with the DWSIM mobile interface. (Overrides BaseClassMobileCompatible)
moreInfo	Gets additional information about the most recent CAPE-OPEN exception.
Name	Object's Unique ID (Name) (Inherited from BaseClass)
Name2	Gets the CAPE-OPEN root name of this component, used by the ECapeRoot interface.
ObjectClass	Gets or sets the simulation object class for this energy stream. (Overrides BaseClassObjectClass)
operation	Gets the name of the operation that raised the most recent CAPE-OPEN exception.
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)
Right	(Inherited from BaseClass)
scope	Gets the scope description associated with the most recent CAPE-OPEN exception.
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	Gets a value indicating whether this energy stream supports dynamic simulation mode. (Overrides BaseClassSupportsDynamicMode)
Top	(Inherited from BaseClass)
UserDefinedChartNames	(Inherited from BaseClass)
Visible	(Inherited from BaseClass)
Width	(Inherited from BaseClass)

Methods

AddDynamicProperty	(Inherited from BaseClass)
AddExtraProperty	(Inherited from BaseClass)
AppendDebugLine	(Inherited from BaseClass)
Assign	Copies the energy flow property from the specified source energy stream to this instance.
Calculate	Marks the energy stream as calculated (clears its dirty state). (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	Creates a deep copy of this energy stream by serializing and deserializing via JSON. (Overrides BaseClassCloneJSON)
CloneXML	Creates a deep copy of this energy stream by serializing and deserializing via XML. (Overrides BaseClassCloneXML)
CloseDynamicsEditForm	(Inherited from BaseClass)
CloseEditForm	Closes and disposes the editing form for this energy stream if it is open. (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	Returns the number of parameters in the CAPE-OPEN parameter collection for this energy stream.
CreateDynamicProperties	(Inherited from BaseClass)
CreateNew	(Inherited from BaseClass)
CreateParamCol
DeCalculate	(Inherited from BaseClass)
DisplayDynamicsEditForm	(Inherited from BaseClass)
DisplayEditForm	Opens or activates the editing form for this energy stream. (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)
GetBytesFromResource	(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	Returns the localized display description for the energy stream object type. (Overrides BaseClassGetDisplayDescription)
GetDisplayName	Returns the localized display name for the energy stream object type. (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	Returns the current energy flow value of the stream in watts (SI). (Overrides BaseClassGetEnergyConsumption)
GetEnergyFlow	Returns the current energy flow value in watts (SI) via the IEnergyStream interface.
GetExtraPropertyValue	(Inherited from BaseClass)
GetFlowsheet	(Inherited from BaseClass)
GetIconBitmap	Returns the icon bitmap resource associated with the energy stream object. (Overrides BaseClassGetIconBitmap)
GetIconBitmapBytes	Returns the raw bytes of the energy stream icon image resource. (Overrides BaseClassGetIconBitmapBytes)
GetMassBalanceResidual	(Inherited from BaseClass)
GetPowerGeneratedOrConsumed	(Inherited from BaseClass)
GetPreferredGraphicObjectHeight	(Inherited from BaseClass)
GetPreferredGraphicObjectWidth	(Inherited from BaseClass)
GetProperties	Returns the list of property identifiers available for this energy stream filtered by the specified property type. (Overrides BaseClassGetProperties(PropertyType))
GetProperties2	(Inherited from BaseClass)
GetPropertyDescription	Returns a human-readable description for the specified property identifier. (Overrides BaseClassGetPropertyDescription(String))
GetPropertyUnit	Returns the unit string for the specified property in the given unit system. (Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure))
GetPropertyUnits2	(Inherited from BaseClass)
GetPropertyValue	Returns the value of the specified property converted to the given unit system. (Overrides BaseClassGetPropertyValue(String, IUnitsOfMeasure))
GetPropertyValue2	(Inherited from BaseClass)
GetReport	Generates a plain-text report of the energy stream results using the specified unit system and formatting options. (Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String))
GetStructuredReport	Generates a structured report of the energy stream results as a list of labeled tuples for display. (Overrides BaseClassGetStructuredReport)
GetVersion	(Inherited from BaseClass)
Init
IsDynamicProperty	(Inherited from BaseClass)
Item	Retrieves a CAPE-OPEN parameter from the collection by index or name.
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	Executes the dynamic simulation model step for this energy stream (no-op for energy streams). (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	Sets the energy flow value in watts (SI) via the IEnergyStream interface.
SetExtraPropertyValue	(Inherited from BaseClass)
SetFlowsheet	Sets the Flowsheet to which this object belongs to. (Inherited from BaseClass)
SetPropertyPackageInstance	(Inherited from BaseClass)
SetPropertyValue	Sets the value of the specified property after converting from the given unit system to SI. (Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure))
SetPropertyValue2	(Inherited from BaseClass)
SetValue	Sets the energy flow of this stream directly using a value in kilowatts.
Solve	(Inherited from BaseClass)
StoreDebugReport	(Inherited from BaseClass)
ThrowCAPEException	Stores CAPE-OPEN error information and throws a CapeComputationException wrapping the original exception.
ToString	(Inherited from BaseClass)
TransferAdditionalSolidData	(Inherited from BaseClass)
UpdateDynamicsEditForm	(Inherited from BaseClass)
UpdateEditForm	Refreshes the displayed data in the editing form if it is currently open. (Overrides BaseClassUpdateEditForm)
UpdateExtraPropertiesEditForm	(Inherited from BaseClass)
Validate	Validates the object, checking its connections and other parameters. (Inherited from BaseClass)

Fields

_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)

Extension Methods

GetEnumNames	(Defined by General)
IsValidDouble	(Defined by General)