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::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle

Public Member Functions

NXOpen::CAE::Xyplot::AxisType AxisType ()
 Returns the axis scale type
Created in NX9.0.0. More...
 
virtual void CommitChange ()
 Commits any edits that have been applied to the display style. 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::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
int GraphOverhead ()
 Returns the round value to display. More...
 
int LogDecades ()
 Returns the number of Log decades to display. More...
 
virtual
NXOpen::CAE::Xyplot::IDisplayStyle
Owner ()
 Returns the owner style
Created in NX10.0.0. 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 SetGraphOverhead (int graphOverhead)
 Sets the round value to display. 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
Created in NX9.0.0. More...
 
NXOpen::CAE::Xyplot::UnitSystem UnitSystem ()
 Returns the unit system
Created in NX9.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::IDisplayStyle::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

virtual void NXOpen::CAE::Xyplot::AxisStyleSetting::CommitChange ( )
virtual

Commits any edits that have been applied to the display style.

Triggers the corresponding plot to update graph.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Implements NXOpen::CAE::Xyplot::IDisplayStyle.

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 .
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 .
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 .
Created in NX9.0.0.

License requirements : None

NXOpen::TaggedObject* NXOpen::CAE::Xyplot::AxisStyleSetting::Find ( const NXString journalIdentifier)

Finds the NXOpen::NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
journalIdentifierJournal identifier of the object
NXOpen::TaggedObject* NXOpen::CAE::Xyplot::AxisStyleSetting::Find ( const char *  journalIdentifier)

Finds the NXOpen::NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
journalIdentifierJournal identifier of the object
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 .
Created in NX9.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

virtual NXOpen::CAE::Xyplot::IDisplayStyle* NXOpen::CAE::Xyplot::AxisStyleSetting::Owner ( )
virtual

Returns the owner style
Created in NX10.0.0.



License requirements : None

Implements NXOpen::CAE::Xyplot::IDisplayStyle.

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

Sets the axis scale type
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

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 .
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

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 .
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

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 .
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
dbScaledbscale
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 .
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters
graphOverheadgraphoverhead
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 : nx_ftk ("NX Advanced Graphing")

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

Sets the unit system
Created in NX9.0.0.



License requirements : nx_ftk ("NX Advanced Graphing")

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

Returns the unit system
Created in NX9.0.0.



License requirements : None


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