Interface ModelCenter::IComponent

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

COM Instance.

Inherited by:

• ModelCenter::IIfComponent
• ModelCenter::IScriptComponent

Members

• AssociatedFiles
• downloadValues
• getFullName
• getMetadata
• getName
• getPositionX
• getPositionY
• getSource
• getType
• getVariable
• Groups
• IndexInParent
• invalidate
• invokeMethod
• ParentAssembly
• reconnect
• rename
• run
• setMetadata
• show
• userData
• Variables

Properties

Property Variables

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

VARIANT ModelCenter::IComponent::Variables

Pointer to the variables in the Component.

Returns:

IDispatch* to an IVariables object.

Return type: VARIANT

Property Groups

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

VARIANT ModelCenter::IComponent::Groups

Pointer to the Groups in the Component.

Returns:

IDispatch* to an IGroups object.

Return type: VARIANT

Property userData

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

VARIANT ModelCenter::IComponent::userData

An arbitrary Variant which is not used internally by ModelCenter but can store data for programmatic purposes. Value is not stored across file save/load.

Return type: VARIANT

Property AssociatedFiles

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

VARIANT ModelCenter::IComponent::AssociatedFiles

A set of files associated with the Component.

Returns:

Variant containing the list of associated files (string or array of strings)

Return type: VARIANT

Property IndexInParent

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

int ModelCenter::IComponent::IndexInParent

Position of this component in the parent Assembly.

Return type: int

Property ParentAssembly

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

LPDISPATCH ModelCenter::IComponent::ParentAssembly

Parent assembly to this component.

Returns:

IDispatch* to an IAssembly object.

Return type: LPDISPATCH

Public functions

Function getName

BSTR ModelCenter::IComponent::getName()

Gets the name of the Component.

Returns:

The name of the Component.

Return type: BSTR

Reimplemented by:

• getName
• getName

Function getFullName

BSTR ModelCenter::IComponent::getFullName()

Gets the full ModelCenter path of the Component.

Returns:

the full ModelCenter path of the Component.

Return type: BSTR

Reimplemented by:

• getFullName
• getFullName

Function run

void ModelCenter::IComponent::run()

Runs the Component.

Return type: void

Reimplemented by:

• run
• run

Function getSource

BSTR ModelCenter::IComponent::getSource()

Gets the source of the Component.

Returns:

The source of the Component.

Return type: BSTR

Reimplemented by:

• getSource
• getSource

Function invokeMethod

void ModelCenter::IComponent::invokeMethod(BSTR method)

Invokes one of the Component's methods.

Parameters:

• method: The name of the method to invoke.

Parameters:

• BSTR method

Return type: void

Reimplemented by:

• invokeMethod
• invokeMethod

Function invalidate

void ModelCenter::IComponent::invalidate()

Invalidates the Component and all of its variables.

Return type: void

Reimplemented by:

• invalidate
• invalidate

Function reconnect

void ModelCenter::IComponent::reconnect()

Reconnect a Component.

Return type: void

Reimplemented by:

• reconnect
• reconnect

Function downloadValues

void ModelCenter::IComponent::downloadValues()

Downloads the component's variable values from ModelCenter Remote Execution, if it's a MCRE component.

Return type: void

Reimplemented by:

• downloadValues
• downloadValues

Function getVariable

LPDISPATCH ModelCenter::IComponent::getVariable(BSTR name)

Gets the Variable by the specified name.

Parameters:

• name: The name of the variable to retrieve in dotted notation relative to the Component.

Returns:

IDispatch* to an IVariable object.

Parameters:

• BSTR name

Return type: LPDISPATCH

Reimplemented by:

• getVariable
• getVariable

Function rename

void ModelCenter::IComponent::rename(BSTR name)

Renames the current Component.

Parameters:

• name: New name of the Component.

Parameters:

• BSTR name

Return type: void

Reimplemented by:

• rename
• rename

Function getType

BSTR ModelCenter::IComponent::getType()

Gets the type of the component. Valid types include:

• Component

• Assembly

• Sequence

• If

• Parallel

• Empty

• ForEach

Returns:

The type of the component.

Return type: BSTR

Reimplemented by:

• getType
• getType

Function show

void ModelCenter::IComponent::show()

Show the GUI form associated with the component, if any.

Return type: void

Reimplemented by:

• show
• show

Function setMetadata

void ModelCenter::IComponent::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive)

Sets the meta data value of the given meta data key name.

Parameters:

• name: Metadata specifier used to store the data.
• type:
  
• value:
  
• access:
  
• archive:
  

Parameters:

• BSTR name
• MetadataType type
• VARIANT value
• MetadataAccess access
• boolean archive

Return type: void

Function getMetadata

VARIANT ModelCenter::IComponent::getMetadata(BSTR name)

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

Parameters:

• name: Metadata key name.

Returns:

Metadata value.

Parameters:

• BSTR name

Return type: VARIANT

Private functions

Function getPositionX

int ModelCenter::IComponent::getPositionX()

Return type: int

Reimplemented by:

• getPositionX
• getPositionX

Function getPositionY

int ModelCenter::IComponent::getPositionY()

Return type: int

Reimplemented by:

• getPositionY
• getPositionY