FlowsheetBase Methods

Methods

AddCompound 
AddCompoundsToMaterialStream Adds all compounds currently selected in the flowsheet to all phases of the given material stream, then equalises the overall composition and recalculates mass fractions.
AddConnectedObjects Automatically creates and connects material/energy streams around the specified object according to the given scheme.
AddDefaultProperties 
AddExternalUOs 
AddFlowsheetObjectCreates a simulation object by type name at the default position (50, 50) and assigns the given object name.
AddGraphicObjectAdds a graphic object to both the drawing surface and the GraphicObjects dictionary.
AddGraphicObjects 
AddObject(ObjectType, Int32, Int32, String)Creates a simulation object of the specified type, places its graphic on the surface, and returns the new object.
AddObject(ObjectType, Int32, Int32, String, String)Creates a simulation object with an explicit ID, places its graphic on the surface, and returns the new object.
AddObject(String, Int32, Int32, String, String, Boolean) Creates a simulation object identified by its human-readable type name and places it on the flowsheet surface.
AddObjectToSurface Low-level method that instantiates the graphic and simulation objects for a given ObjectType, adds them to the drawing surface and the SimulationObjects dictionary, and returns the new object's ID.
AddPropertyPackageRegisters a property package with the flowsheet, assigning a unique ID and tag if not already set.
AddPropPacks 
AddReaction 
AddReactionSet 
AddReactionToSet 
AddSimulationObjectAdds a simulation object directly to the SimulationObjects dictionary without creating a graphic counterpart.
AddSimulationObjects 
AddSystemsOfUnits 
AddTables 
AddUndoRedoAction 
AutoLayout 
CalcReactionStoichiometry 
ChangeCalculationOrder 
CheckStatusChecks whether the flowsheet solver should pause or abort the current calculation, e.g. on user request.
CheckTag 
ClearLog 
Clone 
CloseOpenEditFormsCloses all currently open property editors. Must be implemented by the concrete host.
Connect Connects two simulation objects. If both are unit operations, an intermediate material stream is created automatically and positioned between them.
ConnectObject 
ConnectObjectsConnects two graphic objects via their connector ports and registers an undo snapshot.
CopyObjects 
CreateAndAddPropertyPackage 
CreateConversionReaction Creates a conversion reaction
CreateEquilibriumReaction Creates an equilibrium reaction
CreateHetCatReaction creates a heterogeneous catalytic reaction
CreateKineticReaction creates a kinetic reaction
CreatePropertyPackage 
CreateReactionSet 
CutObjects 
DeleteObject 
DeleteSelectedObject Removes a graphic object and its associated simulation object from the flowsheet, automatically disconnecting all attached connectors and cleaning up spec/adjust references.
DisconnectDisconnects two previously connected simulation objects via their graphic representations.
DisconnectObjectsDisconnects two previously connected graphic objects and registers an undo snapshot.
DisplayBrowserWindow 
DisplayDockableBrowserWindow 
DisplayFormDisplays a form or panel within the flowsheet's docking area. Must be implemented by the concrete UI host.
GetApplicationObject 
GetAvailableFlowsheetObjectTypeNamesReturns a sorted array of all built-in flowsheet object type names that can be passed to AddObject(String, Int32, Int32, String, String, Boolean).
GetAvailablePropertyPackages 
GetCompound 
GetDockPanel 
GetFlowsheetBag 
GetFlowsheetGraphicObjectReturns the graphic object whose user-visible tag matches the specified value.
GetFlowsheetSimulationObjectReturns the simulation object whose user-visible tag matches the specified value.
GetFlowsheetSurfaceHeight 
GetFlowsheetSurfaceWidth 
GetNewInstanceCreates and returns a new empty flowsheet instance of the same concrete type.
GetObject 
GetProcessData 
GetPropertyPackage 
GetPropertyPackages 
GetReaction 
GetReactionSet 
GetResultIDs 
GetResultUnits 
GetResultValue 
GetScriptText 
GetSelectedFlowsheetSimulationObject Returns the currently selected simulation object, or searches by tag if one is provided.
GetSimulationFileDirectory 
GetSimulationFilePath 
GetSnapshot 
GetSnapshotObjectID 
GetSpreadsheetData 
GetSpreadsheetFormat 
GetSpreadsheetObject 
GetSurfaceReturns the underlying GraphicsSurface used for drawing and hit-testing flowsheet objects.
GetSurfaceControlReturns the UI control that hosts the drawing surface, or Nothing in non-UI contexts.
GetTranslatedString(String) Looks up a localised string by key, searching flowsheet string resources first, then property name resources. Falls back to the original key if no translation is found.
GetTranslatedString(String, String)Overload that ignores locale and delegates to GetTranslatedString(String).
GetUtility 
Initialize 
IsZipFilePasswordProtected 
LoadExtenders 
LoadFromExtensionsFolder 
LoadFromMXML 
LoadFromXML 
LoadProcessData 
LoadZippedXML 
LoadZippedXMLDoc 
NaturalLayout 
PasteObjects 
ProcessRedo 
ProcessScripts 
ProcessUndo 
RefreshInterface 
RegisterSnapshot 
ReleaseResources 
RequestCalculation Requests a flowsheet calculation, optionally scoped to a single changed object. When sender is provided the object is queued and the solver runs asynchronously.
RequestCalculation2Requests a full flowsheet calculation, optionally blocking the calling thread until it completes.
RequestCalculation3Requests a calculation scoped to a single object, or a full solve when Obj is Nothing.
RequestCalculationAndWaitRuns a full flowsheet calculation synchronously and returns any exceptions raised during the solve.
RequestSave 
RequestSaveWithDirectory 
RequestSaveWithPath 
Reset 
ResetCalculationStatusMarks all simulation objects as dirty and uncalculated, forcing a full recalculation on the next solve request.
RestoreLastSuccessfulSolutionState 
RestoreSnapshot 
RunCodeOnUIThread 
RunCodeOnUIThread2 
RunScript 
RunScript_IronPython 
RunScript_PythonNET 
RunScriptAsync 
SaveCurrentStateAsLastSuccessfulSolution 
SavePFDScreenshotToPNG 
SaveToMXML 
SaveToXML 
SetDirtyStatus 
SetMessageListener 
SetPropertyResourcesManagerSets the resource manager used for resolving localised property names in this flowsheet.
SetResourcesManagerSets the resource manager used for resolving localised strings in this flowsheet.
SetTranslateTextExternalFunction 
ShowDebugInfoWrites a debug message at the specified verbosity level to the diagnostic output. Must be implemented by the concrete host.
ShowMessageDisplays a message to the user via the log panel or equivalent output. Must be implemented by the concrete host.
SolveRequests a full flowsheet calculation using the configured solver mode.
ToggleFlowsheetAnimation 
TriggerNewDataLoadedEvent Raises the new-data-loaded event. Override in derived classes to update the UI after data changes.
UnloadExtenders 
UpdateInformation 
UpdateInterface 
UpdateMassAndEnergyBalance 
UpdateOpenEditFormsRefreshes all open property editors to reflect the current state of simulation objects. Must be implemented by the concrete host.
UpdateSpreadsheet 
WriteSpreadsheetVariables 

Extension Methods

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

Explicit Interface Implementations

See Also