Interface PHXDATAHISTORYLib::IDHVariable

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1020)

An object which represents a single Variable's meta-data within the Data History.

Members

• copyFrom
• enumAliases
• enumValues
• equation
• fileName
• format
• geomScript
• getEnumAlias
• getEnumValue
• getMetaData
• getNumEnumAliases
• getNumEnumValues
• isBinary
• isDesignVar
• isInput
• isNumeric
• lowerBound
• name
• removeMetadata
• SAFEARRAY
• setMetaData
• type
• units
• upperBound

Properties

Property name

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::name

The Variable name. May be a long, human readable string for Design Variables.

Return type: BSTR

Property equation

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::equation

The equation for this Variable. This is typically only set for Design Variables and can be an actual equation of multiple Variables.

Return type: BSTR

Property isDesignVar

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

boolean PHXDATAHISTORYLib::IDHVariable::isDesignVar

Whether this Variable represents one of the Design Variables for the Trade Study that was run.

Return type: boolean

Property isNumeric

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

boolean PHXDATAHISTORYLib::IDHVariable::isNumeric

Whether this Variable is numeric.

Return type: boolean

Property isInput

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

boolean PHXDATAHISTORYLib::IDHVariable::isInput

Whether this Variable is an input (can be set in ModelCenter). Input Variables with links to them become outputs (cannot be set).

Return type: boolean

Property format

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::format

The print format for this Variable.

Return type: BSTR

Property enumValues

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::enumValues

The enumerated values for this Variable. String is a comma separated list which may optionally include double quotes around each element.

Return type: BSTR

Property enumAliases

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::enumAliases

The enumerated aliases for this Variable. String is a comma separated list which may optionally include double quotes around each element.

Return type: BSTR

Property lowerBound

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

VARIANT PHXDATAHISTORYLib::IDHVariable::lowerBound

The lower bound for this Variable.

Return type: VARIANT

Property upperBound

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

VARIANT PHXDATAHISTORYLib::IDHVariable::upperBound

The upper bound of this Variable.

Return type: VARIANT

Property type

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::type

The type of Variable.

Return type: BSTR

Property units

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::units

The units for this Variable.

Return type: BSTR

Property geomScript

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::geomScript

For a Geometry File Variable, the geometry script associated with the Variable.

Return type: BSTR

Property isBinary

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

boolean PHXDATAHISTORYLib::IDHVariable::isBinary

Whether this Variable, if it is a File Variable, represents a binary file.

Return type: boolean

Property fileName

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)

BSTR PHXDATAHISTORYLib::IDHVariable::fileName

For a File Variable, the name of the file that this File Variable points to.

Return type: BSTR

Public functions

Function getNumEnumValues

long PHXDATAHISTORYLib::IDHVariable::getNumEnumValues()

Gets the number of enumerated values for this Variable. Returns:

The number of enumerated values for this variable.

Return type: long

Function getEnumValue

BSTR PHXDATAHISTORYLib::IDHVariable::getEnumValue(long index)

Returns a particular enumerated value. It is preferred that you use this method as opposed to parsing the enumValues property yourself so that all tools will use the same logic for parsing.

Parameters:

• index: The 0 based index of the enumerated value to get.

Returns:

The enumerated value.

Parameters:

• long index

Return type: BSTR

Function getEnumAlias

BSTR PHXDATAHISTORYLib::IDHVariable::getEnumAlias(long index)

Returns a particular enumerated alias. It is preferred that you use this method as opposed to parsing the enumAliases property yourself so that all tools will use the same logic for parsing.

Parameters:

• index: The 0 based index of the enumerated alias to get.

Returns:

The particular enumerated alias.

Parameters:

• long index

Return type: BSTR

Function getNumEnumAliases

long PHXDATAHISTORYLib::IDHVariable::getNumEnumAliases()

Gets the number of enumerated aliases for this Variable. Returns:

The number of enumerated aliases.

Return type: long

Function setMetaData

void PHXDATAHISTORYLib::IDHVariable::setMetaData(BSTR key, BSTR value)

Sets the meta data value of the given meta data key name. It updates the value if the key already exists. Parameters:

• key: The name of the key.
• value: The new value for the meta data.

Parameters:

• BSTR key
• BSTR value

Return type: void

Function getMetaData

BSTR PHXDATAHISTORYLib::IDHVariable::getMetaData(BSTR key)

Gets the meta data value of the given meta data key name. Parameters:

• key: The name of the key.

Returns:

The value of the meta data of the key name.

Parameters:

• BSTR key

Return type: BSTR

Function SAFEARRAY

PHXDATAHISTORYLib::IDHVariable::SAFEARRAY(BSTR) getMetaDataKeys()

Gets a list of metadata keys stored in this variable.

Parameters:

• BSTR

Return type:

Function copyFrom

void PHXDATAHISTORYLib::IDHVariable::copyFrom(LPDISPATCH other)

Copies data from another IDHVariable.

Parameters:

• LPDISPATCH other

Return type: void

Function removeMetadata

void PHXDATAHISTORYLib::IDHVariable::removeMetadata(BSTR key)

Removes the meta data value of the given meta data key name. Parameters:

• key: The name of the key to remove

Parameters:

• BSTR key

Return type: void