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

Inheritance diagram for NXOpen::CAE::PostAnnotationBuilder:

Public Types
enum	Type { TypeEntity, TypeMin, TypeMax, TypeUserloc }
	select option to define the annotation type More...

Public Member Functions
NXOpen::CAE::PostAnnotation *	CommitAnnotation ()
	Commits the annotation to create annotation object. More...

void	Delete ()
	Deletes the annotation builder. More...

void	SetAnnotationType (NXOpen::CAE::PostAnnotationBuilder::Type type)
	Set the annotation type Created in NX11.0.0. More...

void	SetCoordinate (double xcord, double ycord)
	Set the coordinates for user annotation Created in NX11.0.0. More...

void	SetEdgeFace (const std::vector< int > &subIds)
	Set the edge or face id for which annotation is defined Created in NX11.0.0. More...

void	SetElements (const std::vector< int > &elementIds)
	Set the element ids for which annotation is defined Created in NX11.0.0. More...

void	SetName (const NXString &name)
	Set the annotation name Created in NX11.0.0. More...

void	SetName (const char *name)
	Set the annotation name Created in NX11.0.0. More...

void	SetNodes (const std::vector< int > &nodeIds)
	Set the node ids for which annotation is defined Created in NX11.0.0. More...

void	SetNumMinMax (int numMinMax)
	Set the number of min/max annotation for min/max type of annotation Created in NX11.0.0. More...

void	SetResults (const std::vector< NXOpen::CAE::Result * > &results)
	Set the result index for which annotation is defined Created in NX12.0.0. More...

void	SetSectionAngles (const std::vector< double > &sectionAngles)
	Set the section angles for axis-symmetric model for which annotation is defined. More...

void	SetSectors (const std::vector< int > &sectorIds)
	Set the sector ids for cyclic-symmetric model for which annotation is defined Created in NX11.0.0. More...

void	SetUpdateEntityOnResultChange (bool update)
	Set weather entity is to be updated in case of result update for min/max annotation Created in NX11.0.0. More...

void	SetUsertext (const std::vector< NXString > &usertext)
	Set the user text Created in NX11.0.0. More...

virtual	~PostAnnotationBuilder ()
	Frees the object from memory. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. 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
TypeEntity	entity
TypeMin	min
TypeMax	max
TypeUserloc	userloc

Constructor & Destructor Documentation

virtual NXOpen::CAE::PostAnnotationBuilder::~PostAnnotationBuilder ( )

virtual

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

Member Function Documentation

NXOpen::CAE::PostAnnotation* NXOpen::CAE::PostAnnotationBuilder::CommitAnnotation ( )

Commits the annotation to create annotation object.

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

void NXOpen::CAE::PostAnnotationBuilder::Delete ( )

Deletes the annotation builder.

Created in NX11.0.0.

License requirements : None

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 type

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	xcord
ycord	ycord

void NXOpen::CAE::PostAnnotationBuilder::SetEdgeFace ( const std::vector< 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 subids

void NXOpen::CAE::PostAnnotationBuilder::SetElements ( const std::vector< 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 elementids

void NXOpen::CAE::PostAnnotationBuilder::SetName ( const NXString & 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 name

void NXOpen::CAE::PostAnnotationBuilder::SetName ( const char * 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 name

void NXOpen::CAE::PostAnnotationBuilder::SetNodes ( const std::vector< 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 nodeids

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 numminmax

void NXOpen::CAE::PostAnnotationBuilder::SetResults ( const std::vector< 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 results

void NXOpen::CAE::PostAnnotationBuilder::SetSectionAngles ( const std::vector< 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 sectionangles

void NXOpen::CAE::PostAnnotationBuilder::SetSectors ( const std::vector< 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 sectorids

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 update

void NXOpen::CAE::PostAnnotationBuilder::SetUsertext ( const std::vector< NXString > & 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:

CAE_PostAnnotationBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation