All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgActivityNCCodeFileManagement

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

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


interface CATIMfgActivityNCCodeFileManagement

Interface to manage NC Code file on Activity.


Method Index


o GetFileListSize(int&)
Get the Size of NC Code file list associated to the activity.
o GetISOFileStatus(int&)
Computes and returns the status of the nc code file.
o GetNCCodeFile(CATUnicodeString&)
Reads the NC Code file associated to the activity.
o GetNCCodeFileFromList(CATUnicodeString&,int&)
Reads the NC Code file from the list associated to the activity.
o SetNCCodeFile(CATUnicodeString&)
Associates a NC Code file to the activity.
o SetNCCodeFileList(CATUnicodeString&)
Associates NC Code file list to the activity.
o UnsetNCCodeFile()
Removes the NC Code file associated to the activity.
o UnsetNCCodeFileList(int&)
Remove a file from the list of files associated to the activity.

Methods


o GetFileListSize
public virtual HRESULT GetFileListSize(int& oNum) = 0
Get the Size of NC Code file list associated to the activity.
Parameters:
oNum
The size of the List
Returns:
S_OK if the file list is successfully retrieved, and E_FAIL otherwise.
o GetISOFileStatus
public virtual HRESULT GetISOFileStatus(int& oStatus)=0
Computes and returns the status of the nc code file.
Parameters:
oStatus
indicates the status
Legal values:
  • 0: NC file does not exist
  • -1: NC file exist but is not found
  • 1: NC exist but is not up-to-date
  • 2: NC file exist and is up-to-date
Returns:
HRESULT can be S_OK, S_FALSE if the status is unknown (oStatus =0), E_FAIL with allocated Error definition (oStatus =0).
o GetNCCodeFile
public virtual HRESULT GetNCCodeFile(CATUnicodeString& oFilePath) = 0
Reads the NC Code file associated to the activity.
Parameters:
oFilePath
The full path of the NC Code File
Returns:
S_OK if the file is successfully retrieved, and E_FAIL otherwise.
o GetNCCodeFileFromList
public virtual HRESULT GetNCCodeFileFromList(CATUnicodeString& oFilePath,
int& index) = 0
Reads the NC Code file from the list associated to the activity.
Parameters:
oFilePath
The full path of the NC Code File
iIndex
The index of the file in the list
Returns:
S_OK if the file list is successfully retrieved, and E_FAIL otherwise.
o SetNCCodeFile
public virtual HRESULT SetNCCodeFile( const CATUnicodeString& iFilePath) = 0
Associates a NC Code file to the activity.
Parameters:
iFilePath
The full path of the NC Code File
Returns:
S_OK if the file is successfully associated with the activity, and E_FAIL if the file cannot be allocated
o SetNCCodeFileList
public virtual HRESULT SetNCCodeFileList( const CATUnicodeString& iFilePath) = 0
Associates NC Code file list to the activity.
Parameters:
iFilePath
The full path of the NC Code File
Returns:
S_OK if the file list is successfully associated with the activity, and E_FAIL if the file cannot be allocated
o UnsetNCCodeFile
public virtual HRESULT UnsetNCCodeFile()= 0
Removes the NC Code file associated to the activity. The File is not deleted from the disk.
Returns:
S_OK if the file is successfully removed, E_FAIL otherwise.
o UnsetNCCodeFileList
public virtual HRESULT UnsetNCCodeFileList(int& iIndex) = 0
Remove a file from the list of files associated to the activity.
Parameters:
iIndex
The index of the file in the list
Returns:
S_OK if the file list is successfully retrieved, and E_FAIL otherwise.

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

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