Entry object for using CHEMCAD as a COM server More...

Inheritance diagram for CCAPI.Server:

Public Member Functions
	Server (string licenseKey)
	Initialize a Server, load the configuration and validates the license. More...

void	Release ()
	Method added to release COM from MATLAB. More...

Flowsheet	LoadFlowsheet (string path)
	Opens a flowsheet from a user defined path and allows access to this flowsheet. More...

void	CloseSimulation ()

void	Run ()
	Executes the simulation. More...

void	Save ()
	Saves this flowsheet to file. More...

void	Pause ()
	Pause simulation. More...

void	RunOptimization ()
	Run optimization. More...

void	RunOptimizationFile (string filePath)
	Run optimization from file. More...

OptimizationVariables	GetOptimizationVariables (string filepath)
	Get Optimization variables. More...

void	SetOptimizationVariables (string filePath, OptimizationVariables optimizationVariables)
	Set Optimization variables. More...

void	RunDataReconciliation ()
	Run Data reconciliation and parameter estimation. More...

void	RunAllUnits ()
	Run all units in a steady state simulation. More...

void	RunSelectedUnits (params UnitOperation[] unitOps)
	Run selected units in a steady state simulation. Select Units More...

void	RunNamedSequence (string name)
	Run a namend sequence in a steady state simulation. More...

void	RunAllSteps ()
	Run all steps in a dynamic simulation. More...

void	RunStep ()
	Run one step in a dynamic simulation. More...

void	RestoreToInitialState ()
	Restore dynamic simulation to initial state. More...

void	SetCurrentAsInitialState ()
	Sets the current state as the initial state. More...

void	TakeSnapshot (string name)
	Take snapshot of the current simulation state. More...

void	LoadSnapshot (string name)
	Load snapshot of simulation state. More...

string	GetJobAt (short jobIndex)
	Gets the job at specified index. More...

short	GetNumberOfCasesInJob (string jobPath)
	Gets the number of cases in the job. More...

string	GetCaseAt (string jobPath, short caseIndex)
	Gets the case from the job at specified number More...

Static Public Member Functions
static void	DeactivateLicense (string licenseKey)

Properties
Flowsheet	CurrentFlowsheet `[get]`
	The flowsheet that is currently loaded More...

string	RuntimeMessages `[get]`
	Returns the runtime messages of CHEMCAD. More...

float	TimeInMinute `[get]`
	Returns the time of a dynamic simulation in minutes. More...

float	TimeStepInMinute `[get]`
	Returns the time step of a dynamic simulation in minutes. More...

float	TimeScale `[get, set]`
	Time scale used for operator training system. More...

int	Version `[get]`
	Returns the current version of CHEMCAD. More...

string	WorkingDirectory `[get, set]`
	Gets the working directory used by CHEMCAD. More...

short	GetNoOfJobsInWorkDirectory `[get]`
	Gets the working directory used by CHEMCAD. More...

int	PId `[get]`

Properties inherited from CCAPI.IServer
int	PId `[get]`

Flowsheet	CurrentFlowsheet `[get]`

string	RuntimeMessages `[get]`

float	TimeInMinute `[get]`

float	TimeStepInMinute `[get]`

float	TimeScale `[get, set]`

int	Version `[get]`

string	WorkingDirectory `[get, set]`

Detailed Description

Entry object for using CHEMCAD as a COM server

Constructor & Destructor Documentation

◆ Server()

CCAPI.Server.Server ( string licenseKey )

Initialize a Server, load the configuration and validates the license.

Parameters

licenseKey License key

Member Function Documentation

◆ GetCaseAt()

string CCAPI.Server.GetCaseAt	(	string	jobPath,
		short	caseIndex
	)

Gets the case from the job at specified number

◆ GetJobAt()

string CCAPI.Server.GetJobAt ( short jobIndex )

Gets the job at specified index.

◆ GetNumberOfCasesInJob()

short CCAPI.Server.GetNumberOfCasesInJob ( string jobPath )

Gets the number of cases in the job.

◆ GetOptimizationVariables()

OptimizationVariables CCAPI.Server.GetOptimizationVariables ( string filepath )

Get Optimization variables.

◆ LoadFlowsheet()

Flowsheet CCAPI.Server.LoadFlowsheet ( string path )

Opens a flowsheet from a user defined path and allows access to this flowsheet.

Implements CCAPI.IServer.

◆ LoadSnapshot()

void CCAPI.Server.LoadSnapshot ( string name )

Load snapshot of simulation state.

Parameters

name

Implements CCAPI.IServer.

◆ Pause()

void CCAPI.Server.Pause ( )

Pause simulation.

