Client-side representation of a dataset (solution results) in a TD instance. More...

Inheritance diagram for OpenTD.PostProcessing.Dataset:

Public Types
enum	DataSourceTypes { RAD , SF , TEXT , HR , TEXTTRANSIENT , COMPARER , HEAT_FLOW , HEAT_FLOW_MAP_PP }

enum	PlotMliNodes { SUBSTRATE_ONLY , OUTERMOST_NODES , MLI_TOP_SUBSTRATE_BOT , SUBSTRATE_TOP_MLI_BOT , MLI_ONLY_ELSE_GREY }

Public Member Functions
	Dataset ()

bool	TrySetCurrentTimeIndex (double time, double percentTolerance=1.0)
	Use this to indirectly set CurrentTimeIndex by specifying a time in the current WorkingUnits. Returns true if able to find a time in Times within the percent tolerance specified (defaults to 1%).

override void	Update ()
	Updates the TD entity with the latest client data.

override void	UpdateFromTD ()
	Updates the client-side instance with the latest data from the TD entity.

override void	CreateIn (ThermalDesktop td)
	Creates the TD entity in the specified TD instance.

void	SetCurrent ()

void	ShowContourPlot ()

override string	ToString ()

virtual void	Rename (string to)
	Use this method to rename the client-side object and the TD item it is linked to.

void	SetFrom (OpenTDObject x)

void	UpdateIn (ThermalDesktop td)
	Updates the TD entity corresponding to this object in the specified TD instance, if possible.

Protected Member Functions
override void	ProxyRename (string from, string to)

virtual string	ModifyName (string name)

Protected Attributes
ITdCommander	TdProxy

Properties
string	Comment `[get, set]`

DataSourceTypes	SourceType `[get, set]`
	Read only. The type of dataset. For example, SF for Sinda results.

DimensionalList< Time >	Times `[get, set]`
	Read only. Time values associated with each timestep/record in the dataset, in the current WorkingUnits.

int	CurrentTimeIndex `[get, set]`
	Set this to choose what timestep/record will be displayed when post-processed.

PlotMliNodes	PlotMLINodes `[get, set]`

int	SmartColorBarCycle `[get, set]`

int	UseOrbit `[get, set]`

string	OrbitName `[get, set]`

Dimensional< Time >	OffsetTime `[get, set]`

ExpressionData	OffsetTimeExp `[get, set]`

AdditionalDatasetInfoHolder	AdditionalInfo `[get, set]`
	Type-specific information about the dataset.

string	Pathname `[get]`

string	Name `[get]`
	This object is uniquely-identified by this name.

string	_n `[get, set]`
	Do not use.

Detailed Description

Client-side representation of a dataset (solution results) in a TD instance.

Member Enumeration Documentation

◆ DataSourceTypes

enum OpenTD.PostProcessing.Dataset.DataSourceTypes

Enumerator
RAD
SF
TEXT
HR
TEXTTRANSIENT
COMPARER
HEAT_FLOW
HEAT_FLOW_MAP_PP

◆ PlotMliNodes

enum OpenTD.PostProcessing.Dataset.PlotMliNodes

Enumerator
SUBSTRATE_ONLY
OUTERMOST_NODES
MLI_TOP_SUBSTRATE_BOT
SUBSTRATE_TOP_MLI_BOT
MLI_ONLY_ELSE_GREY

Constructor & Destructor Documentation

◆ Dataset()

OpenTD.PostProcessing.Dataset.Dataset ( )

inline

Member Function Documentation

◆ CreateIn()

override void OpenTD.PostProcessing.Dataset.CreateIn ( ThermalDesktop td )

inline

Creates the TD entity in the specified TD instance.

Implements OpenTD.IReassignable.

◆ ModifyName()

virtual string OpenTD.UniqueNameObject.ModifyName ( string name )

inlineprotectedvirtualinherited

Reimplemented in OpenTD.SubmodelData.

◆ ProxyRename()

override void OpenTD.PostProcessing.Dataset.ProxyRename	(	string	from,
		string	to )

inlineprotected

◆ Rename()

virtual void OpenTD.UniqueNameObject.Rename ( string to )

inlinevirtualinherited

Use this method to rename the client-side object and the TD item it is linked to.

◆ SetCurrent()

void OpenTD.PostProcessing.Dataset.SetCurrent ( )

