RttFileParameter Class Reference

RttFileParameter class is used to export RTT file from Response Table.
The class can be created from Study class.
. More...

Public Member Functions
void	ClearCorrection ()
	Clears the coil correction settings.
void	ClearMotionCorrection ()
	Clears the settings for correction of Motion conditions.
String	GetAuthor ()
	Returns the author name. More...
double	GetAveragedSlotWidth ()
	Returns the average slot width. More...
double	GetAxisLength ()
	Returns the axis length. More...
bool	GetCanDisplayMotorInfo ()
	Returns whether to display motor information. More...
String	GetComments ()
	Returns the comments. More...
double	GetConductivity ()
	Returns the conductivity. More...
double	GetConductorDiameter ()
	Returns the conductor diameter. More...
double	GetConductorHeight ()
	Returns the conductor height. More...
double	GetConductorsSlotHeight ()
	Returns the conductor slot height. More...
double	GetConductorsSlotWidth ()
	Returns the conductor slot width. More...
int	GetConductorType ()
	Returns the conductor type. More...
double	GetConductorWidth ()
	Returns the conductor width. More...
double	GetCoreStackLength ()
	Returns the core stack length. More...
double	GetCorrectionCoilFluxlinkage (String &name)
	Returns the coil flux linkage correction for the coil. More...
double	GetCorrectionReferenceTemperature (String &name)
	Returns the coil reference temperature. More...
double	GetCorrectionTemperatureCoefficient (String &name)
	Returns the coil temperature correction factor. More...
double	GetCorrectionWinding (String &name)
	Returns the coil winding correction. More...
bool	GetHasAdditionalMotorInfo ()
	Returns whether to add motor information. More...
double	GetInertia ()
	Returns the moment of inertia. More...
bool	GetIsResolutionPublic ()
	Returns whether to display resolution. More...
bool	GetIsWindingSettingsPublic ()
	Returns whether winding conductor information is public. More...
String	GetLossFile ()
	Returns the file name in which the loss table is set. More...
double	GetMotionCorrection (String &name)
	Returns the correction value for the Motion condition. More...
double	GetOuterDiameter ()
	Returns the outer diameter. More...
String	GetOutputFilepath ()
	Returns the RTT file output path. More...
double	GetRatedCurrent ()
	Returns the rated current. More...
double	GetRatedOutput ()
	Returns the rated output. More...
double	GetRatedVoltage ()
	Returns the rated voltage. More...
String	GetResponseTableName ()
	Returns the response table name. More...
double	GetResponseTableTemperature ()
	Returns the temperature in the response value table. More...
double	GetRotationSpeed ()
	Returns the rated rotation speed. More...
int	GetSimulatorType ()
	Returns the simulator type. More...
double	GetSlotsPerPhase ()
	Returns the number of slots per phase. More...
String	GetTitle ()
	Returns the title. More...
bool	GetUseComment ()
	Returns whether to display comments. More...
bool	GetUseCopySimulator ()
	Returns whether to copy simulator files. More...
double	GetWeight ()
	Returns the weight. More...
bool	IsValid ()
	Returns True if an object is valid. More...
void	SetAuthor (String &author)
	Specifies the author name. More...
void	SetAveragedSlotWidth (double averageSlotWidth)
	Specifies the average slot width. More...
void	SetAxisLength (double axisLength)
	Specifies the axis length. More...
void	SetCanDisplayMotorInfo (bool canDisplay)
	Specifies whether to display motor information. More...
void	SetComments (String &comment)
	Specifies the comments. More...
void	SetConductivity (double conductivity)
	Specifies the conductivity. More...
void	SetConductorDiameter (double diameter)
	Specifies the conductor diameter. More...
void	SetConductorHeight (double height)
	Specifies the conductor height. More...
void	SetConductorsSlotHeight (double conductorSlotHeight)
	Specifies the conductor slot height. More...
void	SetConductorsSlotWidth (double slotWidth)
	Specifies the conductor slot width. More...
void	SetConductorType (int type)
	Specifies the conductor type. More...
