Interface IParameters

Gives access to operation parameters. A parameter is mainly defined by its name, composed of a simple name, with categories following :

LeadRadius@Lead|LeadIn

where LeadRadius is the simple name, '@' is a separator between the name and the categories. Lead and LeadIn are two categories, separated by a '|' character. To be sure to get the parameter from the correct operation, insert the operation type as a new category :

LeadRadius@Lead|LeadIn|NCOperation

Namespace: TopSolid.Cam.NC.Kernel.Automating

Assembly: TopSolid.Cam.NC.Kernel.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 8, 0, 0)]
public interface IParameters

Methods

Name	Description
GetCategories(string)	Gets the categories, of a Cam operation parameter.
GetEnumTypeName(ParameterId)	Gets the enum type name corresponding to the parameter.
GetEnumValueNames(string, bool)	Gets the enum value names corresponding to the given enum type.
GetFullName(ParameterId)	Gets the full name with categories, of a Cam operation parameter.
GetLocalizedName(ParameterId)	Gets the translated name of a Cam operation parameter.
GetName(ParameterId)	Gets the name of a Cam operation parameter.
GetNamedValue(ElementExId, string)	Gets the value of the given parameter. The kind of SmartObject is fixed by the ParameterType. If the parameter is a bound, the returned object is a SmartInteger with the type. Use GetNamedValueBoundValue(ElementExId, string) and GetNamedValueBoundElement(ElementExId, string) to get other items of the bound parameter.
GetNamedValueBoundElement(ElementExId, string)	From a bound parameter, get a ElementId with the bound limitation element. Use GetValue(ParameterId) to get the bound type, and GetValueBoundValue(ParameterId) to get the limitation value.
GetNamedValueBoundValue(ElementExId, string)	From a bound parameter, get a SmartReal with the computed bound value. Use GetValue(ParameterId) to get the bound type, and GetValueBoundElement(ParameterId) to get the limitation element.
GetNamedValueFeedRateValue(ElementExId, string)	From a feedrate parameter, get a SmartReal with the computed feedrate value. Use GetValue(ParameterId) to get the feedrate type.
GetNamedValueSpindleRateValue(ElementExId, string)	From a spindle rate parameter, get a SmartReal with the computed spindle rate value. Use GetValue(ParameterId) to get the spindle rate type.
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.
GetParameterEnumValueNames(ParameterId, bool)	Gets the enum value names corresponding to the given enum parameter.
GetParameters(ElementExId)	Gets the parameters of the given operation.
GetType(ParameterId)	Gets the type corresponding to the parameter.
GetValue(ParameterId)	Gets the value of the given parameter. The kind of SmartObject is fixed by the ParameterType: SmartInteger for integer parameter, SmartReal for real parameter, et caetera... If the parameter is a composite, like bound or feedrate, the returned object is a SmartInteger with the type. Use GetValueBoundValue(ParameterId) and GetValueBoundElement(ParameterId) to get other items of the bound parameter.
GetValueBoundElement(ParameterId)	From a bound parameter, get a ElementId with the bound limitation element. Use GetValue(ParameterId) to get the bound type, and GetValueBoundValue(ParameterId) to get the limitation value.
GetValueBoundValue(ParameterId)	From a bound parameter, get a SmartReal with the bound value. Use GetValue(ParameterId) to get the bound type, and GetValueBoundElement(ParameterId) to get the limitation element.
GetValueFeedRateValue(ParameterId)	From a feedrate parameter, get a SmartReal with the type value. Use GetValue(ParameterId) to get the feedrate type.
GetValueSpindleRateValue(ParameterId)	From a spindle rate parameter, get a SmartReal with the type value. Use GetValue(ParameterId) to get the spindle rate type.
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 behavior. If modifiable, a parameter value can be changed with SetValue functions.
SetNamedValue(ElementExId, string, SmartObject)	Sets the value of the given parameter. The kind of SmartObject is fixed by the ParameterType: SmartInteger for integer parameter, SmartReal for real parameter, et caetera... Bound parameters must be set by the according functions.
SetValue(ParameterId, SmartObject)	Sets the value of the given parameter. The kind of SmartObject is fixed by the ParameterType: SmartInteger for integer parameter, SmartReal for real parameter, et caetera... Bound parameters must be set by the according functions.
ToInvariantStringValue(ParameterId)	Gets the text corresponding to the parameter value, without translation.
ToStringValue(ParameterId)	Gets the localized text corresponding to the parameter value.