VibrationDefinition class is used for vibration calculation.
This class can be obtained from Study class.
. More...

Public Member Functions
void	ClearExcitationResultDefinition (Variant &indexName, int slotIndex)
	Sets Part/Surface/Edge calculation for excitation point. More...

DataSet *	GetCaseDataSet (int caseno, int index=0)
	Returns DataSet for a specified case. More...

String	GetCoordinateName ()
	Returns the name of the coordinate system of transfer function model. More...

DataSet *	GetDataSet (int index=0)
	Returns a DataSet object. More...

String	GetExcitationCalculationType (Variant &indexName)
	Returns the calculation type of excitation point. More...

Condition *	GetExcitationCondition (Variant &indexName)
	Gets the referenced condition. More...

String	GetExcitationName (int index)
	Returns the title of a excitation point. More...

CalculationDefinition *	GetExcitationResultDefinition (Variant &indexName, int slotIndex)
	Gets referenced Part/Surface/Edge calculation result. More...

int	GetExcitationResultDefinitionSeriesIndex (Variant &indexName)
	Gets series ID of calculation result. More...

String	GetForceUnit ()
	Gets force unit. More...

int	GetFourierTransformEndStep ()
	Gets the reference end step for fourier transform. More...

String	GetFourierTransformPeriodicity ()
	Gets the periodicity of the fourier transform. More...

int	GetFourierTransformStartStep ()
	Gets the reference start step for fourier transform. More...

double	GetFrequency ()
	Gets the frequency. More...

bool	GetGroupExcitationPoints ()
	Gets whether to group the excitation points.

String	GetLengthUnit ()
	Gets length unit. More...

String	GetName ()
	Returns a title. More...

int	GetPoles ()
	Gets the poles' number. More...

String	GetResultDataType ()
	Gets the result data type. More...

String	GetResultType ()
	Gets the result type. More...

double	GetRevolutionSpeed ()

double	GetRotationSpeed ()
	Gets the rotation speed. More...

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

void	LoadTransferFunctionFile (String &path)
	Loads the transfer function file. More...

int	NumExcitationPoints ()
	Returns the number of the excitation points. More...

void	Reset (Variant &indexName)
	Clears this excitation point. More...

void	SetCoordinate (Variant &name)
	Specifies coordinate system for transfer function model by specifying its name or index. More...

void	SetExcitationCondition (Variant &indexName, Condition *condition)
	Sets condition for excitation point. More...

void	SetExcitationResultDefinition (Variant &indexName, int slotIndex, CalculationDefinition *cal, int seriesIndex)
	Sets Part/Surface/Edge calculation for excitation point. More...

void	SetFourierTransformEndStep (Variant &end)
	Sets the reference end step for fourier transform. More...

void	SetFourierTransformPeriodicity (Variant &mode)
	Sets the periodicity for the fourier transform. More...

void	SetFourierTransformStartStep (Variant &begin)
	Sets the reference start step for fourier transform. More...

void	SetFrequency (Variant &frequency)
	Sets the frequency. More...

void	SetGroupExcitationPoints (bool isGroup)
	Groups the excitation points. More...

void	SetName (String &name)
	Specifies a title. More...

void	SetPoles (Variant &poles)
	Set the poles' number. More...

void	SetResultDataType (Variant &mode)
	Sets the result data type. More...

void	SetResultType (Variant &mode)
	Sets the result type. More...

void	SetRevolutionSpeed (Variant &speed)

void	SetRotationSpeed (Variant &speed)
	Sets rotation speed. More...

Detailed Description

VibrationDefinition class is used for vibration calculation.
This class can be obtained from Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetVibrationDefinition(0)

Member Function Documentation

void VibrationDefinition::ClearExcitationResultDefinition	(	Variant &	indexName,
		int	slotIndex
	)

Sets Part/Surface/Edge calculation for excitation point.

Parameters

indexName	Excitation point's ID or name
slotIndex	The ID of the component (0 ~ 2)

DataSet * VibrationDefinition::GetCaseDataSet	(	int	caseno,
		int	index = `0`
	)

Returns DataSet for a specified case.

Parameters

caseno	Case number
index	DataSet number

Returns: DataSet object

caseno is the one-based number.

String VibrationDefinition::GetCoordinateName ( )

Returns the name of the coordinate system of transfer function model.

Returns: Name of the coordinate system

DataSet * VibrationDefinition::GetDataSet ( int index = 0 )

Returns a DataSet object.

Returns: DataSet object

For more information about DataSet, see DataSet .

String VibrationDefinition::GetExcitationCalculationType ( Variant & indexName )

Returns the calculation type of excitation point.

Returns: Excitation point's calculation type
"NoExcitation": This excitation point is not used in vibration calculation.

"Condition": This excitation point references the result from condition for vibration calculation.

"CalculationResult": This excitation point references the part/surface/edge calculation result for vibration calculation.

Condition * VibrationDefinition::GetExcitationCondition ( Variant & indexName )

Gets the referenced condition.

Parameters

indexName Excitation point's ID or name

String VibrationDefinition::GetExcitationName ( int index )

Returns the title of a excitation point.

Returns: Excitation point's title

CalculationDefinition * VibrationDefinition::GetExcitationResultDefinition	(	Variant &	indexName,
		int	slotIndex
	)

