NXOpen::CAE::SimBcPlotContoursBuilder Class Reference

Represents a CAE::SimBcPlotContoursBuilder builder which can be used to generate a plot of a CAE::SimBC in the graphics area. More...

Inheritance diagram for NXOpen::CAE::SimBcPlotContoursBuilder:

Public Types
enum	PlotType { PlotTypeStatic, PlotTypeAnimation }
	Plot types. More...
enum	ResolveOverlapType {   ResolveOverlapTypeAdd, ResolveOverlapTypeAverage, ResolveOverlapTypeMaximum, ResolveOverlapTypeMinimum,   ResolveOverlapTypeSpecify }
	Resolve overlap types. More...

Public Member Functions
NXOpen::CAE::NxBcPlotContours *	CreatePlotObject ()
	Returns CAE::NxBcPlotContours object.
std::vector< NXOpen::CAE::SimBC * >	GetAvailableBcsToPlot ()
	Returns all available CAE::SimBC to plot.
void	GetAvailablePropertyNamesAndIndicesToPlot (NXOpen::CAE::SimBC *tBc, std::vector< int > &pPropIndices, std::vector< NXString > &pPropNames)
	Returns all available property names and indices that can be plotted for the specified CAE::SimBC
std::vector< NXString >	GetAvailablePropertyNamesToPlot (NXOpen::CAE::SimBC *tBc)
	Returns all available property names that can be plotted for the specified CAE::SimBC.
NXOpen::CAE::SimBcPlotContoursBuilder::PlotType	GetPlotType ()
	Returns plot type.
int	PropertyIndexToPlot ()
	Returns the property index of CAE::SimBC to plot.
NXString	PropertyNameToPlot ()
	Returns the property name of CAE::SimBC to plot.
NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType	ResolveOverlap ()
	Returns a CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values Created in NX8.5.0.
double	ResolveOverlapValue ()
	Returns a overlap value to plot.
NXOpen::Unit *	ResolveOverlapValueUnit ()
	Returns a Unit for overlap value to plot.
void	SetAnimationPoints (double startValue, NXOpen::Unit *startUnit, double endValue, NXOpen::Unit *endUnit, int numFrames)
	Sets animation points Created in NX9.0.0.
void	SetBcsToPlot (const std::vector< NXOpen::CAE::SimBC * > &bcs)
	Sets CAE::SimBC objects to plot.
void	SetBcsToPlot (const std::vector< NXOpen::CAE::SimBC * > &bcs, std::vector< NXString > &propertyNames)
	Sets CAE::SimBC objects and property names to plot .
void	SetEvaluationPoints (const std::vector< double > &values, const std::vector< NXOpen::Unit * > &units)
	Sets evaluation point Created in NX9.0.0.
void	SetPlotType (NXOpen::CAE::SimBcPlotContoursBuilder::PlotType plotType)
	Sets plot type Created in NX9.0.0.
void	SetPropertyIndexToPlot (int propertyIndex)
	Sets the property index of CAE::SimBC to plot.
void	SetPropertyNameToPlot (const NXString &pPropertyName)
	Sets the property name of CAE::SimBC to plot.
void	SetPropertyNameToPlot (const char *pPropertyName)
	Sets the property name of CAE::SimBC to plot.
void	SetResolveOverlap (NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType resolveOverlapType)
	Sets a CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values Created in NX8.5.0.
void	SetResolveOverlapValue (double resolveOverlapValue)
	Sets a overlap value to plot.
void	SetResolveOverlapValueUnit (NXOpen::Unit *resolveOverlapValueUnit)
	Sets a Unit for overlap value to plot.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a CAE::SimBcPlotContoursBuilder builder which can be used to generate a plot of a CAE::SimBC in the graphics area.

This is limited to CAE::SimBC objects in the active solution. CAE::SimBcPlotContoursBuilder::CreatePlotObject returns a plot object CAE::NxBcPlotContours whose CAE::NxBcPlotContours::PlotContour plots contour.
To create a new instance of this class, use CAE::SimSimulation::CreateSimBcPlotContoursBuilder

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::CAE::SimBcPlotContoursBuilder::PlotType

Plot types.

Enumerator:

PlotTypeStatic	Static plot.
PlotTypeAnimation	Animation.

enum NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType

Resolve overlap types.

Enumerator:

ResolveOverlapTypeAdd	add
ResolveOverlapTypeAverage	average
ResolveOverlapTypeMaximum	maximum
ResolveOverlapTypeMinimum	minimum
ResolveOverlapTypeSpecify	specify

Member Function Documentation

NXOpen::CAE::NxBcPlotContours* NXOpen::CAE::SimBcPlotContoursBuilder::CreatePlotObject

(

)

Returns CAE::NxBcPlotContours object.

Returns

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

