All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgManufacturingSettings

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIMfgManufacturingSettings
 

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


interface CATIMfgManufacturingSettings

Interface to manage manufacturing settings.

Role: CATIMfgManufacturingSettings has methods to manage manufacturing settings.


Method Index


o GetCreateDefaultToolSetting(int&)
Retrieves the CreateDefaultTool parameter.
o GetDisplayMode(int&)
Retrieves the current display mode.
o GetModeIHMBasic(int&)
Retrieves the IHM Basic mode.
o GetNCCodeDirectory(CATUnicodeString&)
Retrieves the ouput path definition for nc code storage.
o GetNotFoundColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the NotFoundColor parameter.
o GetNotUpToDateColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the NotUpToDateColor parameter.
o GetOptionalColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the OptionalColor parameter.
o GetPPPathDirectory(CATUnicodeString&,int)
Retrieves the ouput path definition for Post-Processors.
o GetRequiredColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the RequiredColor parameter.
o GetSearchToolInProgramSetting(int&)
Retrieves the SearchTool parameter.
o GetStartEditModeSetting(int&)
Retrieves the StartEditMode parameter.
o GetTextColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the TextColor parameter.
o GetValuatedColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the ValuatedColor parameter.
o SetDisplayMode(int)
Sets the current display mode.

Methods


o GetCreateDefaultToolSetting
public virtual HRESULT GetCreateDefaultToolSetting(int& oCreateDefaultTool)=0
Retrieves the CreateDefaultTool parameter.
Role: Retrieves the CreateDefaultTool parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetCreateDefaultToolSetting (oCreateDefaultTool);
Parameters:
oCreateDefaultTool
1 if a default tool must be created, 0 otherwise.
o GetDisplayMode
public virtual HRESULT GetDisplayMode(int& oDisplayMode)=0
Retrieves the current display mode.
Role: Retrieves the display mode.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetDisplayMode (oDisplayMode);
Parameters:
oDisplayMode
Current display mode. May be 1 (nothing displayed), 2 (toolpath displayed) or 3 (geometry displayed)
o GetModeIHMBasic
public virtual HRESULT GetModeIHMBasic(int& oModeIHMBasic)=0
Retrieves the IHM Basic mode.
Role: Retrieves the IHM mode.
Usage: CATIMfgManufacturingSettings *piSet=NULL; HRESULT Res = piSet->GetModeIHMBasic(oModeIHMBasic);
Parameters:
oModeIHMBasic
0 means Basic mode not activated, 1 means Basic mode activated
o GetNCCodeDirectory
public virtual HRESULT GetNCCodeDirectory(CATUnicodeString& oDirectory)=0
Retrieves the ouput path definition for nc code storage.
Role: Retrieves the ouput path definition.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetNCCodeDirectory (oDirectory);
Parameters:
oPath
CATUnicodeString describing the full path to the directory where NC Code file is stored
o GetNotFoundColor
public virtual HRESULT GetNotFoundColor(unsigned int& oR,
unsigned int& oG,
unsigned int& oB)=0
Retrieves the NotFoundColor parameter.
Role: Retrieves the NotFoundColor parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetNotFoundColor (oR, oG, oB);
Parameters:
oR
Red component of the color.
oG
Green component of the color.
oB
Blue component of the color.
o GetNotUpToDateColor
public virtual HRESULT GetNotUpToDateColor(unsigned int& oR,
unsigned int& oG,
unsigned int& oB)=0
Retrieves the NotUpToDateColor parameter.
Role: Retrieves the NotUpToDateColor parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetNotUpToDateColor (oR, oG, oB);
Parameters:
oR
Red component of the color.
oG
Green component of the color.
oB
Blue component of the color.
o GetOptionalColor
public virtual HRESULT GetOptionalColor(unsigned int& oR,
unsigned int& oG,
unsigned int& oB)=0
Retrieves the OptionalColor parameter.
Role: Retrieves the OptionalColor parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetOptionalColor (oR, oG, oB);
Parameters:
oR
Red component of the color.
oG
Green component of the color.
oB
Blue component of the color.
o GetPPPathDirectory
public virtual HRESULT GetPPPathDirectory(CATUnicodeString& oDirectory,
int iFullPath=0)=0
Retrieves the ouput path definition for Post-Processors.
Role: Retrieves the PP path definition.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetPPPathDirectory (oDirectory);
Parameters:
oPath
CATUnicodeString describing the path to the directory where Post-Processors are stored
iFullPath
int asking for full path (as ../startup/Manufacturing/XXXPar )(> 0) or short Path (as ../startup/Manufacturing) (= 0 )
o GetRequiredColor
public virtual HRESULT GetRequiredColor(unsigned int& oR,
unsigned int& oG,
unsigned int& oB)=0
Retrieves the RequiredColor parameter.
Role: Retrieves the RequiredColor parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetRequiredColor (oR, oG, oB);
Parameters:
oR
Red component of the color.
oG
Green component of the color.
oB
Blue component of the color.
o GetSearchToolInProgramSetting
public virtual HRESULT GetSearchToolInProgramSetting(int& oSearchTool)=0
Retrieves the SearchTool parameter.
Role: Retrieves the SearchTool parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetSearchToolInProgramSetting (oSearchTool);
Parameters:
oSearchTool
1 if a compatible tool is searched in previous operations, 0 otherwise.
o GetStartEditModeSetting
public virtual HRESULT GetStartEditModeSetting(int& oStartEditMode)=0
Retrieves the StartEditMode parameter.
Role: Retrieves the StartEditMode parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetStartEditModeSetting (oStartEditMode);
Parameters:
oStartEditMode
1 if the operation is edited after creation, 0 otherwise.
o GetTextColor
public virtual HRESULT GetTextColor(unsigned int& oR,
unsigned int& oG,
unsigned int& oB)=0
Retrieves the TextColor parameter.
Role: Retrieves the TextColor parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetTextColor (oR, oG, oB);
Parameters:
oR
Red component of the color.
oG
Green component of the color.
oB
Blue component of the color.
o GetValuatedColor
public virtual HRESULT GetValuatedColor(unsigned int& oR,
unsigned int& oG,
unsigned int& oB)=0
Retrieves the ValuatedColor parameter.
Role: Retrieves the ValuatedColor parameter.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->GetValuatedColor (oR, oG, oB);
Parameters:
oR
Red component of the color.
oG
Green component of the color.
oB
Blue component of the color.
o SetDisplayMode
public virtual HRESULT SetDisplayMode( const int iDisplayMode)=0
Sets the current display mode.
Role: Sets the display mode.
Usage: CATIMfgManufacturingSettings *piSet=NULL; CATString ClassName("CATMfgManufacturingSettings"); CATInstantiateComponent (ClassName, CATIMfgManufacturingSettings::ClassId(), (void**) &piSet); ..................... HRESULT Res = piSet->SetDisplayMode (iDisplayMode);
Parameters:
iDisplayMode
Current display mode. May be 1 (nothing displayed), 2 (toolpath displayed) or 3 (geometry displayed)

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

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