All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgActivitySyntax

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

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


interface CATIMfgActivitySyntax

Interface dedicated to activity object managing PP words.
Role: This interface offers services to manage PP words of activity.


Method Index


o GetNCInstruction(CATString&)
Retrieves the NC instruction.
o GetPPWORDSyntax(CATUnicodeString&)
Retrieves the PP words syntax.
o GetPPWORDSyntaxMode(CATIMfgActivitySyntax::MfgPPWORDSyntaxMode&)
Retrieves the PP words syntax mode.
o ResetPPWORDSyntax()
Resets the PP words syntax.
o SetPPWORDSyntax(CATUnicodeString&)
Sets the PP words syntax.

Enumerated Type Index


o MfgPPWORDSyntaxMode
Possible PP words syntax initialisation mode.

Methods


o GetNCInstruction
public virtual HRESULT GetNCInstruction(CATString& oPPWORDs) =0
Retrieves the NC instruction.
Returns:
S_OK when the method succeeds, and E_FAIL otherwise
Parameters:
oPPWORDs
The PP words instruction
o GetPPWORDSyntax
public virtual HRESULT GetPPWORDSyntax(CATUnicodeString& oPPWORDs) =0
Retrieves the PP words syntax.
Returns:
S_OK when the method succeeds, and E_FAIL otherwise
Parameters:
oMode
The PP words syntax
o GetPPWORDSyntaxMode
public virtual HRESULT GetPPWORDSyntaxMode(CATIMfgActivitySyntax::MfgPPWORDSyntaxMode& oMode) =0
Retrieves the PP words syntax mode.
Returns:
S_OK when the method succeeds, and E_FAIL otherwise
Parameters:
oMode
The PP words syntax mode
o ResetPPWORDSyntax
public virtual HRESULT ResetPPWORDSyntax()=0
Resets the PP words syntax.
Returns:
S_OK when the method succeeds, and E_FAIL otherwise
o SetPPWORDSyntax
public virtual HRESULT SetPPWORDSyntax( const CATUnicodeString& iPPWORDs) =0
Sets the PP words syntax.
Returns:
S_OK when the method succeeds, and E_FAIL otherwise
Parameters:
iPPWORDs
The user PP words syntax to set

Enumerated Types


o MfgPPWORDSyntaxMode
enum MfgPPWORDSyntaxMode {
  InitFromPPTable,
  InitFromUser
}
Possible PP words syntax initialisation mode.
Parameters:
InitFromPPTable
the PP words syntax is initialised from the current PP words table
InitFromUser
the PP words syntax is initialised from user Input

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

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