std::vector<NXOpen::CAE::SimBC *> NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailableBcsToPlot

(

)

Returns all available CAE::SimBC to plot.

Returns

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

void NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesAndIndicesToPlot	(	NXOpen::CAE::SimBC *	tBc,
		std::vector< int > &	pPropIndices,
		std::vector< NXString > &	pPropNames
	)

Returns all available property names and indices that can be plotted for the specified CAE::SimBC

Deprecated:

Deprecated in NX9.0.0.

There is no replacement for this method.

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

tBc	tbc
pPropIndices	ppropindices
pPropNames	ppropnames

std::vector<NXString> NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot

(

NXOpen::CAE::SimBC *

tBc

)

Returns all available property names that can be plotted for the specified CAE::SimBC.

Returns

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

tBc

tbc

NXOpen::CAE::SimBcPlotContoursBuilder::PlotType NXOpen::CAE::SimBcPlotContoursBuilder::GetPlotType

(

)

Returns plot type.

Returns

Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

int NXOpen::CAE::SimBcPlotContoursBuilder::PropertyIndexToPlot

(

)

Returns the property index of CAE::SimBC to plot.

Deprecated:

Deprecated in NX9.0.0. There is no replacement for this method.

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

NXString NXOpen::CAE::SimBcPlotContoursBuilder::PropertyNameToPlot

(

)

Returns the property name of CAE::SimBC to plot.

This name must come from the available property names returned by CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot .
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlap

(

)

Returns a CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

double NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapValue

(

)

Returns a overlap value to plot.

This is used when CAE::SimBcPlotContoursBuilder::ResolveOverlap and CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::Unit* NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapValueUnit

(

)

Returns a Unit for overlap value to plot.

This is used when CAE::SimBcPlotContoursBuilder::ResolveOverlap and CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

void NXOpen::CAE::SimBcPlotContoursBuilder::SetAnimationPoints	(	double	startValue,
		NXOpen::Unit *	startUnit,
		double	endValue,
		NXOpen::Unit *	endUnit,
		int	numFrames
	)

Sets animation points
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

startValue	startvalue
startUnit	startunit
endValue	endvalue
endUnit	endunit
numFrames	numframes

void NXOpen::CAE::SimBcPlotContoursBuilder::SetBcsToPlot

(

const std::vector< NXOpen::CAE::SimBC * > &

bcs

)

Sets CAE::SimBC objects to plot.

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

bcs

bcs

void NXOpen::CAE::SimBcPlotContoursBuilder::SetBcsToPlot	(	const std::vector< NXOpen::CAE::SimBC * > &	bcs,
		std::vector< NXString > &	propertyNames
	)

Sets CAE::SimBC objects and property names to plot .

Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

bcs	bcs
propertyNames	NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAE::SimBcPlotContoursBuilder::SetEvaluationPoints	(	const std::vector< double > &	values,
		const std::vector< NXOpen::Unit * > &	units
	)

Sets evaluation point
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

values	values
units	units

void NXOpen::CAE::SimBcPlotContoursBuilder::SetPlotType

(

NXOpen::CAE::SimBcPlotContoursBuilder::PlotType

plotType

)

Sets plot type
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

plotType

plottype

void NXOpen::CAE::SimBcPlotContoursBuilder::SetPropertyIndexToPlot

(

int

propertyIndex

)

Sets the property index of CAE::SimBC to plot.

Deprecated:

Deprecated in NX9.0.0. Use CAE::SimBcPlotContoursBuilder::SetPropertyNameToPlot instead.

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

propertyIndex

propertyindex

void NXOpen::CAE::SimBcPlotContoursBuilder::SetPropertyNameToPlot

(

const NXString &

pPropertyName

)

Sets the property name of CAE::SimBC to plot.

This name must come from the available property names returned by CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot .
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

pPropertyName

ppropertyname

void NXOpen::CAE::SimBcPlotContoursBuilder::SetPropertyNameToPlot

(

const char *

pPropertyName

)

Sets the property name of CAE::SimBC to plot.

This name must come from the available property names returned by CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot .
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

pPropertyName

ppropertyname

void NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlap

(

NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType

resolveOverlapType

)

Sets a CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

resolveOverlapType

resolveoverlaptype

void NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlapValue

(

double

resolveOverlapValue

)

Sets a overlap value to plot.

This is used when CAE::SimBcPlotContoursBuilder::ResolveOverlap and CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

resolveOverlapValue

resolveoverlapvalue

void NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlapValueUnit

(

NXOpen::Unit *

resolveOverlapValueUnit

)

Sets a Unit for overlap value to plot.

This is used when CAE::SimBcPlotContoursBuilder::ResolveOverlap and CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

resolveOverlapValueUnit

resolveoverlapvalueunit

---

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

• CAE_SimBcPlotContoursBuilder.hxx