NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::SimBCDisplay Class Reference

Represents a BC display attributes. More...

Inheritance diagram for NXOpen::CAE::SimBCDisplay:
NXOpen::TaggedObject

List of all members.

Public Types

enum  Mode { ModeCollapse, ModeExpand }
 Used to specify the display mode for the BC. More...

Public Member Functions

NXString DisplayMagnitudeProperty ()
 Returns the neutral name of the property that will control the display
Created in NX7.5.0.
NXOpen::CAE::SimBCDisplay::Mode DisplayMode ()
 Returns the BC display mode
Created in NX4.0.0.
bool DistValueDisplayFlag ()
 Returns the true/false flag based on whether the distributed value of the BC is displayed in the graphics window
Created in NX7.5.0.
bool DofDisplayFlag ()
 Returns the true/false flag based on whether the dof of the BC is displayed in the graphics window
Created in NX4.0.0.
void GetDisplayGrid (int *numUPoints, int *numVPoints)
 Returns the number of sample points for BC display in first and second parametric direction for a face.
bool GraphicSymbolDisplayFlag ()
 Returns the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window
Created in NX4.0.0.
bool HighlightTargets ()
 Returns the flag indicating whether or not highlighting of targets is required
Created in NX5.0.0.
bool NameDisplayFlag ()
 Returns the true/false flag based on whether the name of the BC is displayed in the graphics window
Created in NX4.0.0.
bool NodeIdDisplayFlag ()
 Returns the true/false flag based on whether the node id of the BC is displayed in the graphics window
Created in NX4.0.0.
int Scale ()
 Returns the BC display scaling factor this option specifies the scale of the graphic symbol relative to the size of the bounding box of the FE model.
void SetDisplayGrid (int numUPoints, int numVPoints)
 Sets the number of sample points for BC display in first and second parametric direction for a face.
void SetDisplayMagnitudeProperty (const NXString &displayMagnitudeProperty)
 Sets the neutral name of the property that will control the display
Created in NX7.5.0.
void SetDisplayMode (NXOpen::CAE::SimBCDisplay::Mode displayMode)
 Sets the BC display mode
Created in NX4.0.0.
void SetDistValueDisplayFlag (bool valueFlag)
 Sets the true/false flag based on whether the distributed value of the BC is displayed in the graphics window
Created in NX7.5.0.
void SetDofDisplayFlag (bool dofFlag)
 Sets the true/false flag based on whether the dof of the BC is displayed in the graphics window
Created in NX4.0.0.
void SetGraphicSymbolDisplayFlag (bool graphicSymbolFlag)
 Sets the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window
Created in NX4.0.0.
void SetHighlightTargets (bool highlightTargetsFlag)
 Sets the flag indicating whether or not highlighting of targets is required
Created in NX5.0.0.
void SetNameDisplayFlag (bool nameFlag)
 Sets the true/false flag based on whether the name of the BC is displayed in the graphics window
Created in NX4.0.0.
void SetNodeIdDisplayFlag (bool nodeIdFlag)
 Sets the true/false flag based on whether the node id of the BC is displayed in the graphics window
Created in NX4.0.0.
void SetScale (int scale)
 Sets the BC display scaling factor this option specifies the scale of the graphic symbol relative to the size of the bounding box of the FE model.
void SetShadeGraphicSymbol (bool shadeGsymbolFlag)
 Sets the flag indicating whether or not shading of graphic symbols is required
Created in NX4.0.0.
void SetSolverCardNameDisplayFlag (bool solverCardNameFlag)
 Sets the true/false flag based on whether the solver card name of the BC is displayed in the graphics window
Created in NX4.0.0.
void SetTextSymbolDisplayFlag (bool textSymbolFlag)
 Sets the true/false flag based on whether the text symbol of the BC is displayed in the graphics window
Created in NX4.0.0.
void SetValueDisplayFlag (bool valueFlag)
 Sets the true/false flag based on whether the value of the BC is displayed in the graphics window
Created in NX4.0.0.
bool ShadeGraphicSymbol ()
 Returns the flag indicating whether or not shading of graphic symbols is required