void	SetConductorWidth (double width)
	Specifies the conductor width. More...
void	SetCoreStackLength (double coreStackLength)
	Specifies the core stack length. More...
void	SetCorrection (String &name, double tempCoeff, double refTemp, double winding, double coilFlux)
	Specifies the coil correction value. More...
void	SetHasAdditionalMotorInfo (bool hasAdditionalInfo)
	Specifies whether to add motor information. More...
void	SetInertia (double inertia)
	Specifies the moment of inertia. More...
void	SetIsResolutionPublic (bool isResolution)
	Specifies whether to display resolution. More...
void	SetIsWindingSettingsPublic (bool isWindingPublic)
	Specifies whether to set winding conductor information to public. More...
void	SetLossFile (String &filename)
	Specifies the loss table. More...
void	SetMotionCorrection (String &name, double correction)
	Specifies the correction value for Motion conditions. More...
void	SetOuterDiameter (double outerDiameter)
	Specifies the outer diameter. More...
void	SetOutputFilepath (String &outputFilepath)
	Specifies the RTT output file path. More...
void	SetRatedCurrent (double ratedCurrent)
	Specifies the rated current. More...
void	SetRatedOutput (double ratedOutput)
	Specifies the rated output. More...
void	SetRatedVoltage (double ratedVoltage)
	Specifies the rated voltage. More...
void	SetResponseTableName (String &responseTableName)
	Specifies the response table name. More...
void	SetResponseTableTemperature (double temp)
	Specifies the temperature in the response value table. More...
void	SetRotationSpeed (double rotSpeed)
	Specifies the rated rotation speed. More...
void	SetSimulatorType (int simulatorType)
	Specifies the simulator type. More...
void	SetSlotsPerPhase (double slotPerPhase)
	Specifies the number of slots per phase. More...
void	SetTitle (String &title)
	Specifies the title. More...
void	SetUseComment (bool useComment)
	Specifies whether to display comments. More...
void	SetUseCopySimulator (bool useSimulator)
	Specifies whether to copy simulator files. More...
void	SetWeight (double weight)
	Specifies the weight. More...

Detailed Description

RttFileParameter class is used to export RTT file from Response Table.
The class can be created from Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).CreateRttFileParameter()

Member Function Documentation

String RttFileParameter::GetAuthor

(

)

Returns the author name.

Returns

Author name

double RttFileParameter::GetAveragedSlotWidth

(

)

Returns the average slot width.

Returns

Average slot width

double RttFileParameter::GetAxisLength

(

)

Returns the axis length.

Returns

Axis length

bool RttFileParameter::GetCanDisplayMotorInfo

(

)

Returns whether to display motor information.

Returns

Whether to display motor information.

String RttFileParameter::GetComments

(

)

Returns the comments.

Returns

Comments

double RttFileParameter::GetConductivity

(

)

Returns the conductivity.

Returns

Conductivity

double RttFileParameter::GetConductorDiameter

(

)

Returns the conductor diameter.

Returns

Conductor diameter

double RttFileParameter::GetConductorHeight

(

)

Returns the conductor height.

Returns

Conductor height

double RttFileParameter::GetConductorsSlotHeight

(

)

Returns the conductor slot height.

Returns

Conductor slot height

double RttFileParameter::GetConductorsSlotWidth

(

)

Returns the conductor slot width.

Returns

Conductor slot width

int RttFileParameter::GetConductorType

(

)

Returns the conductor type.

Returns

Conductor type

double RttFileParameter::GetConductorWidth

(

)

Returns the conductor width.

Returns

Conductor width

double RttFileParameter::GetCoreStackLength

(

)

Returns the core stack length.

Returns

Core stack length

double RttFileParameter::GetCorrectionCoilFluxlinkage

(

String &

name

)

Returns the coil flux linkage correction for the coil.

Parameters

name	Title of the parameter

Returns

Coil flux linkage correction

double RttFileParameter::GetCorrectionReferenceTemperature

(

String &

name

)

Returns the coil reference temperature.

Parameters

name	Title of the parameter

Returns

Reference temperature

