NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::CAE::PostLegend Class Reference

This class has the information related to post legend. More...

Inheritance diagram for NXOpen::CAE::PostLegend:
NXOpen::TransientObject

Public Member Functions

NXOpen::CAE::PostColorbarGetColorbar ()
 Gets the colorbar object. More...
 
bool GetColorbarVisibility ()
 Gets the colorbar visibility state. More...
 
NXOpen::CAE::PostHeaderGetHeader ()
 Gets the header object. More...
 
bool GetHeaderVisibility ()
 Gets the header visibility state. More...
 
void SetColorbar (NXOpen::CAE::PostColorbar *colorbar)
 Sets the colorbar object
Created in NX1847.0.0. More...
 
void SetColorbarVisibility (bool status)
 Sets the colorbar visibility state
Created in NX1847.0.0. More...
 
void SetHeader (NXOpen::CAE::PostHeader *header)
 Sets the header object
Created in NX1847.0.0. More...
 
void SetHeaderVisibility (bool status)
 Sets the header visibility state
Created in NX1847.0.0. More...
 
virtual ~PostLegend ()
 Destroys the Legend object
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class has the information related to post legend.

This is a placeholder of the whole legend which includes header and colorbar.


An instance of this class can not be created. To obtain the object use NXOpen::CAE::Post::PostviewGetLegend method.

Created in NX1847.0.0.

Constructor & Destructor Documentation

virtual NXOpen::CAE::PostLegend::~PostLegend ( )
virtual

Destroys the Legend object
Created in NX1847.0.0.



License requirements : None

Member Function Documentation

NXOpen::CAE::PostColorbar* NXOpen::CAE::PostLegend::GetColorbar ( )

Gets the colorbar object.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
bool NXOpen::CAE::PostLegend::GetColorbarVisibility ( )

Gets the colorbar visibility state.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
NXOpen::CAE::PostHeader* NXOpen::CAE::PostLegend::GetHeader ( )

Gets the header object.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
bool NXOpen::CAE::PostLegend::GetHeaderVisibility ( )

Gets the header visibility state.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
void NXOpen::CAE::PostLegend::SetColorbar ( NXOpen::CAE::PostColorbar colorbar)

Sets the colorbar object
Created in NX1847.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
colorbarcolorbar
void NXOpen::CAE::PostLegend::SetColorbarVisibility ( bool  status)

Sets the colorbar visibility state
Created in NX1847.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
statusstatus
void NXOpen::CAE::PostLegend::SetHeader ( NXOpen::CAE::PostHeader header)

Sets the header object
Created in NX1847.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
headerheader
void NXOpen::CAE::PostLegend::SetHeaderVisibility ( bool  status)

Sets the header visibility state
Created in NX1847.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
statusstatus

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