NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAE.PostGraphAlongPathBuilder Class Reference

Represents a NXOpen.CAE.PostGraphAlongPathBuilder More...

Inheritance diagram for NXOpen.CAE.PostGraphAlongPathBuilder:
NXOpen.CAE.PostGraphBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  CoordinateSysAxis { FirstAxis, SecondAxis, ThirdAxis }
 options for defining the specific coordinate system axis to be used More...
 
enum  CsysType { Cartesian, Cylindrical, Spherical }
 csys types More...
 
enum  Xaxis { IDs, PathLength, LengthAlongDirection, CoordinateValueOfCoordinateSystemAxis }
 select option to define the path as x axis More...
 
- Public Types inherited from NXOpen.CAE.PostGraphBuilder
enum  DataErrorHandling { Skip, UserValue }
 error handling option when result values are not present for the selected entities More...
 
enum  EdgeIntegralOption { Length, Area }
 weighted Average / Integral calculation based on weighted average by on selection of Edge More...
 
enum  EntityType {
  Node, Element, Point, Edge,
  Face, Body
}
 types of the entity objects which are selected More...
 
enum  EvalutionErrors { Skip, UserValue, Abort }
 error handling option when there are expression evaluation errors while evaluating the formula More...
 
enum  FaceIntegralOption { Area, Volume }
 weighted Average/ Integral calculation based on weighted average by on selection of Face More...
 
enum  GeometryValue {
  Average, Minimum, Maximum, Sum,
  WeightedAverage, Integral
}
 This option is used to when the geometric entity selected has multiple result values. More...
 
enum  IncompatibleResult { Skip, Abort }
 error handling option when incompactible results are selected More...
 
enum  NodalCombination {
  Average, Minimum, Maximum, Sum,
  None
}
 nodal combination option for determining the nodal result value for element and element-nodal result More...
 

Public Member Functions

unsafe void SetCsys (NXOpen.Matrix3x3 csys)
 Set csys for extracting data for x axis More...
 
unsafe void SetCsysType (NXOpen.CAE.PostGraphAlongPathBuilder.CsysType csystype)
 Sets csys type for extracting abscissa More...
 
unsafe void SetOrigin (NXOpen.Point3d origin)
 Set vector origin for extracting data for x axis More...
 
unsafe void SetVector (NXOpen.Point3d unitvector)
 Set vector for extracting data for x axis More...
 
- Public Member Functions inherited from NXOpen.CAE.PostGraphBuilder
unsafe NXOpen.Fields.FieldTable GetFieldTable ()
 Gets the field which is created when user sets the NXOpen.CAE.PostGraphBuilder.CreateFieldOption to true for across iterations type of graphs More...
 
unsafe void SetEntityIds (bool isnodal, int[] entityIds)
 Set entity ids for extracting result data More...
 
unsafe void SetEntityObjects (NXOpen.TaggedObject[] entityObjs)
 Sets the entity objects for extracting result data. More...
 
unsafe void SetFreePoints (NXOpen.Point3d[] freePoints)
 Set free points for extracting data More...
 
unsafe void SetSelectionEntityObjects (NXOpen.CAE.PostSelectionEntity[] selectionEntities)
 Sets the selection entity object. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.CAE.PostGraphAlongPathBuilder.CoordinateSysAxis 
CsysAxis [get, set]
 Returns or sets the option to define the coordinate system axis to be used when x axis defined by NXOpen.CAE.PostGraphAlongPathBuilder.Xaxis.CoordinateValueOfCoordinateSystemAxis More...
 
unsafe bool DefineByPathOption [get, set]
 Returns or sets a value indicating whether the x axis is define by a path ID. More...
 
unsafe bool IncludeItersectionsOption [get, set]
 Returns or sets the value indicating whether to include intersections points while defining the x axis along the path More...
 
unsafe int PathId [get, set]
 Returns or sets the path id to define the x axis with path More...
 
unsafe
NXOpen.CAE.QueryCurveUsageOptions 
QueryCurveUsageOptions [get]
 Returns the query curve usage options More...
 
unsafe
NXOpen.CAE.PostGraphAlongPathBuilder.Xaxis 
XaxisOption [get, set]
 Returns or sets the option for defining the x axis of the graph. More...
 
- Properties inherited from NXOpen.CAE.PostGraphBuilder
unsafe
NXOpen.CAE.Xyplot.ComplexOption2D 
ComplexGraphTypes [get, set]
 Returns or sets the complex plot display option while plotting complex result type More...
 
unsafe bool CreateFieldOption [get, set]
 Returns or sets the option to create field of the across iteration graph created by expression More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.EdgeIntegralOption 
EdgeIntegralOptionValue [get, set]
 Returns or sets the weighted average or integral option on selecting Edge More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.EvalutionErrors 
EvalutionErrorsOption [get, set]
 Returns or sets the error handling option when there are evaluation errors on selected entities or path More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.FaceIntegralOption 
FaceIntegralOptionValue [get, set]
 Returns or sets the weighted average or integral option on selecting Face More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.GeometryValue 
GeometryCombinationValue [get, set]
 Returns or sets the geometry value option in case of edge, face or body selection More...
 
