Interface ModelCenter::IDataMonitor

Definition: ModelCenter/src/ModelCenter.odl (line 6232)

COM Instance.

Members

• addItem
• addUnlinkedItem
• getAutoDelete
• getColWidth
• getDisplayFullNames
• getDisplayUnits
• getHeight
• getLink
• getName
• getTitle
• getWidth
• getX
• getY
• isRenamed
• isValid
• removeItem
• removeLink
• setAutoDelete
• setColWidth
• setDisplayFullNames
• setDisplayUnits
• setLink
• setLocation
• setName
• setSize
• setTitle

Public functions

Function getName

BSTR ModelCenter::IDataMonitor::getName(long row)

Retrieves the name associated a given row in the Data Monitor.

Parameters:

• row: The row number in the Data Monitor of interest (0-based index).

Returns:

The name of the row.

Parameters:

• long row

Return type: BSTR

Function setName

void ModelCenter::IDataMonitor::setName(long row, BSTR name)

Sets the display name of the specified row in the Data Monitor.

Parameters:

• row: The row in the Data Monitor of interest (0-based index).
• name: The new display name.

Parameters:

• long row
• BSTR name

Return type: void

Function isRenamed

boolean ModelCenter::IDataMonitor::isRenamed(long row)

Determines whether the name of a row in the Data Monitor lines up to the ModelCenter variable it represents.

Parameters:

• row: The row in the Data Monitor of interest (0-based index).

Returns:

true or false

Parameters:

• long row

Return type: boolean

Function getLink

BSTR ModelCenter::IDataMonitor::getLink(long row)

Retrieves the ModelCenter variable associated with a given row in the Data Monitor. Returns a blank string if the specified row doesn't link to a ModelCenter variable.

Parameters:

• row: The row number in the Data Monitor of interest (0-based index).

Returns:

Parameters:

• long row

Return type: BSTR

Function setLink

boolean ModelCenter::IDataMonitor::setLink(long row, BSTR link)

Sets the ModelCenter variable associated with a given row in the Data Monitor.

Parameters:

• row: The row in the Data Monitor of interest (0-based index).
• link: The ModelCenter variable to associate with a given row in the Data Monitor.

Returns:

Parameters:

• long row
• BSTR link

Return type: boolean

Function addItem

int ModelCenter::IDataMonitor::addItem(BSTR name, BSTR link)

Add an item to the Data Monitor that links to a variable in the model.

Parameters:

• name: The name to use for the item in the Data Monitor.
• link: The name of the ModelCenter variable this item links to.

Returns:

Parameters:

• BSTR name
• BSTR link

Return type: int

Function addUnlinkedItem

int ModelCenter::IDataMonitor::addUnlinkedItem(BSTR name)

Add an item to the Data Monitor that does not link to a variable within ModelCenter.

Parameters:

• name: The name to use for the item in the Data Monitor.

Returns:

Parameters:

• BSTR name

Return type: int

Function removeItem

void ModelCenter::IDataMonitor::removeItem(long row)

Removes the selected row from the Data Monitor.

Parameters:

• row: The row in the Data Monitor of interest (0-based index).

Parameters:

• long row

Return type: void

Function removeLink

void ModelCenter::IDataMonitor::removeLink(long row)

Removes the associated link from the row specified in the Data Monitor.

Parameters:

• row: The row in the Data Monitor of interest (0-based index).

Parameters:

• long row

Return type: void

Function getDisplayFullNames

boolean ModelCenter::IDataMonitor::getDisplayFullNames()

Get the status of the "Display Full Names" option.

Returns:

true or false

Return type: boolean

Function setDisplayFullNames

void ModelCenter::IDataMonitor::setDisplayFullNames(boolean)

Sets the "Display Full Names" option.

Parameters:

• boolean

Return type: void

Function getAutoDelete

boolean ModelCenter::IDataMonitor::getAutoDelete()

Gets the status of the Auto Delete option.

Returns:

true or false

Return type: boolean

Function setAutoDelete

void ModelCenter::IDataMonitor::setAutoDelete(boolean)

Sets the status of the Auto Delete option.

Parameters:

• boolean

Return type: void

Function getDisplayUnits

boolean ModelCenter::IDataMonitor::getDisplayUnits()

Get the status of the "Display Units" option.

Returns:

true or false

Return type: boolean

Function setDisplayUnits

void ModelCenter::IDataMonitor::setDisplayUnits(boolean)

Sets the "Display Units" option.

Parameters:

• boolean

Return type: void

Function getColWidth

int ModelCenter::IDataMonitor::getColWidth(long col)

Gets the column width for the specified column.

Parameters:

• col: The column number to fetch the width of (0-based index).

Returns:

The column width.

Parameters:

• long col

Return type: int

Function setColWidth

void ModelCenter::IDataMonitor::setColWidth(long col, int width)

Sets the width of the specified column.

Parameters:

• col: The column in the Data Monitor of interest (0-based index).
• width: The new width for the column.

Parameters:

• long col
• int width

Return type: void

Function isValid

boolean ModelCenter::IDataMonitor::isValid()

Determines whether all the items in the Data Monitor are valid or not.

Returns:

Yes (TRUE) or no (FALSE).

Return type: boolean

Function getTitle

BSTR ModelCenter::IDataMonitor::getTitle()

Gets the title of the Data Monitor.

Returns:

The title of the Data Monitor.

Return type: BSTR

Function setTitle

void ModelCenter::IDataMonitor::setTitle(BSTR title)

Sets the title of the Data Monitor.

Parameters:

• title: The new title of the Data Monitor.

Parameters:

• BSTR title

Return type: void

Function getWidth

int ModelCenter::IDataMonitor::getWidth()

Gets the width of the Data Monitor.

Returns:

The width of the Data Monitor.

Return type: int

Function getHeight

int ModelCenter::IDataMonitor::getHeight()

Get the height of the Data Monitor.

Returns:

The height of the Data Monitor.

Return type: int

Function setSize

void ModelCenter::IDataMonitor::setSize(int width, int height)

Sets the height and width of the Data Monitor.

Parameters:

• width: The new width for the Data Monitor.
• height: The new height of the Data Monitor.

Parameters:

• int width
• int height

Return type: void

Function getX

int ModelCenter::IDataMonitor::getX()

Gets the X position of the Data Monitor.

Returns:

The value of the X position of the Data Monitor.

Return type: int

Function getY

int ModelCenter::IDataMonitor::getY()

Gets the Y position of the Data Monitor.

Returns:

The value of the Y position of the Data Monitor.

Return type: int

Function setLocation

void ModelCenter::IDataMonitor::setLocation(int x, int y)

Sets the x and y location of the Data Monitor in the Analysis View.

Parameters:

• x: The new x position.
• y: The new y position.

Parameters:

• int x
• int y

Return type: void