Interface INCStorageManager
Auxiliary object that helps to create new INCStorage instances and maintains the list of output files. Usually you don't need to use it directly. It is used internally by the classes TNCFilesManager, TTextNCFile and TBinaryNCFile.
Namespace: SprutTechnology.SCPostprocessor
Assembly: SCPostprocessor.dll
Syntax
public interface INCStorageManager
Methods
AddExternalBinaryFile(String, String)
Adds some binary external file to the list of output files. Usually you don't need to call it directly. Use the methods of TNCFilesManager instead.
Declaration
int AddExternalBinaryFile(string outputFileName, string fileDescription)
Parameters
Type | Name | Description |
---|---|---|
System.String | outputFileName | Full path to the external file name to add. |
System.String | fileDescription | The new value for the Description property. Description is a some textual information about the output file that will be displayed instead of the content of the file on the output files panel of SprutCAM (and CLData viewer). It is more actual for a binary output files instead of displaying hexadecimal representation of its bytes. |
Returns
Type | Description |
---|---|
System.Int32 | Returns the unique numerical identifier of this file in the list. |
AddExternalFile(String)
Adds some textual external file to the list of output files. Usually you don't need to call it directly. Use the methods of TNCFilesManager instead.
Declaration
int AddExternalFile(string outputFileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | outputFileName | Full path to the external file name to add. |
Returns
Type | Description |
---|---|
System.Int32 | Returns the unique numerical identifier of this file in the list. |
CreateNewBinaryStorage()
Creates a new IBinaryNCStorage instance. It is called automatically when you create a new TBinaryNCFile object.
Declaration
IBinaryNCStorage CreateNewBinaryStorage()
Returns
Type | Description |
---|---|
IBinaryNCStorage | Returns newly created instance of IBinaryNCStorage. |
CreateNewTextStorage()
Creates a new ITextNCStorage instance. It is called automatically when you create a new TTextNCFile object.
Declaration
ITextNCStorage CreateNewTextStorage()
Returns
Type | Description |
---|---|
ITextNCStorage | Returns newly created instance of ITextNCStorage. |
MakeUniqueFileName()
Makes a new unique file name for a temporary files inside the temp folder of the application. It is used internally by the classes TNCFilesManager and inheritors of TNCFile.
Declaration
string MakeUniqueFileName()
Returns
Type | Description |
---|---|
System.String | Returns a new file name. |
SetNCFileDescription(Int32, String)
Sets the new value of the Description property for the file with specified id in the list. Description is a some textual information about the output file that will be displayed instead of the content of the file on the output files panel of SprutCAM (and CLData viewer). It is more actual for a binary output files instead of displaying hexadecimal representation of its bytes.
Usually you don't need to call it directly. Use the methods of TNCFilesManager instead.
Declaration
void SetNCFileDescription(int id, string fileDescription)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | The unique identifier of the file you want to update in the list. |
System.String | fileDescription | The new value for the Description property. |
SetNCFileOutputName(Int32, String)
Sets the new value of the output file name for the file with specified id in the list. Usually you don't need to call it directly. Use the methods of TNCFilesManager instead.
Declaration
void SetNCFileOutputName(int id, string outputFileName)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | The unique identifier of the file you want to update in the list. |
System.String | outputFileName | The new value for the output file name property. |