inline

◆ SetFrom()

void OpenTD.OpenTDObject.SetFrom ( OpenTDObject x )

inlineinherited

◆ ShowContourPlot()

void OpenTD.PostProcessing.Dataset.ShowContourPlot ( )

inline

◆ ToString()

override string OpenTD.PostProcessing.Dataset.ToString ( )

inline

◆ TrySetCurrentTimeIndex()

bool OpenTD.PostProcessing.Dataset.TrySetCurrentTimeIndex	(	double	time,
		double	percentTolerance = 1::0 )

inline

Use this to indirectly set CurrentTimeIndex by specifying a time in the current WorkingUnits. Returns true if able to find a time in Times within the percent tolerance specified (defaults to 1%).

Parameters

time
percentTolerance

Returns

◆ Update()

override void OpenTD.PostProcessing.Dataset.Update ( )

inline

Updates the TD entity with the latest client data.

Implements OpenTD.IUpdatable.

◆ UpdateFromTD()

override void OpenTD.PostProcessing.Dataset.UpdateFromTD ( )

inline

Updates the client-side instance with the latest data from the TD entity.

Implements OpenTD.IUpdatable.

◆ UpdateIn()

void OpenTD.OpenTDObject.UpdateIn ( ThermalDesktop td )

inlineinherited

Updates the TD entity corresponding to this object in the specified TD instance, if possible.

Implements OpenTD.IReassignable.

Member Data Documentation

◆ TdProxy

ITdCommander OpenTD.OpenTDObject.TdProxy

protectedinherited

Property Documentation

◆ _n

string OpenTD.UniqueNameObject._n

getsetinherited

Do not use.

◆ AdditionalInfo

AdditionalDatasetInfoHolder OpenTD.PostProcessing.Dataset.AdditionalInfo

getset

Type-specific information about the dataset.

◆ Comment

string OpenTD.PostProcessing.Dataset.Comment

getset

◆ CurrentTimeIndex

int OpenTD.PostProcessing.Dataset.CurrentTimeIndex

getset

Set this to choose what timestep/record will be displayed when post-processed.

◆ Name

string OpenTD.UniqueNameObject.Name

getinherited

This object is uniquely-identified by this name.

◆ OffsetTime

Dimensional<Time> OpenTD.PostProcessing.Dataset.OffsetTime

getset

◆ OffsetTimeExp

ExpressionData OpenTD.PostProcessing.Dataset.OffsetTimeExp

getset

◆ OrbitName

string OpenTD.PostProcessing.Dataset.OrbitName

getset

◆ Pathname

string OpenTD.PostProcessing.Dataset.Pathname

get

◆ PlotMLINodes

PlotMliNodes OpenTD.PostProcessing.Dataset.PlotMLINodes

getset

◆ SmartColorBarCycle

int OpenTD.PostProcessing.Dataset.SmartColorBarCycle

getset

◆ SourceType

DataSourceTypes OpenTD.PostProcessing.Dataset.SourceType

getset

Read only. The type of dataset. For example, SF for Sinda results.

◆ Times

DimensionalList<Time> OpenTD.PostProcessing.Dataset.Times

getset

Read only. Time values associated with each timestep/record in the dataset, in the current WorkingUnits.

◆ UseOrbit

int OpenTD.PostProcessing.Dataset.UseOrbit

getset

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

C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/OpenTD/OpenTD/PostProcessing/Dataset.cs

OpenTD.PostProcessing.Dataset Class Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ DataSourceTypes

◆ PlotMliNodes

Constructor & Destructor Documentation

◆ Dataset()

Member Function Documentation

◆ CreateIn()

◆ ModifyName()

◆ ProxyRename()

◆ Rename()

◆ SetCurrent()

◆ SetFrom()

◆ ShowContourPlot()

◆ ToString()

◆ TrySetCurrentTimeIndex()

◆ Update()

◆ UpdateFromTD()

◆ UpdateIn()

Member Data Documentation

◆ TdProxy

Property Documentation

◆ _n

◆ AdditionalInfo

◆ Comment

◆ CurrentTimeIndex

◆ Name

◆ OffsetTime

◆ OffsetTimeExp

◆ OrbitName

◆ Pathname

◆ PlotMLINodes

◆ SmartColorBarCycle

◆ SourceType

◆ Times

◆ UseOrbit

Connect with Ansys