Public Member Functions | List of all members
DataSetList Class Reference

DataSetList class is used to specify multiple tables.
The class can be called from Material class.
. More...

Public Member Functions

String GetName ()
 Returns the name of the dataset list (multiple tables) as a string. More...
 
DataSetGetTable (int index)
 Returns the table with the specified index as a dataset. More...
 
virtual bool IsValid ()
 Returns True if an object is valid. More...
 
int NumTable ()
 Returns the number of tables in the dataset list (multiple tables). More...
 
void SetName (String &name)
 Specifies the name for the dataset list (multiple tables). More...
 
void SetTable (double primaryKey, String &primaryUnitName, String array &mat)
 Specifies a point sequence for the multidimensional array of the specified primary key in the dataset list (multiple tables). More...
 
void SetTableWithDualKey (double primaryKey, String &primaryUnitName, double secondaryKey, String &secondaryUnitName, String array &mat)
 Specifies a point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple tables). More...
 

Detailed Description

DataSetList class is used to specify multiple tables.
The class can be called from Material class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetMaterial(0).GetTableList("TemperatureBhTable")

Member Function Documentation

String DataSetList::GetName ( )

Returns the name of the dataset list (multiple tables) as a string.

Returns
Name of the table in the data set list
DataSet * DataSetList::GetTable ( int  index)

Returns the table with the specified index as a dataset.

Parameters
indexIndex of the table
Returns
DataSet object
bool DataSetList::IsValid ( )
virtual

Returns True if an object is valid.

Returns
Whether or not the DataSetList objects in the list are valid
int DataSetList::NumTable ( )

Returns the number of tables in the dataset list (multiple tables).

Returns
Number of tables in the dataset list
void DataSetList::SetName ( String &  name)

Specifies the name for the dataset list (multiple tables).

Parameters
nameDataSet list name
void DataSetList::SetTable ( double  primaryKey,
String &  primaryUnitName,
String array &  mat 
)

Specifies a point sequence for the multidimensional array of the specified primary key in the dataset list (multiple tables).

Parameters
primaryKeyValue of the primary key
primaryUnitNameUnit name of the primary key
matMultidimensional array
void DataSetList::SetTableWithDualKey ( double  primaryKey,
String &  primaryUnitName,
double  secondaryKey,
String &  secondaryUnitName,
String array &  mat 
)

Specifies a point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple tables).

Parameters
primaryKeyValue of the primary key
primaryUnitNameUnit name of the secondary key
secondaryKeyValue of the primary key
secondaryUnitNameUnit name of the secondary key
matMultidimensional array