Created in NX4.0.0.
bool SolverCardNameDisplayFlag ()
 Returns the true/false flag based on whether the solver card name of the BC is displayed in the graphics window
Created in NX4.0.0.
bool TextSymbolDisplayFlag ()
 Returns the true/false flag based on whether the text symbol of the BC is displayed in the graphics window
Created in NX4.0.0.
void UpdateDisplay ()
 Updates the display of the BC.
bool ValueDisplayFlag ()
 Returns the true/false flag based on whether the value of the BC is displayed in the graphics window
Created in NX4.0.0.

Detailed Description

Represents a BC display attributes.


Created in NX4.0.0.


Member Enumeration Documentation

Used to specify the display mode for the BC.

Enumerator:
ModeCollapse 

Set a collapsed display.

ModeExpand 

Set and expanded display.


Member Function Documentation

Returns the neutral name of the property that will control the display
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the BC display mode
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the true/false flag based on whether the distributed value of the BC is displayed in the graphics window
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the true/false flag based on whether the dof of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::SimBCDisplay::GetDisplayGrid ( int *  numUPoints,
int *  numVPoints 
)

Returns the number of sample points for BC display in first and second parametric direction for a face.

In case of an edge/curve only the first parametric direction applies.


Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
numUPointsnumber of points in the first parametric direction
numVPointsnumber of points in the second parametric direction

Returns the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the flag indicating whether or not highlighting of targets is required
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the true/false flag based on whether the name of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the true/false flag based on whether the node id of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the BC display scaling factor this option specifies the scale of the graphic symbol relative to the size of the bounding box of the FE model.


Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::SimBCDisplay::SetDisplayGrid ( int  numUPoints,
int  numVPoints 
)

Sets the number of sample points for BC display in first and second parametric direction for a face.

In case of an edge/curve only the first parametric direction applies.


Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
numUPointsnumber of points in the first parametric direction
numVPointsnumber of points in the second parametric direction
void NXOpen::CAE::SimBCDisplay::SetDisplayMagnitudeProperty ( const NXString displayMagnitudeProperty)

Sets the neutral name of the property that will control the display
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
displayMagnitudePropertyneutral name of existing property

Sets the BC display mode
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
displayModethe display mode

Sets the true/false flag based on whether the distributed value of the BC is displayed in the graphics window
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
valueFlagtrue when the distributed values should be displayed, false otherwise

Sets the true/false flag based on whether the dof of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
dofFlagtrue when the dof should be displayed, false otherwise

Sets the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
graphicSymbolFlagtrue when the graphic symbol should be displayed, false otherwise
void NXOpen::CAE::SimBCDisplay::SetHighlightTargets ( bool  highlightTargetsFlag)

Sets the flag indicating whether or not highlighting of targets is required
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
highlightTargetsFlagtrue when highlighting is required, false otherwise

Sets the true/false flag based on whether the name of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
nameFlagtrue when the name should be displayed, false otherwise

Sets the true/false flag based on whether the node id of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
nodeIdFlagtrue when the node id should be displayed, false otherwise

Sets the BC display scaling factor this option specifies the scale of the graphic symbol relative to the size of the bounding box of the FE model.


Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
scale1 is the smallest - 100 is the largest
void NXOpen::CAE::SimBCDisplay::SetShadeGraphicSymbol ( bool  shadeGsymbolFlag)

Sets the flag indicating whether or not shading of graphic symbols is required
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
shadeGsymbolFlagtrue when shading is required, false otherwise

Sets the true/false flag based on whether the solver card name of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
solverCardNameFlagtrue when the solver card name should be displayed, false otherwise

Sets the true/false flag based on whether the text symbol of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
textSymbolFlagtrue when the text symbol should be displayed, false otherwise

Sets the true/false flag based on whether the value of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters:
valueFlagtrue when the value should be displayed, false otherwise

Returns the flag indicating whether or not shading of graphic symbols is required
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the true/false flag based on whether the solver card name of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the true/false flag based on whether the text symbol of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Updates the display of the BC.


Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns the true/false flag based on whether the value of the BC is displayed in the graphics window
Created in NX4.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")


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