NXOpen.CAE.PostAnnotationBuilder Class Reference

Builder to create NXOpen.CAE.PostAnnotation from NXOpen.CAE.Post More...

Inheritance diagram for NXOpen.CAE.PostAnnotationBuilder:

Public Types
enum	Type { Entity, Min, Max, Userloc }
	select option to define the annotation type More...

Public Member Functions
unsafe void	SetAnnotationType (NXOpen.CAE.PostAnnotationBuilder.Type type)
	Set the annotation type More...
unsafe void	SetName (string name)
	Set the annotation name More...
unsafe void	SetElements (int[] elementIds)
	Set the element ids for which annotation is defined More...
unsafe void	SetNodes (int[] nodeIds)
	Set the node ids for which annotation is defined More...
unsafe void	SetEdgeFace (int[] subIds)
	Set the edge or face id for which annotation is defined More...
unsafe void	SetResults (NXOpen.CAE.Result[] results)
	Set the result index for which annotation is defined More...
unsafe void	SetSectors (int[] sectorIds)
	Set the sector ids for cyclic-symmetric model for which annotation is defined More...
unsafe void	SetSectionAngles (double[] sectionAngles)
	Set the section angles for axis-symmetric model for which annotation is defined. More...
unsafe void	SetNumMinMax (int numMinMax)
	Set the number of min/max annotation for min/max type of annotation More...
unsafe void	SetUpdateEntityOnResultChange (bool update)
	Set weather entity is to be updated in case of result update for min/max annotation More...
unsafe void	SetCoordinate (double xcord, double ycord)
	Set the coordinates for user annotation More...
unsafe void	SetUsertext (string[] usertext)
	Set the user text More...
unsafe NXOpen.CAE.PostAnnotation	CommitAnnotation ()
	Commits the annotation to create annotation object More...
unsafe void	Delete ()
	Deletes the annotation builder. More...

Protected Member Functions
override void	FreeResource ()
	Frees the object from memory. More...

Detailed Description

Builder to create NXOpen.CAE.PostAnnotation from NXOpen.CAE.Post

User can pass entities which are same as current postview location.

The entities have to be passed in following manner

• Elemental Result - Use NXOpen.CAE.PostAnnotationBuilder.SetElements only.
• Nodal Result - Use NXOpen.CAE.PostAnnotationBuilder.SetNodes only.
• Element-Nodal Result - Use NXOpen.CAE.PostAnnotationBuilder.SetElements and NXOpen.CAE.PostAnnotationBuilder.SetNodes . Number of entities should be same for both.
• Element-Face Result - Use NXOpen.CAE.PostAnnotationBuilder.SetElements and NXOpen.CAE.PostAnnotationBuilder.SetEdgeFace . Number of entities should be same for both.
• Element-Edge Result - Use NXOpen.CAE.PostAnnotationBuilder.SetElements and NXOpen.CAE.PostAnnotationBuilder.SetEdgeFace . Number of entities should be same for both.
• Element-Face-Node Result - Use NXOpen.CAE.PostAnnotationBuilder.SetElements , NXOpen.CAE.PostAnnotationBuilder.SetNodes and NXOpen.CAE.PostAnnotationBuilder.SetEdgeFace . Number of entities should be same for all three.
• Element-Edge-Node Result - Use NXOpen.CAE.PostAnnotationBuilder.SetElements , NXOpen.CAE.PostAnnotationBuilder.SetNodes and NXOpen.CAE.PostAnnotationBuilder.SetEdgeFace . Number of entities should be same for all three.

Though entities are being passed separately, they work as a set, so no of entities must be same for all.

• Cylic-Symmetric Result Number of Sectors should be same as Number of entities
• Axis-Symmetric Result Number of Angles should be same as number of entities.

To obtain an instance of this class use CAE::Post

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.CAE.PostAnnotationBuilder.Type

select option to define the annotation type

Enumerator
Entity
Min
Max
Userloc

Member Function Documentation

unsafe NXOpen.CAE.PostAnnotation NXOpen.CAE.PostAnnotationBuilder.CommitAnnotation

(

)

Commits the annotation to create annotation object

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")

Returns

unsafe void NXOpen.CAE.PostAnnotationBuilder.Delete

(

)

Deletes the annotation builder.

Created in NX11.0.0

License requirements: None.

override void NXOpen.CAE.PostAnnotationBuilder.FreeResource ( )

protected

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetAnnotationType

(

NXOpen.CAE.PostAnnotationBuilder.Type

type

)

Set the annotation type

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")

Parameters

type

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetCoordinate	(	double	xcord,
		double	ycord
	)

Set the coordinates for user annotation

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")

Parameters

xcord
ycord

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetEdgeFace

(

int[]

subIds

)

Set the edge or face id for which annotation is defined

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")

Parameters

subIds

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetElements

(

int[]

elementIds

)

Set the element ids for which annotation is defined

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")

Parameters

elementIds

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetName

(

string

name

)

Set the annotation name

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")

Parameters

name

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetNodes

(

int[]

nodeIds

)

Set the node ids for which annotation is defined

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")

Parameters

nodeIds

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetNumMinMax

(

int

numMinMax

)

Set the number of min/max annotation for min/max type of annotation

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")

Parameters

numMinMax

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetResults

(

NXOpen.CAE.Result[]

results

)

Set the result index for which annotation is defined

Created in NX12.0.0

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

Parameters

results

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetSectionAngles

(

double[]

sectionAngles

)

Set the section angles for axis-symmetric model for which annotation is defined.

The list of sections depend on current postview and how it is created using NXOpen.CAE.AxiSymmetricParameters

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")

Parameters

sectionAngles

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetSectors

(

int[]

sectorIds

)

Set the sector ids for cyclic-symmetric model for which annotation is defined

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")

Parameters

sectorIds

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetUpdateEntityOnResultChange

(

bool

update

)

Set weather entity is to be updated in case of result update for min/max annotation

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")

Parameters

update

unsafe void NXOpen.CAE.PostAnnotationBuilder.SetUsertext

(

string[]

usertext

)

Set the user text

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")

Parameters

usertext

Additional text in each box

---

The documentation for this class was generated from the following file:

• dotnet_pool/CAE_PostAnnotationBuilder.cs