All Frameworks Class Hierarchy This Framework Indexes Previous Next

MachiningResourceUseItf Interface DELIMfgToolAssembly

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface DELIMfgToolAssembly

Interface dedicated to Tool Assembly objects management.
Role: This interface offers services to manage mainly the associated tool and holder.
Common attributes are declared in CATMfgToolAssemblyConstant.

See also:
See also:

Method Index

o AddComponent(CATBaseUnknown_var&,CATBaseUnknown_var&): Adds a new component to tool assembly.
o GetAllComponents(CATListValCATBaseUnknown_var&): Returns the list of all components associated with the tool assembly.
o GetAllStages(long&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATBoolean): Returns Number of stages with the value of Gage between Tool and First Holder.
o GetEditableStatus(CATBaseUnknown_var&): Returns a boolean: if TRUE, it means that the Tool Assembly is editable for the given Activity if FALSE, the Tool Assembly can not be modified on this entity
o GetHolders(CATListValCATBaseUnknown_var&): Returns the list of holder associated with the tool assembly.
o GetLengthOfToolAssembly(double&,CATBoolean,int): Returns the value of the total length of the tool assembly.
o GetListHolderGage(CATListOfCATBaseUnknown_var&,CATListOfDouble&,CATBoolean,int): Returns the list of holder associated with the tool assembly and the list of Gage
o GetToolGage(double&,CATBoolean,int): Returns the value of Gage between Tool and First Holder.
o GetTools(CATListValCATBaseUnknown_var&): Returns the list of tool associated with the tool assembly.
o RemoveAllComponents(): Remove all the components of tool assembly.
o RemoveComponent(CATBaseUnknown_var&): Removes a component of tool assembly.
o SetListHolderGage(CATListOfDouble&,CATBoolean,int): Sets the list of holder gage associated to the tool assembly
o SetToolGage(double&,CATBoolean,int): Set the value of Gage between Tool and First Holder.

Methods

o AddComponent

public virtual AddComponent(	const	`iComponent`,
		`oInstance`)

Adds a new component to tool assembly.

Parameters:

iComponent: : PLM object to add
oInstance: : return instance

o GetAllComponents

public virtual GetAllComponents( oListofComponent)

Returns the list of all components associated with the tool assembly.

Parameters:

oListofComponent: List of PLM Object. First, all elements in list are removed.

o GetAllStages

public virtual GetAllStages(		`oNbStages`,
		`oListOfHeight`,
		`oListOfDiam1`,
		`oListOfDiam2`,
		`IsLocal`)

Returns Number of stages with the value of Gage between Tool and First Holder.

Parameters:

oNbStages: : Number of stages
oListOfHeight:: height definition
oListOfDiam1: : diameter definition
oListOfDiam2: : conical diameter definition

o GetEditableStatus

public virtual GetEditableStatus( const iActivity)

Returns a boolean: if TRUE, it means that the Tool Assembly is editable for the given Activity if FALSE, the Tool Assembly can not be modified on this entity

Parameters:

iActivity: The activity for which you want to know the edit capability of the tool assembly

o GetHolders

public virtual GetHolders( oListofHolder)

Returns the list of holder associated with the tool assembly.

Parameters:

oListofHolder: List of Holder. First, all elements in list are removed.

o GetLengthOfToolAssembly

public virtual GetLengthOfToolAssembly(		`oToolAssemblyLength`,
		`Islocal`	`= FALSE`,
	const	`iUnit`	`=0`)

Returns the value of the total length of the tool assembly.

Parameters:

oToolAssemblyLength.
Islocal:: Local value save in Tool Configuration if is defined
iUnit: :

o GetListHolderGage

public virtual GetListHolderGage(		`oListofHolder`,
		`oListHolderGage`,
		`Islocal`	`= FALSE`,
	const	`iUnit`	`=0`)

Returns the list of holder associated with the tool assembly and the list of Gage

Parameters:

oListofHolder: List of Holder. First, all elements in list are removed.
oListHolderGage: List of Gage between each Holder. First, all elements in list are removed.
Islocal:: Local value save in Tool Configuration if is defined
iUnit: :

o GetToolGage

public virtual GetToolGage(		`oToolGage`,
		`Islocal`	`= FALSE`,
	const	`iUnit`	`=0`)

Returns the value of Gage between Tool and First Holder.

Parameters:

oToolGage.
Islocal:: Local value save in Tool Configuration if is defined
iUnit: :

o GetTools

public virtual GetTools( oListofTool)

Returns the list of tool associated with the tool assembly.

Parameters:

oListofHolder: List of Holders. First, all elements in list are removed.

o RemoveAllComponents

public virtual RemoveAllComponents(

)

Remove all the components of tool assembly.

o RemoveComponent

public virtual RemoveComponent( const iComponent)

Removes a component of tool assembly.

Parameters:

iComponent:: PLM object to remove

o SetListHolderGage

public virtual SetListHolderGage(		`iListHolderGage`,
		`Islocal`	`= FALSE`,
	const	`iUnit`	`=0`)

Sets the list of holder gage associated to the tool assembly

Parameters:

iListHolderGage: List of Gage between each Holder. First, all elements in list are removed.
Islocal:: Local value save in Tool Configuration if is defined
iUnit: :

o SetToolGage

public virtual SetToolGage(		`iToolGage`,
		`Islocal`	`= FALSE`,
	const	`iUnit`	`=0`)

Set the value of Gage between Tool and First Holder.

Parameters:

iToolGage: : Gage between Tool and First Holder
Islocal:: Local value save in Tool Configuration if is defined
iUnit: :

This object is included in the file: DELIMfgToolAssembly.h
If needed, your Imakefile.mk should include the module: MachiningResourceUseItf