Implements CCAPI.IServer.

◆ Release()

void CCAPI.Server.Release ( )

Method added to release COM from MATLAB.

◆ RestoreToInitialState()

void CCAPI.Server.RestoreToInitialState ( )

Restore dynamic simulation to initial state.

Implements CCAPI.IServer.

◆ Run()

void CCAPI.Server.Run ( )

Executes the simulation.

Implements CCAPI.IServer.

◆ RunAllSteps()

void CCAPI.Server.RunAllSteps ( )

Run all steps in a dynamic simulation.

Implements CCAPI.IServer.

◆ RunAllUnits()

void CCAPI.Server.RunAllUnits ( )

Run all units in a steady state simulation.

Implements CCAPI.IServer.

◆ RunDataReconciliation()

void CCAPI.Server.RunDataReconciliation ( )

Run Data reconciliation and parameter estimation.

◆ RunNamedSequence()

void CCAPI.Server.RunNamedSequence ( string name )

Run a namend sequence in a steady state simulation.

Parameters

name

Implements CCAPI.IServer.

◆ RunOptimization()

void CCAPI.Server.RunOptimization ( )

Run optimization.

Implements CCAPI.IServer.

◆ RunOptimizationFile()

void CCAPI.Server.RunOptimizationFile ( string filePath )

Run optimization from file.

◆ RunSelectedUnits()

void CCAPI.Server.RunSelectedUnits ( params UnitOperation[] unitOps )

Run selected units in a steady state simulation. Select Units

Parameters

unitOps

Implements CCAPI.IServer.

◆ RunStep()

void CCAPI.Server.RunStep ( )

Run one step in a dynamic simulation.

Implements CCAPI.IServer.

◆ Save()

void CCAPI.Server.Save ( )

Saves this flowsheet to file.

Returns: Overwrites actual CHEMCAD file.

Implements CCAPI.IServer.

◆ SetCurrentAsInitialState()

void CCAPI.Server.SetCurrentAsInitialState ( )

Sets the current state as the initial state.

Implements CCAPI.IServer.

◆ SetOptimizationVariables()

void CCAPI.Server.SetOptimizationVariables	(	string	filePath,
		OptimizationVariables	optimizationVariables
	)

Set Optimization variables.

◆ TakeSnapshot()

void CCAPI.Server.TakeSnapshot ( string name )

Take snapshot of the current simulation state.

Parameters

name

Implements CCAPI.IServer.

Property Documentation

◆ CurrentFlowsheet

Flowsheet CCAPI.Server.CurrentFlowsheet

get

The flowsheet that is currently loaded

◆ GetNoOfJobsInWorkDirectory

short CCAPI.Server.GetNoOfJobsInWorkDirectory

get

Gets the working directory used by CHEMCAD.

◆ RuntimeMessages

string CCAPI.Server.RuntimeMessages

get

Returns the runtime messages of CHEMCAD.

◆ TimeInMinute

float CCAPI.Server.TimeInMinute

get

Returns the time of a dynamic simulation in minutes.

Returns

◆ TimeScale

float CCAPI.Server.TimeScale

getset

Time scale used for operator training system.

◆ TimeStepInMinute

float CCAPI.Server.TimeStepInMinute

get

Returns the time step of a dynamic simulation in minutes.

Returns

◆ Version

int CCAPI.Server.Version

get

Returns the current version of CHEMCAD.

◆ WorkingDirectory

string CCAPI.Server.WorkingDirectory

getset

Gets the working directory used by CHEMCAD.

The documentation for this class was generated from the following file:

C:/builds/qw2AyaQN/0/capital-gain/software/net-interface/cc-api/api/Server.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Server()

Member Function Documentation

◆ GetCaseAt()

◆ GetJobAt()

◆ GetNumberOfCasesInJob()

◆ GetOptimizationVariables()

◆ LoadFlowsheet()

◆ LoadSnapshot()

◆ Pause()

◆ Release()

◆ RestoreToInitialState()

◆ Run()

◆ RunAllSteps()

◆ RunAllUnits()

◆ RunDataReconciliation()

◆ RunNamedSequence()

◆ RunOptimization()

◆ RunOptimizationFile()

◆ RunSelectedUnits()

◆ RunStep()

◆ Save()

◆ SetCurrentAsInitialState()

◆ SetOptimizationVariables()

◆ TakeSnapshot()

Property Documentation

◆ CurrentFlowsheet

◆ GetNoOfJobsInWorkDirectory

◆ RuntimeMessages

◆ TimeInMinute

◆ TimeScale

◆ TimeStepInMinute

◆ Version

◆ WorkingDirectory