Interface IAutomationParametersProvider
This interface give access to a list of automation parameters.
Namespace: TopSolid.Cam.NC.Kernel.Automating
Assembly: TopSolid.Cam.NC.Kernel.Automating.dll
Syntax
public interface IAutomationParametersProviderMethods
GetEnumTypeName(ParameterId)
Gets the enum type name corresponding to the parameter.
Declaration
string GetEnumTypeName(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Identifier of the parameter to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Enum type name corresponding to the parameter. |
Remarks
An integer parameter can hold a value taken from an enumeration. This function will give the enumeration type full name (like TopSolid.Cam.NC.Kernel.common.DrillingType) for later usage. If the parameter is not containing an enum value, the string will be empty.
GetFullName(ParameterId)
Gets the full name with categories, of a Cam operation parameter.
Declaration
string GetFullName(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Identifier of the parameter to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Full name of the parameter, with categories. |
GetLocalizedName(ParameterId)
Gets the translated name of a Cam operation parameter.
Declaration
string GetLocalizedName(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Identifier of the parameter to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Translated name of the parameter. The TopSolid culture is used for the translation. |
GetName(ParameterId)
Gets the name of a Cam operation parameter.
Declaration
string GetName(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Identifier of the parameter to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Name of the parameter, without categories. |
GetParameter(ElementExId, String)
Gets the parameter id of the first parameter with the given name. The name can be full, with all categories. This is the best way to find the correct parameter. It can also be only the simple name, with partial categories, or no categories at all. The first name found with the given argument is returned.
Declaration
ParameterId GetParameter(ElementExId inElementId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Parameters container to scan. |
| System.String | inName | Name of the parameter, with categories or not. |
Returns
| Type | Description |
|---|---|
| ParameterId | Found parameter id. |
GetParameterEnumValueNames(ParameterId, Boolean)
Gets the enum value names corresponding to the given enum parameter.
Declaration
List<string> GetParameterEnumValueNames(ParameterId inParameterId, bool inLocalized)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Id of the parameter to analyze. |
| System.Boolean | inLocalized | True if the names must be localized according to TopSolid user interface culture. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.String> | Enum value names corresponding to the enum type of the given parameter. The result is a list where each value of the enum is at its indix in the list. For instance, an enum with 0,1,2 and 4 will return the list { zero, one, two, __, four }. Result[4] gives "four" ! |
Remarks
An integer parameter can hold a value taken from an enumeration. To know which values can be used, a user must be able to select this value in a listbox or a combo. But if a combo filled with 0,1 and 2 is not very expressive. So use this function to get the localized text corresponding to 0,1 and 2 ! The list will use of course the enum type from the parameter. Some parameters exclude specific values not relevants in this particular use case. The list will not contain those forbidden values.
GetParameters(ElementExId)
Gets the parameters of the given operation.
Declaration
List<ParameterId> GetParameters(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ParameterId> | Object parameters found. |
GetType(ParameterId)
Gets the type corresponding to the parameter.
Declaration
ParameterType GetType(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Identifier of the parameter to analyze. |
Returns
| Type | Description |
|---|---|
| ParameterType | Type corresponding to the parameter. |
GetValue(ElementExId, String)
Gets the value corresponding to the parameter.
Declaration
object GetValue(ElementExId inElementId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Element owner of the parameter. |
| System.String | inName | Full or partial name of the parameter to get. |
Returns
| Type | Description |
|---|---|
| System.Object | New SmartObject with the value of this parameter, or null. |
GetValueBoundElement(ElementExId, String)
Gets the value corresponding to the parameter.
Declaration
ElementId GetValueBoundElement(ElementExId inElementId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Element owner of the parameter. |
| System.String | inName | Full or partial name of the parameter to get. |
Returns
| Type | Description |
|---|---|
| ElementId | New SmartObject with the value of this parameter, or null. |
GetValueBoundValue(ElementExId, String)
Gets the value corresponding to the parameter.
Declaration
double GetValueBoundValue(ElementExId inElementId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Element owner of the parameter. |
| System.String | inName | Full or partial name of the parameter to get. |
Returns
| Type | Description |
|---|---|
| System.Double | New SmartObject with the value of this parameter, or null. |
GetValueFeedRateValue(ElementExId, String)
Gets the value corresponding to the parameter.
Declaration
double GetValueFeedRateValue(ElementExId inElementId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Element owner of the parameter. |
| System.String | inName | Full or partial name of the parameter to get. |
Returns
| Type | Description |
|---|---|
| System.Double | New SmartObject with the value of this parameter, or null. |
GetValueSpindleRateValue(ElementExId, String)
Gets the value corresponding to the parameter.
Declaration
double GetValueSpindleRateValue(ElementExId inElementId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Element owner of the parameter. |
| System.String | inName | Full or partial name of the parameter to get. |
Returns
| Type | Description |
|---|---|
| System.Double | New SmartObject with the value of this parameter, or null. |
IsReadOnly(ParameterId)
Checks if the given parameter can be modified or not.
Some parameters are computed and only readable. Others can be modified to change the element owner behaviour. If modifiable, a parameter value can be changed with SetValue functions.
Declaration
bool IsReadOnly(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Parameter to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if a SetValue function can be called to change its value. |
ToInvariantStringValue(ParameterId)
Gets the text corresponding to the parameter value, without translation.
Declaration
string ToInvariantStringValue(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Identifier of the parameter to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Text corresponding to the parameter value. The invariant culture is used. |
Remarks
The numerical values are given in meters and radians without any unit.
ToStringValue(ParameterId)
Gets the text corresponding to the parameter value.
Declaration
string ToStringValue(ParameterId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId | Identifier of the parameter to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Text corresponding to the parameter value. The TopSolid culture is used for the translation. |