Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.Results.Dataset.ItemIdentifierCollection Class Reference

Last update: 16.07.2025

Collection of ItemIdentifiers. More...

Inheritance diagram for OpenTD.Results.Dataset.ItemIdentifierCollection:
OpenTD.Results.Dataset.IAutoNameOpenTD.Results.Dataset.IAutoComment

Public Member Functions

 ItemIdentifierCollection (IEnumerable< ItemIdentifier > collection)
 
 ItemIdentifierCollection ()
 
 ItemIdentifierCollection (string domainName, ThermalDesktop td)
 Initializes a new instance of the ItemIdentifierCollection class with node names from a domain.
 
 ItemIdentifierCollection (DataTypes dataType, string submodelName, IDataset dataset)
 Initializes a new instance of the ItemIdentifierCollection class with entity names (conductors, nodes, lumps, etc.) from a DataSet.
 
 ItemIdentifierCollection (IEnumerable< string > dataItemNames)
 
 ItemIdentifierCollection (params string[] sindaNames)
 
override string ToString ()
 
void Add (ItemIdentifier item)
 
void Clear ()
 
bool Contains (ItemIdentifier item)
 
void CopyTo (ItemIdentifier[] array, int arrayIndex)
 
bool Remove (ItemIdentifier item)
 
IEnumerator< ItemIdentifier > GetEnumerator ()
 
int IndexOf (ItemIdentifier item)
 
void Insert (int index, ItemIdentifier item)
 
void RemoveAt (int index)
 
void AddRange (IEnumerable< ItemIdentifier > collection)
 
void InsertRange (int index, IEnumerable< ItemIdentifier > collection)
 
void RemoveRange (int index, int count)
 

Protected Member Functions

virtual string GetSelfSuggestedName ()
 
virtual string GetSelfSuggestedComment ()
 

Properties

ItemIdentifier.Types Type [get]
 If all the ItemIdentifiers in the collection have the same Type, this will equal that. Otherwise this will be NOT_SET.
 
string Submodel [get]
 If all the ItemIdentifiers in the collection have the same Submodel, this will equal that. Otherwise this will be null.
 
long Id [get]
 If all the ItemIdentifiers in the collection have the same Id, this will equal that. Otherwise this will be -1.
 
long RecordNum [get]
 If all the ItemRecordNumentifiers in the collection have the same RecordNum, this will equal that. Otherwise this will be -1.
 
string RegisterName [get]
 If all the ItemIdentifiers in the collection have the same RegisterName, this will equal that. Otherwise this will be null.
 
AutoNamer AutoNamer [get, set]
 
string Name [get, set]
 
string InternalSuggestedName [get, set]
 
AutoCommenter AutoCommenter [get, set]
 
string Comment [get, set]
 
string InternalSuggestedComment [get, set]
 
int Count [get]
 
bool IsReadOnly [get]
 
ItemIdentifier this[int index] [get, set]
 

Detailed Description

Collection of ItemIdentifiers.

Constructor & Destructor Documentation

◆ ItemIdentifierCollection() [1/6]

OpenTD.Results.Dataset.ItemIdentifierCollection.ItemIdentifierCollection ( IEnumerable< ItemIdentifier > collection)
inline

◆ ItemIdentifierCollection() [2/6]

OpenTD.Results.Dataset.ItemIdentifierCollection.ItemIdentifierCollection ( )
inline

◆ ItemIdentifierCollection() [3/6]

OpenTD.Results.Dataset.ItemIdentifierCollection.ItemIdentifierCollection ( string domainName,
ThermalDesktop td )
inline

Initializes a new instance of the ItemIdentifierCollection class with node names from a domain.

◆ ItemIdentifierCollection() [4/6]

OpenTD.Results.Dataset.ItemIdentifierCollection.ItemIdentifierCollection ( DataTypes dataType,
string submodelName,
IDataset dataset )
inline

Initializes a new instance of the ItemIdentifierCollection class with entity names (conductors, nodes, lumps, etc.) from a DataSet.

◆ ItemIdentifierCollection() [5/6]

OpenTD.Results.Dataset.ItemIdentifierCollection.ItemIdentifierCollection ( IEnumerable< string > dataItemNames)
inline

◆ ItemIdentifierCollection() [6/6]

OpenTD.Results.Dataset.ItemIdentifierCollection.ItemIdentifierCollection ( params string[] sindaNames)
inline

Member Function Documentation

◆ Add()

