com.altair.hwm.beans.hm
Class HMComponentComm

java.lang.Object
  com.altair.hwm.beans.hm.HMComponentComm

public class HMComponentComm
extends java.lang.Object

Title: HMComponentComm

Description: Provides creating, copying, deleting, moving, show and hide component collectors

Company: Altair Engineering, Inc.

Constructor Summary

HMComponentComm(HWMCommMgr hwmCommMgr)
Constructor

Method Summary

void	CopyToComponent(java.lang.String strSessionName, java.lang.String strComponentName, java.lang.String strEntityType, java.lang.String strSelectionType) Sends a command to HM asking it to copy components to a component collector
void	CreateComponent(java.lang.String strSessionName, java.lang.String strComponentName) Sends a command to HM asking it to create a component collector with the given name
void	DeleteComponent(java.lang.String strSessionName, java.lang.String strComponentName) Sends a command to HM asking it to delete a component collector with given name
java.util.Vector	GetAllComponents(java.lang.String strSessionName) Get list of all components present in the model
void	HideAllComponents(java.lang.String strSessionName) Hide display of all components in HM
void	HideComponent(java.lang.String strSessionName, java.lang.String strComponentName) Show display of the specified component in HM
void	MoveToComponent(java.lang.String strSessionName, java.lang.String strComponentName, java.lang.String strEntityType, java.lang.String strSelectionType) Sends a command to HM asking it to move components to a component collector
void	ShowAllComponents(java.lang.String strSessionName) Show display of all compoenents in HM
void	ShowComponent(java.lang.String strSessionName, java.lang.String strComponentName) Show display of the specified component in HM

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HMComponentComm

public HMComponentComm(HWMCommMgr hwmCommMgr)

Constructor

Parameters:

hwmCommMgr - The communication manager wqhich facilitates the communication with HM

Method Detail

CreateComponent

public void CreateComponent(java.lang.String strSessionName,
                            java.lang.String strComponentName)
                     throws java.lang.Exception

Sends a command to HM asking it to create a component collector with the given name

Parameters:

strSessionName - Session name to use for communication with HM

strComponentName - The name of the component collector to create

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

DeleteComponent

public void DeleteComponent(java.lang.String strSessionName,
                            java.lang.String strComponentName)
                     throws java.lang.Exception

Sends a command to HM asking it to delete a component collector with given name

Parameters:

strSessionName - Session name to use for communication with HM

strComponentName - The name of the component collector to delete

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

MoveToComponent

public void MoveToComponent(java.lang.String strSessionName,
                            java.lang.String strComponentName,
                            java.lang.String strEntityType,
                            java.lang.String strSelectionType)
                     throws java.lang.Exception

Sends a command to HM asking it to move components to a component collector

Parameters:

strSessionName - Session name to use for communication with HM

strComponentName - The name of the component collector

strEntityType - The type of entity to move (i.e. surface, elements etc.)

strSelectionType - The selection type can be - all, displayed or selected (user will select in HM).

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

CopyToComponent

public void CopyToComponent(java.lang.String strSessionName,
                            java.lang.String strComponentName,
                            java.lang.String strEntityType,
                            java.lang.String strSelectionType)
                     throws java.lang.Exception

Sends a command to HM asking it to copy components to a component collector

Parameters:

strSessionName - Session name to use for communication with HM

strComponentName - The name of the component collector

strEntityType - The type of entity to copy (i.e. surface, elements etc.)

strSelectionType - The selection type can be - all, displayed or selected (user will select in HM).

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

ShowAllComponents

public void ShowAllComponents(java.lang.String strSessionName)
                       throws java.lang.Exception

Show display of all compoenents in HM

Parameters:

strSessionName - Session name to use for communication with HM

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

HideAllComponents

public void HideAllComponents(java.lang.String strSessionName)
                       throws java.lang.Exception

Hide display of all components in HM

Parameters:

strSessionName - Session name to use for communication with HM

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

ShowComponent

public void ShowComponent(java.lang.String strSessionName,
                          java.lang.String strComponentName)
                   throws java.lang.Exception

Show display of the specified component in HM

Parameters:

strSessionName - Session name to use for communication with HM

strComponentName - The name of the component collector

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

HideComponent

public void HideComponent(java.lang.String strSessionName,
                          java.lang.String strComponentName)
                   throws java.lang.Exception

Show display of the specified component in HM

Parameters:

strSessionName - Session name to use for communication with HM

strComponentName - The name of the component collector

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured

GetAllComponents

public java.util.Vector GetAllComponents(java.lang.String strSessionName)
                                  throws java.lang.Exception

Get list of all components present in the model

Parameters:

strSessionName - Session name to use for communication with HM

Returns:

Vector List of collector names

Throws:

java.lang.Exception - thrown if the command fails. "getMessage" will give the description of the error that occured