AnalysisTemplateParameter class is used to specify parameters required for applying analysis templates.
The class can be called from Application class.
. More...

Public Member Functions
bool	IsValid ()
	Returns True if an object is valid. More...

void	SetEquationNames (int modelIndex, StringList &equationnames)
	Specifies the equation to be linked. More...

void	SetFilepath (String &filepath)
	Specifies the path of the analysis template file. More...

void	SetModelNames (StringList &modelnames)
	Specifies the model name to be applied. More...

void	SetPartNames (int modelIndex, StringList &partnames, bool renameParts=false)
	Specifies the part to be linked. More...

void	SetReferenceNames (int modelIndex, StringList &refnames, bool renameReferences=false, bool onlyAddExistedReferences=false)
	Specifies the set to be linked. More...

void	SetSetNames (int modelIndex, StringList &setnames, bool renameSets=false, bool onlyAddExistedSets=false)
	Specifies the set to be linked. More...

void	SetTemplatePath (String &path)
	Specifies the path of the analysis template of the toolbox. More...

Detailed Description

AnalysisTemplateParameter class is used to specify parameters required for applying analysis templates.
The class can be called from Application class.
.

Example of creating the class object:

app.CreateAnalysisTemplateParameter()

Member Function Documentation

bool AnalysisTemplateParameter::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the AnalysisTemplateParameter object is valid

void AnalysisTemplateParameter::SetEquationNames	(	int	modelIndex,
		StringList &	equationfnames
	)

Specifies the equation to be linked.

Parameters

modelIndex	Model index of template to set
equationnames	Name or index of a table defined with a link between equation in a template and CAD model

equationnames: Specify the following format when setting tables with the equation names above:

1: Equation name of a template

2: Equation index of a template

3: Equation name of a CAD model that a template is applied

4: Equation index of a CAD model that a template is applied.

The same format is repeated for the same number of equations.

void AnalysisTemplateParameter::SetFilepath ( String & filepath )

Specifies the path of the analysis template file.

Parameters

filepath Analysis template file path

void AnalysisTemplateParameter::SetModelNames ( StringList & modelnames )

Specifies the model name to be applied.

Parameters

modelnames List of model names to associate with the model of analysis template

void AnalysisTemplateParameter::SetPartNames	(	int	modelIndex,
		StringList &	partnames,
		bool	renameParts = `false`
	)

Specifies the part to be linked.

Parameters

modelIndex	Model index of template to set
partnames	Name or index of a table defined with a link between parts in a template and CAD model
renameParts	True=1 : Renames part name to match part name of template False=0 : Does not rename part name to match template

partnames

Specify the following format when setting tables with the partnames above:

Set name of a template (or group part name)
Part index of a template (or part group index)
Part type of a template (0: Part, 1: Part group)
Part name (or part group name) of a CAD model that a template is applied
Part index (or part group index) of a CAD model that a template is applied
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). 

The 2nd and 5th index is used when there are multiple parts with the same name.

0 is specified when there are no multiple parts with same name.
Numbers higher than 0 are specified when there are multiple parts with the same name.
For example, 0, 1, and 2 are specified for the indexes of each part when there are three parts with the same name
This script can link in group status as long as a type is specified.
Specify “0” for parts and “1” for part group.

void AnalysisTemplateParameter::SetReferenceNames	(	int	modelIndex,
		StringList &	refnames,
		bool	renameReferences = `false`,
		bool	onlyAddExistedReferences = `false`
	)

Specifies the set to be linked.

Parameters

modelIndex	Model index of template to set
refnames	Name or index of a table defined with a link between reference targets in a template and CAD model
renameReferences	True=1 : Renames reference target name to match template False=0 : Does not rename reference target name to match template
onlyAddExistedReferences	True=1 : Only add reference targets existed in model False=0 : Adds empty reference targets if they are not existed in model

refnames

Specify the following format when setting tables with the reference target names above:

ReferenceTarget name of a template
ReferenceTarget index of a template
ReferenceTarget type of a template ("face","edge","vertex")
ReferenceTarget name of a CAD model that a template is applied
ReferenceTarget index of a CAD model that a template is applied.
ReferenceTarget type of a CAD model that a template is applied ("face","edge","vertex")
The same format is repeated for the same number of reference targets.

The 2nd and 5th index is used when there are multiple reference targets with same name.

0 is specified when there are no multiple reference targets with same name.
Numbers higher than 0 are specified when there are multiple reference targets with the same name.
For example, 0, 1, and 2 are specified for the indexes of each reference target when there are three reference targets with the same name.
Specify either "Face," "Edge," or "Vertex" for the reference target type in row 3 and row 6.

void AnalysisTemplateParameter::SetSetNames	(	int	modelIndex,
		StringList &	setnames,
		bool	renameSets = `false`,
		bool	onlyAddExistedSets = `false`
	)

Specifies the set to be linked.

Parameters

modelIndex	Model index of template to set
partnames	Name or index of a table defined with a link between sets in a template and CAD model
renameSets	True=1 : Renames set name to match template False=0 : Does not rename set name to match template
onlyAddExistedSets	True=1 : Only add sets existed in model False=0 : Adds empty sets if they are not existed in model

setnames

Specify the following format when setting tables with the set names above:

Set name of a template
Set index of a template
Set type of a template ("part","face","edge","vertex")
Set name of a CAD model that a template is applied
Set index of a CAD model that a template is applied.
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.

The 2nd and 5th index is used when there are multiple parts with same name.

0 is specified when there are no multiple parts with same name.
Numbers higher than 0 are specified when there are multiple parts with the same name.
For example, 0, 1, and 2 are specified for the indexes of each set when there are three sets with the same name.
Specify either "Part," "Face," "Edge," or "Vertex" for the set type in row 3 and row 6.

void AnalysisTemplateParameter::SetTemplatePath ( String & path )

Specifies the path of the analysis template of the toolbox.

Parameters

path	Path of analysis template in Toolbox

Public Member Functions

Detailed Description

Member Function Documentation