double RttFileParameter::GetCorrectionTemperatureCoefficient

(

String &

name

)

Returns the coil temperature correction factor.

Parameters

name	Title of the parameter

Returns

Temperature correction factor

double RttFileParameter::GetCorrectionWinding

(

String &

name

)

Returns the coil winding correction.

Parameters

name	Title of the parameter

Returns

Winding correction

bool RttFileParameter::GetHasAdditionalMotorInfo

(

)

Returns whether to add motor information.

Returns

Whether to add motor information

double RttFileParameter::GetInertia

(

)

Returns the moment of inertia.

Returns

Moment of inertia

bool RttFileParameter::GetIsResolutionPublic

(

)

Returns whether to display resolution.

Returns

Whether to display resolution

bool RttFileParameter::GetIsWindingSettingsPublic

(

)

Returns whether winding conductor information is public.

Returns

Whether winding conductor information is public

String RttFileParameter::GetLossFile

(

)

Returns the file name in which the loss table is set.

Returns

File name

double RttFileParameter::GetMotionCorrection

(

String &

name

)

Returns the correction value for the Motion condition.

Parameters

name	Title of the parameter

Returns

Correction value

double RttFileParameter::GetOuterDiameter

(

)

Returns the outer diameter.

Returns

Outer diameter

String RttFileParameter::GetOutputFilepath

(

)

Returns the RTT file output path.

Returns

RTT file output path

double RttFileParameter::GetRatedCurrent

(

)

Returns the rated current.

Returns

Rated current

double RttFileParameter::GetRatedOutput

(

)

Returns the rated output.

Returns

Rated output

double RttFileParameter::GetRatedVoltage

(

)

Returns the rated voltage.

Returns

Rated voltage

String RttFileParameter::GetResponseTableName

(

)

Returns the response table name.

Returns

Response table name

double RttFileParameter::GetResponseTableTemperature

(

)

Returns the temperature in the response value table.

Returns

Response Table Temperature

double RttFileParameter::GetRotationSpeed

(

)

Returns the rated rotation speed.

Returns

Rated rotation speed

int RttFileParameter::GetSimulatorType

(

)

Returns the simulator type.

Returns

Simulator type

double RttFileParameter::GetSlotsPerPhase

(

)

Returns the number of slots per phase.

Returns

Number of slots per phase

String RttFileParameter::GetTitle

(

)

Returns the title.

Returns

Title

bool RttFileParameter::GetUseComment

(

)

Returns whether to display comments.

Returns

Whether to display comments

bool RttFileParameter::GetUseCopySimulator

(

)

Returns whether to copy simulator files.

Returns

Whether to copy simulator files.

double RttFileParameter::GetWeight

(

)

Returns the weight.

Returns

Weight

bool RttFileParameter::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the RttFileParameter object is valid

void RttFileParameter::SetAuthor

(

String &

author

)

Specifies the author name.

Parameters

author

Author name

void RttFileParameter::SetAveragedSlotWidth

(

double

averageSlotWidth

)

Specifies the average slot width.

Parameters

averageSlotWidth

Average slot width

void RttFileParameter::SetAxisLength

(

double

axisLength

)

Specifies the axis length.

Parameters

axisLength

Axis length

void RttFileParameter::SetCanDisplayMotorInfo

(

bool

canDisplay

)

Specifies whether to display motor information.

Parameters

canDisplay

Display motor information flag.

void RttFileParameter::SetComments

(

String &

comment

)

Specifies the comments.

Parameters

comment

Comments

void RttFileParameter::SetConductivity

(

double

conductivity

)

Specifies the conductivity.

Parameters

conductivity

Conductivity

void RttFileParameter::SetConductorDiameter

(

double

diameter

)

Specifies the conductor diameter.

Parameters

diameter

Conductor diameter

void RttFileParameter::SetConductorHeight

(

double

height

)

Specifies the conductor height.

Parameters

height

Conductor height

void RttFileParameter::SetConductorsSlotHeight

(

double

conductorSlotHeight

)

Specifies the conductor slot height.

Parameters

conductorSlotHeight

Conductor slot height