unsafe string GraphTitle [get, set]
 Returns or sets the graph title More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.IncompatibleResult 
IncompatibleResultOption [get, set]
 Returns or sets the error handling option when results are not compatible on selected entities or path More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.NodalCombination 
NodalCombinationValue [get, set]
 Returns or sets the nodal combination option for determining the nodal value for element and element-nodal results This method has been deprecated. More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.DataErrorHandling 
NoDataOption [get, set]
 Returns or sets the error handling option when result is not present on selected entities or path More...
 
unsafe bool SaveAfuOption [get, set]
 Returns or sets the save in AFU option to save graph data as AFU records More...
 
unsafe
NXOpen.CAE.PostGraphBuilder.EntityType 
SelectedEntityType [get, set]
 Returns or sets the entity type of the tags of entities which passed using SetEntityObjects function More...
 
unsafe double UserData [get, set]
 Returns or sets the error handling value used when error occurs or no data present on entities More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.CAE.PostGraphAlongPathBuilder

This is an abstract class and cannot be instantiated

Default values.

Property Value

QueryCurveUsageOptions.CurveUsage

UseVertices

QueryCurveUsageOptions.DistanceTolerance

0

QueryCurveUsageOptions.ResultantCurveLocator

UseAsIs

QueryCurveUsageOptions.ResultantLocationTolerance

0

Created in NX9.0.0

Member Enumeration Documentation

options for defining the specific coordinate system axis to be used

Enumerator
FirstAxis 
SecondAxis 
ThirdAxis 

csys types

Enumerator
Cartesian 
Cylindrical 
Spherical 

select option to define the path as x axis

Enumerator
IDs 
PathLength 
LengthAlongDirection 
CoordinateValueOfCoordinateSystemAxis 

Member Function Documentation

unsafe void NXOpen.CAE.PostGraphAlongPathBuilder.SetCsys ( NXOpen.Matrix3x3  csys)
inline

Set csys for extracting data for x axis

Created in NX9.0.0

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

Parameters
csys
unsafe void NXOpen.CAE.PostGraphAlongPathBuilder.SetCsysType ( NXOpen.CAE.PostGraphAlongPathBuilder.CsysType  csystype)
inline

Sets csys type for extracting abscissa

Created in NX9.0.0

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

Parameters
csystypeset csys type
unsafe void NXOpen.CAE.PostGraphAlongPathBuilder.SetOrigin ( NXOpen.Point3d  origin)
inline

Set vector origin for extracting data for x axis

Created in NX9.0.0

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

Parameters
origin
unsafe void NXOpen.CAE.PostGraphAlongPathBuilder.SetVector ( NXOpen.Point3d  unitvector)
inline

Set vector for extracting data for x axis

Created in NX9.0.0

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

Parameters
unitvector

Property Documentation

unsafe NXOpen.CAE.PostGraphAlongPathBuilder.CoordinateSysAxis NXOpen.CAE.PostGraphAlongPathBuilder.CsysAxis
getset

Returns or sets the option to define the coordinate system axis to be used when x axis defined by NXOpen.CAE.PostGraphAlongPathBuilder.Xaxis.CoordinateValueOfCoordinateSystemAxis

Created in NX9.0.0

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

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

unsafe bool NXOpen.CAE.PostGraphAlongPathBuilder.DefineByPathOption
getset

Returns or sets a value indicating whether the x axis is define by a path ID.

If true, you need to set NXOpen.CAE.PostGraphAlongPathBuilder.PathId

Created in NX9.0.0

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

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

unsafe bool NXOpen.CAE.PostGraphAlongPathBuilder.IncludeItersectionsOption
getset

Returns or sets the value indicating whether to include intersections points while defining the x axis along the path

Created in NX9.0.0

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

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

unsafe int NXOpen.CAE.PostGraphAlongPathBuilder.PathId
getset

Returns or sets the path id to define the x axis with path

Created in NX9.0.0

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

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

unsafe NXOpen.CAE.QueryCurveUsageOptions NXOpen.CAE.PostGraphAlongPathBuilder.QueryCurveUsageOptions
get

Returns the query curve usage options

Created in NX11.0.0

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

unsafe NXOpen.CAE.PostGraphAlongPathBuilder.Xaxis NXOpen.CAE.PostGraphAlongPathBuilder.XaxisOption
getset

Returns or sets the option for defining the x axis of the graph.

If the option NXOpen.CAE.PostGraphAlongPathBuilder.Xaxis.CoordinateValueOfCoordinateSystemAxis is set use NXOpen.CAE.PostGraphAlongPathBuilder.SetCsys , NXOpen.CAE.PostGraphAlongPathBuilder.SetCsysType needs to be used to specify csys and csys type and use NXOpen.CAE.PostGraphAlongPathBuilder.CsysAxis If the option NXOpen.CAE.PostGraphAlongPathBuilder.Xaxis.LengthAlongDirection is set use NXOpen.CAE.PostGraphAlongPathBuilder.SetOrigin , NXOpen.CAE.PostGraphAlongPathBuilder.SetVector need to be used to specify vector along which length of the path points will be calculated

Created in NX9.0.0

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

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


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