NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::Xyplot::AxisStyleSetting Class Reference

Represents the axis display style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::AxisStyleSetting:
NXOpen::CAE::Xyplot::BaseDisplayStyleSetting NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle NXOpen::CAE::Xyplot::AxisYStyleSetting NXOpen::CAE::Xyplot::ColorAxisStyleSetting

Public Member Functions

NXOpen::CAE::Xyplot::AxisType AxisType ()
 Returns the axis scale type
Created in NX9.0.0. More...
 
int DbDecades ()
 Returns the number of dB decades to display. More...
 
double DbRef ()
 Returns the dB reference value for a dB axis type. More...
 
NXOpen::CAE::Xyplot::AxisDBScale DbScale ()
 Returns the dB scale. More...
 
NXOpen::CAE::SignalProcessingDBSettingsGetDBSettings ()
 Gets the dB settings. More...
 
NXOpen::CAE::FTK::BaseUnitGetDisplayUnit ()
 Gets display unit. More...
 
void GetFixedLimits (double *lowerLimit, double *upperLimit)
 Gets the fixed limits
Created in NX12.0.0. More...
 
NXOpen::CAE::Xyplot::CustomTextStyleSettingGetLabelStyle ()
 Gets the label style. More...
 
NXOpen::CAE::Xyplot::TextStyleSettingGetNumberStyle ()
 Gets the number style. More...
 
int GraphOverhead ()
 Returns the round value to display. More...
 
NXOpen::CAE::Xyplot::LimitsType LimitsType ()
 Returns the limits type
Created in NX12.0.0. More...
 
int LogDecades ()
 Returns the number of Log decades to display. More...
 
void LogUnitChangedEvent ()
 Logs an update event for changing display unit before committing AxisStyleSetting change. More...
 
void SetAxisType (NXOpen::CAE::Xyplot::AxisType axisType)
 Sets the axis scale type
Created in NX9.0.0. More...
 
void SetDbDecades (int dbDecades)
 Sets the number of dB decades to display. More...
 
void SetDbRef (double dbRef)
 Sets the dB reference value for a dB axis type. More...
 
void SetDbScale (NXOpen::CAE::Xyplot::AxisDBScale dbScale)
 Sets the dB scale. More...
 
void SetFixedLimits (double lowerLimit, double upperLimit)
 Sets the fixed limits
Created in NX12.0.0. More...
 
void SetGraphOverhead (int graphOverhead)
 Sets the round value to display. More...
 
void SetLimitsType (NXOpen::CAE::Xyplot::LimitsType limitsType)
 Sets the limits type
Created in NX12.0.0. More...
 
void SetLogDecades (int logDecades)
 Sets the number of Log decades to display. More...
 
void SetUnitSystem (NXOpen::CAE::Xyplot::UnitSystem unitSystem)
 Sets the unit system
More...
 
void SetUnitSystemType (NXOpen::CAE::XyFunctionUnitSystem unitSystemType)
 Sets the unit system type
Created in NX12.0.0. More...
 
NXOpen::CAE::Xyplot::UnitSystem UnitSystem ()
 Returns the unit system
More...
 
NXOpen::CAE::XyFunctionUnitSystem UnitSystemType ()
 Returns the unit system type
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseDisplayStyleSetting
virtual void CommitChange ()
 Commits any edits that have been applied to the display style. More...
 
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual
NXOpen::CAE::Xyplot::IDisplayStyle
Owner ()
 Returns the owner style
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the axis display style.

Call CAE::Xyplot::BaseDisplayStyleSetting::CommitChange to apply style changes to corresponding plot after it's modified.
Not support KF.

Created in NX9.0.0.

Member Function Documentation

NXOpen::CAE::Xyplot::AxisType NXOpen::CAE::Xyplot::AxisStyleSetting::AxisType ( )

Returns the axis scale type
Created in NX9.0.0.



License requirements : None

int NXOpen::CAE::Xyplot::AxisStyleSetting::DbDecades ( )

Returns the number of dB decades to display.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeDb .

Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX9.0.0.

License requirements : None

double NXOpen::CAE::Xyplot::AxisStyleSetting::DbRef ( )

Returns the dB reference value for a dB axis type.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeDb .

Deprecated:
Deprecated in NX12.0.0. Use NXOpen::CAE::SignalProcessingDBSettings::DBReference


Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::AxisDBScale NXOpen::CAE::Xyplot::AxisStyleSetting::DbScale ( )

Returns the dB scale.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeDb .

Deprecated:
Deprecated in NX12.0.0. Use NXOpen::CAE::SignalProcessingDBSettings::DBFormat


Created in NX9.0.0.

License requirements : None

NXOpen::CAE::SignalProcessingDBSettings* NXOpen::CAE::Xyplot::AxisStyleSetting::GetDBSettings ( )

Gets the dB settings.