Gets referenced Part/Surface/Edge calculation result.

Parameters

indexName	Excitation point's ID or name
slotIndex	The ID of the component (0 ~ 2)

int VibrationDefinition::GetExcitationResultDefinitionSeriesIndex ( Variant & indexName )

Gets series ID of calculation result.

Parameters

indexName Excitation point's ID or name

String VibrationDefinition::GetForceUnit ( )

Gets force unit.

Returns: Force unit's notation

int VibrationDefinition::GetFourierTransformEndStep ( )

Gets the reference end step for fourier transform.

Returns: Reference end step

String VibrationDefinition::GetFourierTransformPeriodicity ( )

Gets the periodicity of the fourier transform.

Returns: The fourier transform periodicity

int VibrationDefinition::GetFourierTransformStartStep ( )

Gets the reference start step for fourier transform.

Returns: Reference start step

double VibrationDefinition::GetFrequency ( )

Gets the frequency.

Returns: Frequency

String VibrationDefinition::GetLengthUnit ( )

Gets length unit.

Returns: Length unit's notation

String VibrationDefinition::GetName ( )

Returns a title.

Returns: Title (string)

int VibrationDefinition::GetPoles ( )

Gets the poles' number.

Returns: Poles number

String VibrationDefinition::GetResultDataType ( )

Gets the result data type.

Returns: The result data type

String VibrationDefinition::GetResultType ( )

Gets the result type.

Returns: The result type

double VibrationDefinition::GetRevolutionSpeed ( )

Deprecated:

Gets the revolution speed.

Returns: Revolution speed

double VibrationDefinition::GetRotationSpeed ( )

Gets the rotation speed.

Returns: Rotation speed

bool VibrationDefinition::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the VibrationDefinition objects in the list are valid

void VibrationDefinition::LoadTransferFunctionFile ( String & path )

Loads the transfer function file.

Parameters

path	Transfer function file path

int VibrationDefinition::NumExcitationPoints ( )

Returns the number of the excitation points.

Returns: Excitation points' number

void VibrationDefinition::Reset ( Variant & indexName )

Clears this excitation point.

Parameters

indexName Excitation point's ID or name

void VibrationDefinition::SetCoordinate ( Variant & name )

Specifies coordinate system for transfer function model by specifying its name or index.

Parameters

name	Name or index of the coordinate system

void VibrationDefinition::SetExcitationCondition	(	Variant &	indexName,
		Condition *	condition
	)

Sets condition for excitation point.

Parameters

indexName	Excitation point's ID or name
condition	The condition for vibration calculation

void VibrationDefinition::SetExcitationResultDefinition	(	Variant &	indexName,
		int	slotIndex,
		CalculationDefinition *	cal,
		int	seriesIndex
	)

Sets Part/Surface/Edge calculation for excitation point.

Parameters

indexName	Excitation point's ID or name
slotIndex	The ID of the component (0 ~ 2)
cal	Part/Surface/Edge calculation result
seriesIndex	The series ID of in calculation result

void VibrationDefinition::SetFourierTransformEndStep ( Variant & end )

Sets the reference end step for fourier transform.

Parameters

end	Reference end step SetFourierTransformEndStep(1); SetFourierTransformEndStep(END_STEP);

void VibrationDefinition::SetFourierTransformPeriodicity ( Variant & mode )

Sets the periodicity for the fourier transform.

Parameters

mode	Mode type "None" or "0" = No periodicity "Half" or "1" = 1/2

void VibrationDefinition::SetFourierTransformStartStep ( Variant & begin )

Sets the reference start step for fourier transform.

Parameters

begin

Reference begin step

SetFourierTransformStartStep(1);

SetFourierTransformStartStep(START_STEP);

void VibrationDefinition::SetFrequency ( Variant & frequency )

Sets the frequency.

Parameters

frequency Frequency

void VibrationDefinition::SetGroupExcitationPoints ( bool isGroup )

Groups the excitation points.

Parameters

isGroup

True : Group the excitation points

False : Do not group the excitation points

void VibrationDefinition::SetName ( String & name )

Specifies a title.

Parameters

name Name

void VibrationDefinition::SetPoles ( Variant & poles )

Set the poles' number.

Parameters

poles

Poles' number

SetPoles(4);

SetPoles(NUM_POLE);

void VibrationDefinition::SetResultDataType ( Variant & mode )

Sets the result data type.

Parameters

mode	Mode type "AmplitudePhase" or "0" = AmplitudePhase "RealImag" or "1" = RealImag

void VibrationDefinition::SetResultType ( Variant & mode )

Sets the result type.

Parameters

mode	Mode type "Acceleration" or "1" = Acceleration "Velocity" or "2" = Velocity "Displacement" or "3" = Displacement

void VibrationDefinition::SetRevolutionSpeed ( Variant & speed )

Deprecated:

Sets revolution speed.

Parameters

speed

Revolution speed

SetRevolutionSpeed(2000);

SetRevolutionSpeed(REVOLUTION_SPEED);

void VibrationDefinition::SetRotationSpeed ( Variant & speed )

Sets rotation speed.

Parameters

speed

Rotation speed

SetRotationSpeed(2000);

SetRotationSpeed(REVOLUTION_SPEED);

Public Member Functions

Detailed Description

Member Function Documentation