Public Member Functions | List of all members
AnalysisTemplateControl Class Reference

AnalysisTemplateControl class is used to obtain settings information of the analysis template.
The class can be called from Model class.
. More...

Public Member Functions

Variant GetPartsFromSetting ()
 Returns a list of parts or part groups contained in the CAD model with the template applied. More...
 
Variant GetPartsFromTemplate ()
 Returns list of parts or parts group included in the template. More...
 
Variant GetSetsFromSetting ()
 Returns a list of sets included in the template. More...
 
Variant GetSetsFromTemplate ()
 Returns a list of sets included in the CAD model to which a template is applied. More...
 
Variant GetUnsetPartsFromSetting ()
 Returns a list of parts or parts group in the CAD model applied with a template that is not linked. More...
 
Variant GetUnsetPartsFromTemplate ()
 Returns list of parts or part group in the template that have not been linked with the CAD model. More...
 
Variant GetUnsetSetsFromSetting ()
 Returns a list of sets in the CAD model applied with a template that is not linked. More...
 
Variant GetUnsetSetsFromTemplate ()
 Returns a list of sets included in the template that is not linked with a CAD model. More...
 
bool IsAllPairsParts ()
 Returns True if there is a part in the active model paired with every part in the template. False is returned if there is a part that is not paired with a part in the template. More...
 
bool IsAllPairsSets ()
 Returns True if there is a set in the active model paired with every set in the template. False is returned if there is a set that is not paired with any set in the template. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 

Detailed Description

AnalysisTemplateControl class is used to obtain settings information of the analysis template.
The class can be called from Model class.
.

Example of creating the class object:

app.GetModel(0).CreateAnalysisTemplateControl("filepath")

Member Function Documentation

Variant AnalysisTemplateControl::GetPartsFromSetting ( )

Returns a list of parts or part groups contained in the CAD model with the template applied.

Returns
List of part or part group

The parts list above is exported in the following formats:

1: Part name (or part group name) of a CAD model that a template is applied.
2: Part index (or part group index) of a CAD model that a template is applied.
3: Part type (0: part, 1: part group) of a CAD model that a template is applied.
The same format is repeated for the same number of parts (or groups of parts).
Variant AnalysisTemplateControl::GetPartsFromTemplate ( )

Returns list of parts or parts group included in the template.

Returns
List of parts or part groups

The list above is exported in the following formats:

1: Part name of a template (or part group name)
2: Part index of a template (or part group index)
3: Part type of template (0: Part, 1: Part group)
The same format is repeated for the same number of parts (or groups of parts).
Variant AnalysisTemplateControl::GetSetsFromSetting ( )

Returns a list of sets included in the template.

Returns
List of sets

The list above is exported in the following formats:

1: Set name of a template
2: Set index of a template
3: Set type of a template ("part," "face," "edge," "vertex")
The same format is repeated for the same number of sets.
Variant AnalysisTemplateControl::GetSetsFromTemplate ( )

Returns a list of sets included in the CAD model to which a template is applied.

Returns
List of sets

The list above is exported by the following formats:

1: Set name of a CAD model that a template is applied
2: Set index of a CAD model that a template is applied
3: Set type of a CAD model that a template is applied ("part," "face," "edge," "vertex")
The same format is repeated for the same number of sets.
Variant AnalysisTemplateControl::GetUnsetPartsFromSetting ( )

Returns a list of parts or parts group in the CAD model applied with a template that is not linked.

Returns
List of parts that are not specified

The parts list above is exported in the following formats:

1: Part name (or part group name) of a CAD model that is applied with a template.
2: Part index (or part group index) of a CAD model that is applied with a template.
3: Part type (0: part, 1: part group) of a CAD model that is applied with a template.
The same format is repeated for the same number of undefined parts (or undefined groups of parts).
Variant AnalysisTemplateControl::GetUnsetPartsFromTemplate ( )

Returns list of parts or part group in the template that have not been linked with the CAD model.

Returns
List of parts that are not specified

The parts list above is exported in the following formats:

1: Part name for a template (or part group name)
2: Part index for a template (or part group index)
3: Part type for a template (0: Part, 1: Part group)
The same format is repeated for the same number of undefined parts (or undefined groups of parts).
Variant AnalysisTemplateControl::GetUnsetSetsFromSetting ( )

Returns a list of sets in the CAD model applied with a template that is not linked.

Returns
List of sets that are not specified

The set list above is exported in the following formats:

1: Set name of a CAD model that is applied with a template
2: Set index of a CAD model that is applied with a template
3: Set type of a CAD model that is applied with a template ("part","face","edge","vertex")
The same format is repeated as many times as the number of undefined sets.
Variant AnalysisTemplateControl::GetUnsetSetsFromTemplate ( )

Returns a list of sets included in the template that is not linked with a CAD model.

Returns
List of sets that are not specified

The set list above is exported in the following formats:

1: Set name of a template
2: Set index of a template
3: Set type of a template ("part," "face," "edge," "vertex")
The same format is repeated as many times as the number of undefined sets.
bool AnalysisTemplateControl::IsAllPairsParts ( )

Returns True if there is a part in the active model paired with every part in the template. False is returned if there is a part that is not paired with a part in the template.

Returns
A value indicating whether each part is paired with a part in the template
AnalysisTemplateControl_IsAllPairsParts.gif
bool AnalysisTemplateControl::IsAllPairsSets ( )

Returns True if there is a set in the active model paired with every set in the template. False is returned if there is a set that is not paired with any set in the template.

Returns
A value indicating whether each set in the template is paired with a set
bool AnalysisTemplateControl::IsValid ( )

Returns True if an object is valid.

Returns
A value indicating whether or not the AnalysisTemplateControl objects in the list are valid