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

This class has the information related to post legend custom header lines. More...

Inheritance diagram for NXOpen::CAE::PostCustomHeaderLines:
NXOpen::TransientObject

Classes

struct  HeaderToken
 Container for token and usertext for legend header customization. More...
 

Public Types

enum  Token {
  TokenAbsoluteValue, TokenBeamCsys, TokenBeamSection, TokenCombination,
  TokenComplex, TokenComponent, TokenCrossSectionViewBeamInfo, TokenCsys,
  TokenDeformation, TokenDisplayedMinMax, TokenFormula, TokenIteration,
  TokenLoadcase, TokenModelSummary, TokenPlyIdAndLayer, TokenResult,
  TokenResultEnvironment, TokenResultMinMax, TokenScale, TokenShellSection,
  TokenSolution, TokenSubcase, TokenStreamlineData, TokenUnit,
  TokenUsertext
}
 Header tokens used for customization. More...
 

Public Member Functions

void ClearLines ()
 Deletes all the lines of custom header line list
Created in NX1847.0.0. More...
 
void DeleteNthLine (int index)
 Erases the line at the specified index from the the custom header line list
Created in NX1847.0.0. More...
 
std::vector
< NXOpen::CAE::PostCustomHeaderLines::HeaderToken
GetNthLine (int index)
 Gets the line at the specified index from the custom header line list
Created in NX1847.0.0. More...
 
int GetNumLines ()
 Gets the number of lines in the custom header line list
Created in NX1847.0.0. More...
 
void InsertNthLine (int index, const std::vector< NXOpen::CAE::PostCustomHeaderLines::HeaderToken > &line)
 Inserts a line to the custom header line list at the specified index
Created in NX1847.0.0. More...
 
virtual ~PostCustomHeaderLines ()
 Destroys the 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 custom header lines.


An instance of this class can not be created.

Created in NX1847.0.0.

Member Enumeration Documentation

Header tokens used for customization.

Enumerator
TokenAbsoluteValue 

absolute value

TokenBeamCsys 

beam csys

TokenBeamSection 

beam section

TokenCombination 

combination

TokenComplex 

complex

TokenComponent 

component

TokenCrossSectionViewBeamInfo 

cross section view beam info

TokenCsys 

csys

TokenDeformation 

deformation

TokenDisplayedMinMax 

displayed min max

TokenFormula 

formula

TokenIteration 

iteration

TokenLoadcase 

loadcase

TokenModelSummary 

model summary

TokenPlyIdAndLayer 

ply id and layer

TokenResult 

result

TokenResultEnvironment 

result environment

TokenResultMinMax 

result min max

TokenScale 

scale

TokenShellSection 

shell section

TokenSolution 

solution

TokenSubcase 

subcase

TokenStreamlineData 

streamline data

TokenUnit 

unit

TokenUsertext 

usertext

Constructor & Destructor Documentation

virtual NXOpen::CAE::PostCustomHeaderLines::~PostCustomHeaderLines ( )
virtual

Destroys the object
Created in NX1847.0.0.



License requirements : None

Member Function Documentation

void NXOpen::CAE::PostCustomHeaderLines::ClearLines ( )

Deletes all the lines of custom header line list
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::PostCustomHeaderLines::DeleteNthLine ( int  index)

Erases the line at the specified index from the the custom header line list
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
indexindex
std::vector<NXOpen::CAE::PostCustomHeaderLines::HeaderToken> NXOpen::CAE::PostCustomHeaderLines::GetNthLine ( int  index)

Gets the line at the specified index from the custom header line list
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
indexindex
int NXOpen::CAE::PostCustomHeaderLines::GetNumLines ( )

Gets the number of lines in the custom header line list
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::PostCustomHeaderLines::InsertNthLine ( int  index,
const std::vector< NXOpen::CAE::PostCustomHeaderLines::HeaderToken > &  line 
)

Inserts a line to the custom header line list at the specified index
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
indexindex
lineline

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