OpenTD .NET4 reference 2025 R2

OpenTD.CoSolver.CoSolver Class Reference

Last update: 16.07.2025

Base class for communicating with a Sinda run via an SF_Pipe. More...

Inheritance diagram for OpenTD.CoSolver.CoSolver:
OpenTD.CoSolver.SF_CoSolverOpenTD.CoSolver.TDSF_CoSolver

Public Member Functions

virtual void Initialize ()
 
void SetupExperiment ()
 
void Abort ()
 
int DoStep ()
 
int Continue ()
 Tells Sinda to proceed to the next step of the simulation. Return values: -1 - Sinda disconnected or error 0 - Sinda initial connection after call to OPENSF 99 - Sinda termination.
 
string GetRegisterExpression (string name)
 
double GetRegisterValue (string name)
 
void SetRegisterExpression (string name, double value)
 
double GetValue (string submodel, int Id, string type)
 
double GetValue (int SequenceNumber, string type)
 
double GetValue (string name)
 
Int64 GetNodeSequenceNumber (string submodel, int Id)
 
Int64 GetPathSequenceNumber (string submodel, int Id)
 
Int64 GetCondSequenceNumber (string submodel, int Id)
 
Int64 GetTieSequenceNumber (string submodel, int Id)
 
Int64 GetLumpSequenceNumber (string submodel, int Id)
 
void Set_Q_UDFA (string name, int SequenceNumber, double value)
 
void SetValue (string submodel, int Id, string type, double value)
 
void SetValue (int SequenceNumber, string type, double value)
 
void SetValue (string name, double value)
 

Protected Member Functions

void CreateSF_Pipe ()
 
void CloseSF_Pipe ()
 

Protected Attributes

string pipeID
 
SF_Pipe sf_pipe = null
 

Properties

int InitializeTimeoutMs = 60000 [get, set]
 Determines how long in milliseconds that Initialize() will try to connect to the Sinda run.
 
double CouplingTimeStep [set]
 
bool Converged [set]
 

Detailed Description

Base class for communicating with a Sinda run via an SF_Pipe.

Member Function Documentation

◆ Abort()

void OpenTD.CoSolver.CoSolver.Abort ( )
inline

◆ CloseSF_Pipe()

void OpenTD.CoSolver.CoSolver.CloseSF_Pipe ( )
inlineprotected

◆ Continue()

int OpenTD.CoSolver.CoSolver.Continue ( )
inline

Tells Sinda to proceed to the next step of the simulation. Return values: -1 - Sinda disconnected or error 0 - Sinda initial connection after call to OPENSF 99 - Sinda termination.

11 - beginning of STEADY 12 - end of STEADY

1 - beginning of TRANSIENT 2 - at end of TRANSIENT time step 3 - at end of TRANSIENT

◆ CreateSF_Pipe()

void OpenTD.CoSolver.CoSolver.CreateSF_Pipe ( )
inlineprotected

◆ DoStep()

int OpenTD.CoSolver.CoSolver.DoStep ( )
inline

◆ GetCondSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetCondSequenceNumber ( string submodel,
int Id )
inline

◆ GetLumpSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetLumpSequenceNumber ( string submodel,
int Id )
inline

◆ GetNodeSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetNodeSequenceNumber ( string submodel,
int Id )
inline

◆ GetPathSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetPathSequenceNumber ( string submodel,
int Id )
inline

◆ GetRegisterExpression()

string OpenTD.CoSolver.CoSolver.GetRegisterExpression ( string name)
inline

◆ GetRegisterValue()

double OpenTD.CoSolver.CoSolver.GetRegisterValue ( string name)
inline

◆ GetTieSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetTieSequenceNumber ( string submodel,
int Id )
inline

◆ GetValue() [1/3]

double OpenTD.CoSolver.CoSolver.GetValue ( int SequenceNumber,
string type )
inline

◆ GetValue() [2/3]

double OpenTD.CoSolver.CoSolver.GetValue ( string name)
inline

◆ GetValue() [3/3]

double OpenTD.CoSolver.CoSolver.GetValue ( string submodel,
int Id,
string type )
inline

◆ Initialize()

virtual void OpenTD.CoSolver.CoSolver.Initialize ( )
inlinevirtual

Reimplemented in OpenTD.CoSolver.SF_CoSolver, and OpenTD.CoSolver.TDSF_CoSolver.

◆ Set_Q_UDFA()

void OpenTD.CoSolver.CoSolver.Set_Q_UDFA ( string name,
int SequenceNumber,
double value )
inline

◆ SetRegisterExpression()

void OpenTD.CoSolver.CoSolver.SetRegisterExpression ( string name,
double value )
inline

◆ SetupExperiment()

void OpenTD.CoSolver.CoSolver.SetupExperiment ( )
inline

◆ SetValue() [1/3]

void OpenTD.CoSolver.CoSolver.SetValue ( int SequenceNumber,
string type,
double value )
inline

◆ SetValue() [2/3]

void OpenTD.CoSolver.CoSolver.SetValue ( string name,
double value )
inline

◆ SetValue() [3/3]

void OpenTD.CoSolver.CoSolver.SetValue ( string submodel,
int Id,
string type,
double value )
inline

Member Data Documentation

◆ pipeID

string OpenTD.CoSolver.CoSolver.pipeID
protected

◆ sf_pipe

SF_Pipe OpenTD.CoSolver.CoSolver.sf_pipe = null
protected

Property Documentation

◆ Converged

bool OpenTD.CoSolver.CoSolver.Converged
set

◆ CouplingTimeStep

double OpenTD.CoSolver.CoSolver.CouplingTimeStep
set

◆ InitializeTimeoutMs

int OpenTD.CoSolver.CoSolver.InitializeTimeoutMs = 60000
getset

Determines how long in milliseconds that Initialize() will try to connect to the Sinda run.

The documentation for this class was generated from the following file:
  • C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/TDDEV_ALPHA/buildXX/OpenTD.CoSolver/CoSolver.cs

Connect with Ansys