void OpenTD.Results.Dataset.ItemIdentifierCollection.Add ( ItemIdentifier item)
inline

◆ AddRange()

void OpenTD.Results.Dataset.ItemIdentifierCollection.AddRange ( IEnumerable< ItemIdentifier > collection)
inline

◆ Clear()

void OpenTD.Results.Dataset.ItemIdentifierCollection.Clear ( )
inline

◆ Contains()

bool OpenTD.Results.Dataset.ItemIdentifierCollection.Contains ( ItemIdentifier item)
inline

◆ CopyTo()

void OpenTD.Results.Dataset.ItemIdentifierCollection.CopyTo ( ItemIdentifier[] array,
int arrayIndex )
inline

◆ GetEnumerator()

IEnumerator< ItemIdentifier > OpenTD.Results.Dataset.ItemIdentifierCollection.GetEnumerator ( )
inline

◆ GetSelfSuggestedComment()

virtual string OpenTD.Results.Dataset.ItemIdentifierCollection.GetSelfSuggestedComment ( )
inlineprotectedvirtual

◆ GetSelfSuggestedName()

virtual string OpenTD.Results.Dataset.ItemIdentifierCollection.GetSelfSuggestedName ( )
inlineprotectedvirtual

◆ IndexOf()

int OpenTD.Results.Dataset.ItemIdentifierCollection.IndexOf ( ItemIdentifier item)
inline

◆ Insert()

void OpenTD.Results.Dataset.ItemIdentifierCollection.Insert ( int index,
ItemIdentifier item )
inline

◆ InsertRange()

void OpenTD.Results.Dataset.ItemIdentifierCollection.InsertRange ( int index,
IEnumerable< ItemIdentifier > collection )
inline

◆ Remove()

bool OpenTD.Results.Dataset.ItemIdentifierCollection.Remove ( ItemIdentifier item)
inline

◆ RemoveAt()

void OpenTD.Results.Dataset.ItemIdentifierCollection.RemoveAt ( int index)
inline

◆ RemoveRange()

void OpenTD.Results.Dataset.ItemIdentifierCollection.RemoveRange ( int index,
int count )
inline

◆ ToString()

override string OpenTD.Results.Dataset.ItemIdentifierCollection.ToString ( )
inline

Property Documentation

◆ AutoCommenter

AutoCommenter OpenTD.Results.Dataset.ItemIdentifierCollection.AutoCommenter
getsetprotected

◆ AutoNamer

AutoNamer OpenTD.Results.Dataset.ItemIdentifierCollection.AutoNamer
getsetprotected

◆ Comment

string OpenTD.Results.Dataset.ItemIdentifierCollection.Comment
getset

◆ Count

int OpenTD.Results.Dataset.ItemIdentifierCollection.Count
get

◆ Id

long OpenTD.Results.Dataset.ItemIdentifierCollection.Id
get

If all the ItemIdentifiers in the collection have the same Id, this will equal that. Otherwise this will be -1.

◆ InternalSuggestedComment

string OpenTD.Results.Dataset.ItemIdentifierCollection.InternalSuggestedComment
getset

◆ InternalSuggestedName

string OpenTD.Results.Dataset.ItemIdentifierCollection.InternalSuggestedName
getset

◆ IsReadOnly

bool OpenTD.Results.Dataset.ItemIdentifierCollection.IsReadOnly
get

◆ Name

string OpenTD.Results.Dataset.ItemIdentifierCollection.Name
getset

◆ RecordNum

long OpenTD.Results.Dataset.ItemIdentifierCollection.RecordNum
get

If all the ItemRecordNumentifiers in the collection have the same RecordNum, this will equal that. Otherwise this will be -1.

◆ RegisterName

string OpenTD.Results.Dataset.ItemIdentifierCollection.RegisterName
get

If all the ItemIdentifiers in the collection have the same RegisterName, this will equal that. Otherwise this will be null.

◆ Submodel

string OpenTD.Results.Dataset.ItemIdentifierCollection.Submodel
get

If all the ItemIdentifiers in the collection have the same Submodel, this will equal that. Otherwise this will be null.

◆ this[int index]

ItemIdentifier OpenTD.Results.Dataset.ItemIdentifierCollection.this[int index]
getset

◆ Type

ItemIdentifier.Types OpenTD.Results.Dataset.ItemIdentifierCollection.Type
get

If all the ItemIdentifiers in the collection have the same Type, this will equal that. Otherwise this will be NOT_SET.


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

Connect with Ansys