NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::GeneralScalarTable Class Reference

Represents a General M x N table of scalar (real) values. More...

Inheritance diagram for NXOpen::GeneralScalarTable:
NXOpen::TransientObject NXOpen::ScalarMatrixValue NXOpen::ScalarTableValue

Public Member Functions

double GetCellValue (int iRow, int iCol)
 Returns the cell value. More...
 
std::vector< double > GetNthColumn (int iCol)
 Returns the entire Nth column of values. More...
 
NXOpen::UnitGetNthColumnUnits (int iCol)
 Returns the entire Nth column of values. More...
 
std::vector< double > GetNthRow (int iRow)
 Returns the entire Nth row of values. More...
 
int NumCols ()
 Returns the numuber of columns
Created in NX6.0.0. More...
 
int NumRows ()
 Returns the number of rows
Created in NX6.0.0. More...
 
void SetCellNoValue (int iRow, int iCol)
 Sets cell as having no value
Created in NX11.0.0. More...
 
void SetCellValue (int iRow, int iCol, double cellValue)
 Sets cell value
Created in NX6.0.0. More...
 
void SetCellValue (int iRow, int iCol, int cellValue)
 Sets cell value
Created in NX10.0.0. More...
 
void SetNthColumn (int iCol, const std::vector< double > &columnValues)
 Sets the entire Nth column of values. More...
 
void SetNthColumnUnits (int iCol, NXOpen::Unit *unitType)
 Sets the entire Nth column of values. More...
 
void SetNthRow (int iRow, const std::vector< double > &rowValues)
 Sets the entire Nth row of values. More...
 
void SetNumberOfRows (int nRows, double dDefaultValue)
 Sets the number of rows
Created in NX10.0.0. More...
 
void SetTableSize (int nRows, int nCols, double dDefaultValue)
 Sets the table size
Created in NX6.0.0. More...
 
virtual ~GeneralScalarTable ()
 Destroys the object
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents a General M x N table of scalar (real) values.


This is an abstract class

Created in NX6.0.0.

Constructor & Destructor Documentation

virtual NXOpen::GeneralScalarTable::~GeneralScalarTable ( )
virtual

Destroys the object
Created in NX6.0.0.



License requirements : None

Member Function Documentation

double NXOpen::GeneralScalarTable::GetCellValue ( int  iRow,
int  iCol 
)

Returns the cell value.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
iRowRow Index
iColColumn Index
std::vector<double> NXOpen::GeneralScalarTable::GetNthColumn ( int  iCol)

Returns the entire Nth column of values.

Output array will be as long as the number of rows GeneralScalarTable::NumRows

Returns
Column Values
Created in NX6.0.0.

License requirements : None
Parameters
iColColumn Index
NXOpen::Unit* NXOpen::GeneralScalarTable::GetNthColumnUnits ( int  iCol)

Returns the entire Nth column of values.

Output array will be as long as the number of rows GeneralScalarTable::NumRows

Returns
Unit type for the column NULL if the Column has no units
Created in NX6.0.0.

License requirements : None
Parameters
iColColumn Index
std::vector<double> NXOpen::GeneralScalarTable::GetNthRow ( int  iRow)

Returns the entire Nth row of values.

Output array will be as long as the number of columns GeneralScalarTable::NumCols

Returns
Row Values
Created in NX6.0.0.

License requirements : None
Parameters
iRowRow Index
int NXOpen::GeneralScalarTable::NumCols ( )

Returns the numuber of columns
Created in NX6.0.0.



License requirements : None

int NXOpen::GeneralScalarTable::NumRows ( )

Returns the number of rows
Created in NX6.0.0.



License requirements : None

void NXOpen::GeneralScalarTable::SetCellNoValue ( int  iRow,
int  iCol 
)

Sets cell as having no value
Created in NX11.0.0.



License requirements : None

Parameters
iRowRow Index
iColColumn Index
void NXOpen::GeneralScalarTable::SetCellValue ( int  iRow,
int  iCol,
double  cellValue 
)

Sets cell value
Created in NX6.0.0.



License requirements : None

Parameters
iRowRow Index
iColColumn Index
cellValueValue to store in the cell
void NXOpen::GeneralScalarTable::SetCellValue ( int  iRow,
int  iCol,
int  cellValue 
)

Sets cell value
Created in NX10.0.0.



License requirements : None

Parameters
iRowRow Index
iColColumn Index
cellValueValue to store in the cell
void NXOpen::GeneralScalarTable::SetNthColumn ( int  iCol,
const std::vector< double > &  columnValues 
)

Sets the entire Nth column of values.

Input array must be as long as the number of rows GeneralScalarTable::NumRows
Created in NX6.0.0.

License requirements : None

Parameters
iColColumn Index
columnValuesColumn values
void NXOpen::GeneralScalarTable::SetNthColumnUnits ( int  iCol,
NXOpen::Unit unitType 
)

Sets the entire Nth column of values.

Input array must be as long as the number of rows GeneralScalarTable::NumRows
Created in NX6.0.0.

License requirements : None

Parameters
iColColumn Index
unitTypeUnit type for the column
void NXOpen::GeneralScalarTable::SetNthRow ( int  iRow,
const std::vector< double > &  rowValues 
)

Sets the entire Nth row of values.

Input array must be as long as the number of columns GeneralScalarTable::NumCols
Created in NX6.0.0.

License requirements : None

Parameters
iRowRow Index
rowValuesRow Values
void NXOpen::GeneralScalarTable::SetNumberOfRows ( int  nRows,
double  dDefaultValue 
)

Sets the number of rows
Created in NX10.0.0.



License requirements : None

Parameters
nRowsNumber of Rows
dDefaultValueDefault Value
void NXOpen::GeneralScalarTable::SetTableSize ( int  nRows,
int  nCols,
double  dDefaultValue 
)

Sets the table size
Created in NX6.0.0.



License requirements : None

Parameters
nRowsNumber of Rows
nColsNumber of Columns
dDefaultValueDefault Value

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.