TODO: Add documentation. More...

Inheritance diagram for NXOpen::CAE::PostScenarioColorBarsCustomization:

Public Member Functions
void	DisableFreeText ()
	Disable the user defined free texts field. More...

void	DisableRecordNameField (const NXString &field)
	Disables field. More...

void	DisableRecordNameField (const char *field)
	Disables field. More...

void	EnableFreeText ()
	Enables the user defined free texts field. More...

void	EnableRecordNameField (const NXString &field)
	Enables field. More...

void	EnableRecordNameField (const char *field)
	Enables field. More...

std::vector< NXString >	GetFreeTexts ()
	Returns the user defined texts associated to each record. More...

virtual NXString	GetName ()
	Returns the name of the visualization. More...

int	GetNumberOfRecords ()
	Returns the number of records available in the visualization. More...

std::vector< NXString >	GetRecordNameFields ()
	Returns the field names used to generate the record names. More...

virtual int	GetSubviewportIndex ()
	Returns the subviewport id of the visualization. More...

void	ResetRecordNamesToDefault ()
	Resets the record names to defaults. More...

void	SetFreeText (int recordIndex, const NXString &text)
	Set the free text for a certain record index. More...

void	SetFreeText (int recordIndex, const char *text)
	Set the free text for a certain record index. More...

virtual void	Update ()
	This commits the changes done to the visualization. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

TODO: Add documentation.

To obtain an instance of this class use NXOpen::CAE::PostScenarioVisualizationCustomizationCollection .

Created in NX1847.0.0.

Member Function Documentation

void NXOpen::CAE::PostScenarioColorBarsCustomization::DisableFreeText ( )

Disable the user defined free texts field.

See CAE::PostScenarioColorBarsCustomization::GetFreeTexts and CAE::PostScenarioColorBarsCustomization::SetFreeText for handling the free texts.

Created in NX1847.0.0.

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

void NXOpen::CAE::PostScenarioColorBarsCustomization::DisableRecordNameField ( const NXString & field )

Disables field.

This field will not be used when generating the record names.

See CAE::PostScenarioColorBarsCustomization::GetRecordNameFields for avaialable fields.

Created in NX1847.0.0.

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

Parameters

field field

void NXOpen::CAE::PostScenarioColorBarsCustomization::DisableRecordNameField ( const char * field )

Disables field.

This field will not be used when generating the record names.

See CAE::PostScenarioColorBarsCustomization::GetRecordNameFields for avaialable fields.

Created in NX1847.0.0.

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

Parameters

field field

void NXOpen::CAE::PostScenarioColorBarsCustomization::EnableFreeText ( )

Enables the user defined free texts field.

See CAE::PostScenarioColorBarsCustomization::GetFreeTexts and CAE::PostScenarioColorBarsCustomization::SetFreeText for handling the free texts.

Created in NX1847.0.0.

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

void NXOpen::CAE::PostScenarioColorBarsCustomization::EnableRecordNameField ( const NXString & field )

Enables field.

This field will be used to generate the record names.

See CAE::PostScenarioColorBarsCustomization::GetRecordNameFields for avaialable fields.

Created in NX1847.0.0.

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

Parameters

field field

void NXOpen::CAE::PostScenarioColorBarsCustomization::EnableRecordNameField ( const char * field )

Enables field.

This field will be used to generate the record names.

See CAE::PostScenarioColorBarsCustomization::GetRecordNameFields for avaialable fields.

Created in NX1847.0.0.

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

Parameters

field field

std::vector<NXString> NXOpen::CAE::PostScenarioColorBarsCustomization::GetFreeTexts ( )

Returns the user defined texts associated to each record.

The size of this array is equal to the result of CAE::PostScenarioColorBarsCustomization::GetNumberOfRecords .

Created in NX1847.0.0.

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

virtual NXString NXOpen::CAE::PostScenarioColorBarsCustomization::GetName ( )

virtual

Returns the name of the visualization.

Created in NX1847.0.0.

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

Implements NXOpen::CAE::IPostScenarioVisualizationCustomization.

int NXOpen::CAE::PostScenarioColorBarsCustomization::GetNumberOfRecords ( )

Returns the number of records available in the visualization.

Created in NX1847.0.0.

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

std::vector<NXString> NXOpen::CAE::PostScenarioColorBarsCustomization::GetRecordNameFields ( )

Returns the field names used to generate the record names.

Created in NX1847.0.0.

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

virtual int NXOpen::CAE::PostScenarioColorBarsCustomization::GetSubviewportIndex ( )

virtual

Returns the subviewport id of the visualization.

Created in NX1847.0.0.

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

Implements NXOpen::CAE::IPostScenarioVisualizationCustomization.

void NXOpen::CAE::PostScenarioColorBarsCustomization::ResetRecordNamesToDefault ( )

Resets the record names to defaults.

Created in NX1847.0.0.

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

void NXOpen::CAE::PostScenarioColorBarsCustomization::SetFreeText	(	int	recordIndex,
		const NXString &	text
	)

Set the free text for a certain record index.

Created in NX1847.0.0.

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

Parameters

recordIndex	recordindex
text	text

void NXOpen::CAE::PostScenarioColorBarsCustomization::SetFreeText	(	int	recordIndex,
		const char *	text
	)

Set the free text for a certain record index.

Created in NX1847.0.0.

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

Parameters

recordIndex	recordindex
text	text

virtual void NXOpen::CAE::PostScenarioColorBarsCustomization::Update ( )

virtual

This commits the changes done to the visualization.

Created in NX1847.0.0.

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

Implements NXOpen::CAE::IPostScenarioVisualizationCustomization.

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

CAE_PostScenarioColorBarsCustomization.hxx

Public Member Functions

Detailed Description

Member Function Documentation