void RttFileParameter::SetConductorsSlotWidth

(

double

slotWidth

)

Specifies the conductor slot width.

Parameters

slotWidth

Conductor slot width

void RttFileParameter::SetConductorType

(

int

type

)

Specifies the conductor type.

Parameters

type	Conductor type

void RttFileParameter::SetConductorWidth

(

double

width

)

Specifies the conductor width.

Parameters

width

Conductor width

void RttFileParameter::SetCoreStackLength

(

double

coreStackLength

)

Specifies the core stack length.

Parameters

coreStackLength

Core stack length

void RttFileParameter::SetCorrection	(	String &	name,
		double	tempCoeff,
		double	refTemp,
		double	winding,
		double	coilFlux
	)

Specifies the coil correction value.

Parameters

name	Title of the parameter
tempCoeff	Temperature coefficient
refTemp	Reference temperature
winding	Winding correction
coilFlux	Coil fluxlinkage correction

void RttFileParameter::SetHasAdditionalMotorInfo

(

bool

hasAdditionalInfo

)

Specifies whether to add motor information.

Parameters

hasAdditionalInfo

Additional motor information flag

void RttFileParameter::SetInertia

(

double

inertia

)

Specifies the moment of inertia.

Parameters

inertia

Moment of inertia

void RttFileParameter::SetIsResolutionPublic

(

bool

isResolution

)

Specifies whether to display resolution.

Parameters

isResolution

Display resolution flag

void RttFileParameter::SetIsWindingSettingsPublic

(

bool

isWindingPublic

)

Specifies whether to set winding conductor information to public.

Parameters

isWindingPublic

Winding conductor information public flag

void RttFileParameter::SetLossFile

(

String &

filename

)

Specifies the loss table.

Parameters

filename

CSV file

void RttFileParameter::SetMotionCorrection	(	String &	name,
		double	correction
	)

Specifies the correction value for Motion conditions.

Parameters

name	Title of the parameter
correction	Correction value

void RttFileParameter::SetOuterDiameter

(

double

outerDiameter

)

Specifies the outer diameter.

Parameters

outerDiameter

Outer diameter

void RttFileParameter::SetOutputFilepath

(

String &

outputFilepath

)

Specifies the RTT output file path.

Parameters

outputPath

RTT output file path

void RttFileParameter::SetRatedCurrent

(

double

ratedCurrent

)

Specifies the rated current.

Parameters

ratedCurrent

Rated current

void RttFileParameter::SetRatedOutput

(

double

ratedOutput

)

Specifies the rated output.

Parameters

ratedOutput

Rated output

void RttFileParameter::SetRatedVoltage

(

double

ratedVoltage

)

Specifies the rated voltage.

Parameters

ratedVoltage

Rated voltage

void RttFileParameter::SetResponseTableName

(

String &

responseTableName

)

Specifies the response table name.

Parameters

responseTableName

Response table name

void RttFileParameter::SetResponseTableTemperature

(

double

temp

)

Specifies the temperature in the response value table.

Parameters

temp	Response Table Temperature

void RttFileParameter::SetRotationSpeed

(

double

rotSpeed

)

Specifies the rated rotation speed.

Parameters

rotSpeed

Rated rotation speed

void RttFileParameter::SetSimulatorType

(

int

simulatorType

)

Specifies the simulator type.

Parameters

simulatorType

Simulator type

void RttFileParameter::SetSlotsPerPhase

(

double

slotPerPhase

)

Specifies the number of slots per phase.

Parameters

slotPerPhase

Number of slots per phase

void RttFileParameter::SetTitle

(

String &

title

)

Specifies the title.

Parameters

title

Title

void RttFileParameter::SetUseComment

(

bool

useComment

)

Specifies whether to display comments.

Parameters

useComment

Display comment flag

void RttFileParameter::SetUseCopySimulator

(

bool

useSimulator

)

Specifies whether to copy simulator files.

Parameters

useSimulator

Copy simulator files flag

void RttFileParameter::SetWeight

(

double

weight

)

Specifies the weight.

Parameters

weight

Weight