ReferenceItem Class Reference
ReferenceItem class is used to specify a parametric item.
The class can be called from DesignTable class.
.
More...
Public Member Functions | |
| void | AddParametricItem (Variant &indexOrName) |
| Add parameter to grouped material. More... | |
| void | AddParametricItemObject (ParametricItem *item) |
| Add parameter to grouped material. More... | |
| void | Build () |
| Creates a reference parameter item. The information must be specified in advance. | |
| String | GetParameterName () |
| Returns the reference item name. More... | |
| bool | IsValid () |
| Returns True as a return value if an object is valid. More... | |
| void | RemoveParametricItem (Variant &indexOrName) |
| Removes parameter. More... | |
| void | RemoveParametricItemObject (ParametricItem *item) |
| Removes parameter. More... | |
| void | SetParameterName (String &name) |
| Specifies the parameter name. More... | |
Detailed Description
ReferenceItem class is used to specify a parametric item.
The class can be called from DesignTable class.
.
Example of calling the class object:
app.GetModel(0).GetStudy(0).GetDesignTable().GetReferenceItem(0)
Member Function Documentation
| void ReferenceItem::AddParametricItem | ( | Variant & | indexOrName | ) |
Add parameter to grouped material.
- Parameters
-
indexOrName Name or index of the parameter
| void ReferenceItem::AddParametricItemObject | ( | ParametricItem * | item | ) |
Add parameter to grouped material.
- Parameters
-
ParametricItem object
| String ReferenceItem::GetParameterName | ( | ) |
Returns the reference item name.
- Returns
- Reference item name
| bool ReferenceItem::IsValid | ( | ) |
Returns True as a return value if an object is valid.
- Returns
- Whether or not the ReferenceItem object is valid
| void ReferenceItem::RemoveParametricItem | ( | Variant & | indexOrName | ) |
Removes parameter.
- Parameters
-
indexOrName Name or index of the parameter
| void ReferenceItem::RemoveParametricItemObject | ( | ParametricItem * | item | ) |
Removes parameter.
- Parameters
-
ParametricItem object
| String ReferenceItem::SetParameterName | ( | String & | name | ) |
Specifies the parameter name.
- Parameters
-
name Parameter name