OpenTD .NET4 reference 2025 R2

OpenTD.TdConnectConfig Class Reference

Last update: 16.07.2025

Controls how ThermalDesktop object connects to its actual TD instance when ThermalDesktop.Connect() is called. More...

Classes

class  TimeoutProperties
 Data used to decide when to timeout an operation. More...
 

Public Types

enum  Types { START_NEW_TD , AUTO , ATTACH_TO_TD , INPROCESS }
 Determines whether ThermalDesktop will start a new instance of TD, attach to an existing instance, or automatically try to attach but revert to starting a new instance if attaching fails. There's also an INPROCESS option that is only used internally by TD. More...
 

Public Member Functions

 TdConnectConfig ()
 
void Validate ()
 Validates this instance of TdConnectConfig. Is called automatically by ThermalDesktop.Connect().
 

Static Public Member Functions

static string GetRepeatableNameFromPath (string pathname, bool calledFromServer=false)
 

Properties

Types Type [get, set]
 
RootedPathname AcadExePathname [get, set]
 Normally ThermalDesktop.Connect() uses the latest version of AutoCAD it finds on your machine. Set AcadExePathname to the location of another acad.exe to force it to use that version of AutoCAD. Caution: some older versions of AutoCAD may not work with OpenTD.
 
string StartDirectory [get, set]
 The starting directory for the acad.exe process. For the current working directory, see ThermalDesktop.GetCurrentWorkingDirectory().
 
RootedPathname DwgPathname [get, set]
 Path to dwg file to open or attach to if already opened. If left blank and TdConnectConfig.Type allows it, ThermalDesktop.Connect() will start a new, blank drawing. Do not use this member to find the current dwg name. Instead, use ThermalDesktop.GetCurrentDwgPathname().
 
string PipeEndpointName [get, set]
 Advanced. If not blank, specifies the name of the communications channel used by OpenTD to communicate with this instance of TD. If starting a new TD instance, OpenTD will attempt to create a channel with this name. If attaching, OpenTD will attempt to connect to a channel with this name. Leave blank for automatic channel-naming. To open a named channel in TD, use the 'RcOpenTD' AutoCAD command.
 
string PipeEndpointNameUsed [get]
 Gets the communication channel name actually used. Set when ThermalDesktop.Connect() is called successfully.
 
TimeoutProperties StartTimeout [get, set]
 Controls how long OpenTD will try to connect to TD before timing out.
 
bool AcadVisible [get, set]
 Controls whether a newly-started instance of TD will be visible.
 
bool ShowAcadSplashScreen [get, set]
 Controls whether the AutoCAD splash screen is displayed during startup.
 
string AdditionalAcadCommandline [get, set]
 Additional arguments to use when starting acad.exe.
 
static string PipeBaseAddress [get]
 

Detailed Description

Controls how ThermalDesktop object connects to its actual TD instance when ThermalDesktop.Connect() is called.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

Member Enumeration Documentation

◆ Types

enum OpenTD.TdConnectConfig.Types

Determines whether ThermalDesktop will start a new instance of TD, attach to an existing instance, or automatically try to attach but revert to starting a new instance if attaching fails. There's also an INPROCESS option that is only used internally by TD.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()
Enumerator
START_NEW_TD 
AUTO 
ATTACH_TO_TD 
INPROCESS 

Constructor & Destructor Documentation

◆ TdConnectConfig()

OpenTD.TdConnectConfig.TdConnectConfig ( )
inline

Member Function Documentation

◆ GetRepeatableNameFromPath()

static string OpenTD.TdConnectConfig.GetRepeatableNameFromPath ( string pathname,
bool calledFromServer = false )
inlinestatic

◆ Validate()

void OpenTD.TdConnectConfig.Validate ( )
inline

Validates this instance of TdConnectConfig. Is called automatically by ThermalDesktop.Connect().

Exceptions
OpenTD.OpenTDExceptionType ATTACH_TO_TD requires either a valid PipeEndpointName or DwgPathname. or Could not find DwgPathname: " + DwgPathname </exception> <seealso cref="OpenTD.ThermalDesktop"/> <seealso cref="OpenTD.ThermalDesktop.Connect()"/>

Property Documentation

◆ AcadExePathname

RootedPathname OpenTD.TdConnectConfig.AcadExePathname
getset

Normally ThermalDesktop.Connect() uses the latest version of AutoCAD it finds on your machine. Set AcadExePathname to the location of another acad.exe to force it to use that version of AutoCAD. Caution: some older versions of AutoCAD may not work with OpenTD.

The acad executable pathname.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

◆ AcadVisible

bool OpenTD.TdConnectConfig.AcadVisible
getset

Controls whether a newly-started instance of TD will be visible.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

◆ AdditionalAcadCommandline

string OpenTD.TdConnectConfig.AdditionalAcadCommandline
getset

Additional arguments to use when starting acad.exe.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

◆ DwgPathname

RootedPathname OpenTD.TdConnectConfig.DwgPathname
getset

Path to dwg file to open or attach to if already opened. If left blank and TdConnectConfig.Type allows it, ThermalDesktop.Connect() will start a new, blank drawing. Do not use this member to find the current dwg name. Instead, use ThermalDesktop.GetCurrentDwgPathname().

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect(), OpenTD.ThermalDesktop.GetCurrentDwgPathname()

///

◆ PipeBaseAddress

string OpenTD.TdConnectConfig.PipeBaseAddress
staticget

◆ PipeEndpointName

string OpenTD.TdConnectConfig.PipeEndpointName
getset

Advanced. If not blank, specifies the name of the communications channel used by OpenTD to communicate with this instance of TD. If starting a new TD instance, OpenTD will attempt to create a channel with this name. If attaching, OpenTD will attempt to connect to a channel with this name. Leave blank for automatic channel-naming. To open a named channel in TD, use the 'RcOpenTD' AutoCAD command.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

◆ PipeEndpointNameUsed

string OpenTD.TdConnectConfig.PipeEndpointNameUsed
get

Gets the communication channel name actually used. Set when ThermalDesktop.Connect() is called successfully.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

◆ ShowAcadSplashScreen

bool OpenTD.TdConnectConfig.ShowAcadSplashScreen
getset

Controls whether the AutoCAD splash screen is displayed during startup.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

◆ StartDirectory

string OpenTD.TdConnectConfig.StartDirectory
getset

The starting directory for the acad.exe process. For the current working directory, see ThermalDesktop.GetCurrentWorkingDirectory().

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect(), OpenTD.ThermalDesktop.GetCurrentWorkingDirectory()

///

◆ StartTimeout

TimeoutProperties OpenTD.TdConnectConfig.StartTimeout
getset

Controls how long OpenTD will try to connect to TD before timing out.

See also
OpenTD.ThermalDesktop, OpenTD.ThermalDesktop.Connect()

◆ Type

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

Connect with Ansys