Machining

What You Will Learn With This Use Case

This use case is intended to help you create your own contextual menu for tool path.

[Top]

The CAAMfgTPEUserCommandHeaders Use Case

CAAMfgTPEUserCommandHeaders is a use case of the CAAToolPathEditorItf.edu framework that illustrates ToolPathEditorInterfaces framework capabilities.

[Top]

What Does CAAMfgTPEUserCommandHeaders Do

CAAMfgTPEUserCommandHeaders builds and customize the contextual menu of tool path as shown on Fig.1.

Fig. 1: The tool path contextual menu

[Top]

How to Launch CAAMfgTPEUserCommandHeaders

To launch CAAMfgTPEUserCommandHeaders, you will need to:

• Set up the build time environment, then compile CAAMfgTPEAddToolBar.m and CAAMfgTPEUserCommandHeaders.m modules along with its prerequisites [1]

# Decomment this line into file ToolPathEditor.edu.dico to run CAAMfgTPEAddToolBar Sample
# CAAMfgTPEM3xAddin CATISmgProgramAddin libCAAMfgTPEAddToolBar
# Decomment these lines into file ToolPathEditor.edu.dico to run CAAMfgTPEUserCommandHeaders Sample
# MfgCompoundTraject CATIMfgToolPathEditorUserHeader libCAAMfgTPEUserCommandHeaders
# MfgTPMultipleMotion CATIMfgToolPathEditorUserHeader libCAAMfgTPEUserCommandHeaders

Set up the run time environment:

• Launch a CATIA V5 session
• Open the CAAMfgToolPath.CATPart file located in:

Windows	InstallRootDirectory\CAADoc\CAAToolPathEditorItf.edu\CNext\resources\graphic
Unix	InstallRootDirectory/CAADoc/CAAToolPathEditorItf.edu/CNext/resources/graphic



• Using the Start menu, select the Surfacic Machining workbench in NC Manufacturing



This displays the PPR document:



• In the PPR Tree, select Manufacturing Program.1 and create a sweeping operation using the Sweeping command in the Insert->Machining Operations->sweeping
• Select a body, then do replay to compute the tool path.
• Lock the Sweeping operation : The contextual menu of the tool path is enabled only if the Sweeping operation is locked in the PPR tree.
• In the PPR tree, an icon appears under the activity of sweeping.
• Then display the contextual menu of the tool path as shown in fig.1.

[Top]

Where to Find the CAAMfgTPEUserCommandHeaders Code

The CAAMfgTPEUserCommandHeaders use case is made of a class named CAAMfgTPEUserCommandHeaders located in the CAAMfgTPEUserCommandHeaders.m module of the CAAToolPathEditorItf.edu framework:

where InstallRootDirectory is the directory where the CAA CD-ROM is installed.

[Top]

Step-by-Step

There is one logical steps in CAAMfgTPEDisplayToolPathCommand:

• Creating the Implementation of the CATIMfgToolPathUserHeader

We now comment these section by looking at the code.

[Top]

Creating the Implementation of the CATIMfgToolPathUserHeader

The class that will implement the command is named CAAMfgTPEUserCommandHeaders. Create the CAAMfgTPEUserCommandHeaders class header file:

class ExportedByCAAMfgTPEUserCommandHeadersEnv CAAMfgTPEUserCommandHeaders : public CATBaseUnknown
{
  CATDeclareClass;
public:
 
  CAAMfgTPEUserCommandHeaders();
  virtual ~CAAMfgTPEUserCommandHeaders();
   //Give the list of headers of command in the tool path editor.
	virtual HRESULT GetHeaders( CATListValCATString &ioHeadersList );
   //Say if the header of command is available for a given set of object
	virtual HRESULT IsHeadersAvailable( CATListValCATString& ioHeadersList , CATCSO* iCSO );
private :
	// The copy constructor and the equal operator must not be implemented
	// -------------------------------------------------------------------
	CAAMfgTPEUserCommandHeaders (CAAMfgTPEUserCommandHeaders &);
	CAAMfgTPEUserCommandHeaders& operator=(CAAMfgTPEUserCommandHeaders&);
	// ------------------
	// HeaderAvailability
	// ------------------
	void HeaderAvailability(const CATString& HeaderName, CATBoolean isON);
};

The CAAMfgTPEUserCommandHeaders class C++-derives from CATBaseUnknown. The class has a constructor, a destructor, and the two methods of the interface CATIMfgToolPathUserHeaders.

First you have to implement the method GetHeaders, which will provide you with getting the standard headers and to give the application yours own headers of command.

HRESULT CAAMfgTPEUserCommandHeaders::GetHeaders( CATListValCATString &ioHeadersList)
{
	HRESULT hRes= S_OK;
	// Default list of Headers of command in the Tool path Editor.
	// Each empty string is displayed as a separator in the menu.
	// TPEPointModification
	// TPEAreaModification 
	// "" 
	// TPETranslate
	// TPERotate
	// TPEMirror
	// ""
	// TPEReverse
	// TPEConnect
	// TPEApproachRetract
	// ""
	// TPEToolLength
	CATIMfgToolPathEditorHeader_var spTPEHeaders = GetImpl();
	if (!!spTPEHeaders)
		spTPEHeaders->GetHeaders(ioHeadersList);
	int index=8;
	ioHeadersList.InsertBefore(index,CATString("TPESplitToolPath"));
	index=1;
	ioHeadersList.Replace ( index, CATString("TPEDisplayToolPath"));
	// User's list of Headers of command.
	ioHeadersList.Append(CATString("TPEDisplayDistance"));
	return hRes;
}

First, we get the standard headers of the tool path editor ( if there are used ) by a call to the method GetHeaders of interface CATIMfgToolPathEditorHeader. (Note that an empty string in the list is equivalent to a separator.) Then we customize this list replacing, suppressing or adding command headers.

Now we implement the method IsHeadersAvailable.

HRESULT CAAMfgTPEUserCommandHeaders::IsHeadersAvailable( CATListValCATString& ioHeadersList , CATCSO* iCSO )
{
	HRESULT hRes= S_OK;
	if (NULL == iCSO) return E_FAIL;
	int nbSelectedItems = iCSO->GetSize();
	// if several objects are selected, the contextual menu isn't the same.
	// Two items are disabled
	if ( nbSelectedItems > 1 ) {
		// Get the CATIMfgToolPathEditorHeader interface
		CATIMfgToolPathEditorHeader_var spTPEHeaders = GetImpl();
		if (!!spTPEHeaders)
			spTPEHeaders->IsHeadersAvailable(ioHeadersList,iCSO);
		HeaderAvailability(CATString("TPESplitToolPath"), CATFalse);
	}
	return hRes;
}

First, we call the method IsHeadersAvailable of interface CATIMfgToolPathEditorHeader, if we have any standard command header of the tool path editor.

Then we can activate or deactivate our own headers. For example, if a command doesn't work for a multiple selection of tool path, it should be deactivated

[Top]

In Short

[Top]

References

History

Copyright © 2002, Dassault Systèmes. All rights reserved.