Returns

Created in NX11.0.0.

License requirements : None
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::Xyplot::AxisStyleSetting::GetDisplayUnit ( )

Gets display unit.

Returns

Created in NX12.0.0.

License requirements : None
void NXOpen::CAE::Xyplot::AxisStyleSetting::GetFixedLimits ( double *  lowerLimit,
double *  upperLimit 
)

Gets the fixed limits
Created in NX12.0.0.



License requirements : None

Parameters
lowerLimitlowerlimit
upperLimitupperlimit
NXOpen::CAE::Xyplot::CustomTextStyleSetting* NXOpen::CAE::Xyplot::AxisStyleSetting::GetLabelStyle ( )

Gets the label style.

Returns

Created in NX11.0.0.

License requirements : None
NXOpen::CAE::Xyplot::TextStyleSetting* NXOpen::CAE::Xyplot::AxisStyleSetting::GetNumberStyle ( )

Gets the number style.

Returns

Created in NX11.0.0.

License requirements : None
int NXOpen::CAE::Xyplot::AxisStyleSetting::GraphOverhead ( )

Returns the round value to display.

It is a percent value. Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is not CAE::Xyplot::AxisTypeAuto .

Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::LimitsType NXOpen::CAE::Xyplot::AxisStyleSetting::LimitsType ( )

Returns the limits type
Created in NX12.0.0.



License requirements : None

int NXOpen::CAE::Xyplot::AxisStyleSetting::LogDecades ( )

Returns the number of Log decades to display.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeLog .
Created in NX9.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::AxisStyleSetting::LogUnitChangedEvent ( )

Logs an update event for changing display unit before committing AxisStyleSetting change.


Created in NX12.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::AxisStyleSetting::SetAxisType ( NXOpen::CAE::Xyplot::AxisType  axisType)

Sets the axis scale type
Created in NX9.0.0.



License requirements : None

Parameters
axisTypeaxistype
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetDbDecades ( int  dbDecades)

Sets the number of dB decades to display.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeDb .

Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX9.0.0.

License requirements : None

Parameters
dbDecadesdbdecades
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetDbRef ( double  dbRef)

Sets the dB reference value for a dB axis type.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeDb .

Deprecated:
Deprecated in NX12.0.0. Use NXOpen::CAE::SignalProcessingDBSettings::SetDBReference


Created in NX9.0.0.

License requirements : None

Parameters
dbRefdbref
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetDbScale ( NXOpen::CAE::Xyplot::AxisDBScale  dbScale)

Sets the dB scale.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeDb .

Deprecated:
Deprecated in NX12.0.0. Use NXOpen::CAE::SignalProcessingDBSettings::SetDBFormat


Created in NX9.0.0.

License requirements : None

Parameters
dbScaledbscale
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetFixedLimits ( double  lowerLimit,
double  upperLimit 
)

Sets the fixed limits
Created in NX12.0.0.



License requirements : None

Parameters
lowerLimitlowerlimit
upperLimitupperlimit
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetGraphOverhead ( int  graphOverhead)

Sets the round value to display.

It is a percent value. Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is not CAE::Xyplot::AxisTypeAuto .

Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX9.0.0.

License requirements : None

Parameters
graphOverheadgraphoverhead
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetLimitsType ( NXOpen::CAE::Xyplot::LimitsType  limitsType)

Sets the limits type
Created in NX12.0.0.



License requirements : None

Parameters
limitsTypelimitstype
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetLogDecades ( int  logDecades)

Sets the number of Log decades to display.

Avaliable when CAE::Xyplot::AxisStyleSetting::AxisType and CAE::Xyplot::AxisStyleSetting::SetAxisType is CAE::Xyplot::AxisTypeLog .
Created in NX9.0.0.

License requirements : None

Parameters
logDecadeslogdecades
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetUnitSystem ( NXOpen::CAE::Xyplot::UnitSystem  unitSystem)

Sets the unit system

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::AxisStyleSetting::SetUnitSystemType instead.


Created in NX9.0.0.

License requirements : None

Parameters
unitSystemunitsystem
void NXOpen::CAE::Xyplot::AxisStyleSetting::SetUnitSystemType ( NXOpen::CAE::XyFunctionUnitSystem  unitSystemType)

Sets the unit system type
Created in NX12.0.0.



License requirements : None

Parameters
unitSystemTypeunitsystemtype
NXOpen::CAE::Xyplot::UnitSystem NXOpen::CAE::Xyplot::AxisStyleSetting::UnitSystem ( )

Returns the unit system

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::CAE::Xyplot::AxisStyleSetting::UnitSystemType instead.


Created in NX9.0.0.

License requirements : None

NXOpen::CAE::XyFunctionUnitSystem NXOpen::CAE::Xyplot::AxisStyleSetting::UnitSystemType ( )

Returns the unit system type
Created in NX12.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.