ScalingFactor class is used for scaling display of a result.
The class can be called from Study class.
. More...

Public Member Functions
String	GetName ()
	Returns the name of the scaling display as a string. More...

double	GetScalingFactor ()
	Returns the scaling factor of all components as a real number. More...

Variant	GetScalingFactorEachAxis ()
	Returns the scaling factor of each component as an array (VBScript) or list (Python). More...

QList< double >	GetScalingFactorEachAxisToDblList ()
	Returns a list of the scaling factors for each component. More...

int	GetScalingType ()
	Returns a flag for the component type of the scaling display. More...

String	GetScalingTypeName ()
	Returns a component type name of the scaling display. More...

virtual bool	IsValid ()
	Returns True if an object is valid. More...

void	SetName (String &name)
	Specifies the name of the scaling display. More...

void	SetScalingFactor (double factor)
	Specifies the scaling factor (same scaling factor for all components). More...

void	SetScalingFactorEachAxis (double xfactor, double yfactor, double zfactor)
	Specifies the scaling factor for each component. More...

void	SetScalingType (Variant &value)
	Specifies a component type of the scaling display. More...

Detailed Description

ScalingFactor class is used for scaling display of a result.
The class can be called from Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).CreateScaling("scale_title")

Member Function Documentation

String ScalingFactor::GetName ( )

Returns the name of the scaling display as a string.

double ScalingFactor::GetScalingFactor ( )

Returns the scaling factor of all components as a real number.

The scaling factor of the X-component is returned when this function is used and the scaling factor is specified for each component.

Variant ScalingFactor::GetScalingFactorEachAxis ( )

Returns the scaling factor of each component as an array (VBScript) or list (Python).

QList< double > ScalingFactor::GetScalingFactorEachAxisToDblList ( )

Returns a list of the scaling factors for each component.

int ScalingFactor::GetScalingType ( )

Returns a flag for the component type of the scaling display.

String ScalingFactor::GetScalingTypeName ( )

Returns a component type name of the scaling display.

bool ScalingFactor::IsValid ( )

virtual

Returns True if an object is valid.

void ScalingFactor::SetName ( String & name )

Specifies the name of the scaling display.

Parameters

name	Scaling display name

void ScalingFactor::SetScalingFactor ( double factor )

Specifies the scaling factor (same scaling factor for all components).

Parameters

factor Scaling factor for all components

void ScalingFactor::SetScalingFactorEachAxis	(	double	xfactor,
		double	yfactor,
		double	zfactor
	)

Specifies the scaling factor for each component.

Parameters

xfactor	Scaling factor for the X-component
yfactor	Scaling factor for the Y-component
zfactor	Scaling factor for the Z-component

void ScalingFactor::SetScalingType ( Variant & value )

Specifies a component type of the scaling display.

Parameters

value

Flag or name of the component type
All components : Single or 0
Each component : EachAxis or 1