Class CNC_Configuration
CNC configuration information
Inheritance
Inherited Members
Namespace: DesignData.SDS2.Detail
Assembly: DesignData.SDS2.Detail.dll
Syntax
public sealed class CNC_Configuration
Constructors
CNC_Configuration()
Declaration
public CNC_Configuration()
Properties
Name
Return the name of the first CNC_Configuration in the list.
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
System.String |
Names
Return the name(s) of the CNC_Configuration(s).
Declaration
public StringList Names { get; }
Property Value
Type | Description |
---|---|
StringList |
Methods
Add(StringList)
Add new CNC Configurations
Declaration
public void Add(StringList configurations)
Parameters
Type | Name | Description |
---|---|---|
StringList | configurations |
Exceptions
Type | Condition |
---|---|
InvalidValueException | InvalidValueException will be thrown if the name does not match any configuration. |
DownloadMaterials(StringList, String)
Generate CNC files for the specified submaterial marks and save them to the specified destination path.
The destination path should be a directory, if it does not exist we will attempt to create it. The parent of the directory must already exist.
Declaration
public void DownloadMaterials(StringList material_marks, string destination_path)
Parameters
Type | Name | Description |
---|---|---|
StringList | material_marks | |
System.String | destination_path |
Exceptions
Type | Condition |
---|---|
InvalidValueException | InvalidValueException will be thrown the configuration is not active. |
InvalidOperationException | InvalidOperationException will be thrown if CNC is unlicensed or not permitted in the station. Or if the output path already exists as a file (not a directory), or if the directory doesn't exist and we can't create it. |
DownloadMembers(StringList, String)
Generate CNC files for the specified member marks and save them to the specified destination path.
The destination path should be a directory, if it does not exist we will attempt to create it. The parent of the directory must already exist.
Declaration
public void DownloadMembers(StringList member_marks, string destination_path)
Parameters
Type | Name | Description |
---|---|---|
StringList | member_marks | |
System.String | destination_path |
Exceptions
Type | Condition |
---|---|
InvalidValueException | InvalidValueException will be thrown the configuration is not active. |
InvalidOperationException | InvalidOperationException will be thrown if CNC is unlicensed or not permitted in the station. Or if the output path already exists as a file (not a directory), or if the directory doesn't exist and we can't create it. |
Finalize()
Declaration
protected void Finalize()
Find(StringList)
Return the configuration(s) with the specified name(s).
Declaration
public static CNC_Configuration Find(StringList configurations)
Parameters
Type | Name | Description |
---|---|---|
StringList | configurations |
Returns
Type | Description |
---|---|
CNC_Configuration |
Exceptions
Type | Condition |
---|---|
InvalidValueException | InvalidValueException will be thrown if the name does not match any configuration. |
Find(String)
Return the configuration with the specified name.
Declaration
public static CNC_Configuration Find(string configurations)
Parameters
Type | Name | Description |
---|---|---|
System.String | configurations |
Returns
Type | Description |
---|---|
CNC_Configuration |
Exceptions
Type | Condition |
---|---|
InvalidValueException | InvalidValueException will be thrown if the name does not match any configuration. |
GetConfigurations()
Return all the configurations defined in the job.
Declaration
public CNC_Configuration GetConfigurations()
Returns
Type | Description |
---|---|
CNC_Configuration |
Remove(StringList)
Remove CNC Configurations
Declaration
public void Remove(StringList configurations)
Parameters
Type | Name | Description |
---|---|---|
StringList | configurations |
Exceptions
Type | Condition |
---|---|
InvalidValueException | InvalidValueException will be thrown if the name does not match any configuration. |