NXOpen::CAE::Xyplot::Plot Class Reference

Manages the plot template
Not support KF. More...

Inheritance diagram for NXOpen::CAE::Xyplot::Plot:

Public Member Functions
void	CommitRecordsChange ()
	Accepts record changed and process data to update data model. More...
NXOpen::CAE::Xyplot::NoteModel *	CreateNote (std::vector< NXString > &lines, const NXOpen::Point2d &textPosition)
	Creates a note on the plot. More...
void	DeleteRecord (int recordIndex)
	Deletes the nth record. More...
NXOpen::TaggedObject *	Find (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal. More...
NXOpen::TaggedObject *	Find (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal. More...
void	FitAxisLimit ()
	Update axis limits for an overlaying plot if current displayed axis limits in plot do not fit for all records. More...
void	FitView ()
	Fits the display view on a reasonable region. More...
NXOpen::CAE::FTK::IApplicationData *	GetApplicationDataOfRecord (int recordIndex)
	Returns application specific data associated to a record. More...
int	GetDeviceAndViewIndex (int *viewIndex)
	Gets the window device and view index of the plot graph. More...
void	GetGraphs (std::vector< NXOpen::CAE::Xyplot::Graph * > &graphs)
	Gets all graphs on the plot. More...
std::vector < NXOpen::CAE::Xyplot::LegendTable * >	GetLegendTables ()
	Gets the legend table models on the plot. More...
std::vector < NXOpen::CAE::Xyplot::BasicModel * >	GetModels (NXOpen::CAE::Xyplot::ModelType type)
	Gets the models by model type. More...
std::vector < NXOpen::CAE::Xyplot::NoteModel * >	GetNotes ()
	Gets all notes on the plot. More...
int	GetRecordCount ()
	Returns the count of plotted records on the plot graph. More...
bool	GetRecordDisplayVisibility (int recordIndex)
	Gets the visibility of specified record. More...
std::vector < NXOpen::CAE::Xyplot::BasicModel * >	GetTitles ()
	Gets the titles on the plot. More...
void	GetViewBoundingBox (NXOpen::Point3d *leftBottom, NXOpen::Point3d *rightTop)
	Gets the bounding box of the plot view. More...
NXOpen::CAE::Xyplot::PlotGraphTemplate *	PlotTemplate ()
	Returns the plot template Created in NX10.0.0. More...
void	SaveRecords (const std::vector< int > &recordIndexes, std::vector< NXString > &recordNames, const NXString &outputFileName, bool reportError)
	Saves plotted records on a graph to an afu file. More...
void	SaveRecords (const std::vector< int > &recordIndexes, std::vector< NXString > &recordNames, const char *outputFileName, bool reportError)
	Saves plotted records on a graph to an afu file. More...
void	SaveRecordsToCsv (const std::vector< int > &recordIndex, std::vector< NXString > &recordNames, const NXString &csvFileName, bool isWriteHeader)
	Saves plotted records on a plot graph to a CSV file. More...
void	SaveRecordsToCsv (const std::vector< int > &recordIndex, std::vector< NXString > &recordNames, const char *csvFileName, bool isWriteHeader)
	Saves plotted records on a plot graph to a CSV file. More...
void	SetRecordDisplayVisibility (int recordIndex, bool visibility)
	Sets the visibility of specified record. More...
int	SubGraphCountInStack ()
	Returns the sub-graph count in a stacked plot. More...
NXString	WriteToTemplateFile (const NXString &inputTemplateFile)
	Writes the template setting of plot to template file. More...
NXString	WriteToTemplateFile (const char *inputTemplateFile)
	Writes the template setting of plot to template file. More...
Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseModel
virtual void	UpdateDisplay ()
	Updates model display Created in NX11.0.0. More...
Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIterator *	CreateAttributeIterator ()
	Create an attribute iterator. More...
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...
void	DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator Created in NX8.0.0. More...
void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...
virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type. More...
bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index. More...
bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index. More...
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...
int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title. More...
int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title. More...
int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index. More...
int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index. More...
bool	GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
NXString	GetPdmReferenceAttributeValue (const NXString &attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...
NXString	GetPdmReferenceAttributeValue (const char *attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...
double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title. More...
double	GetRealAttribute (const char *title)
	Gets a real attribute by title. More...
double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index. More...
double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index. More...
NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title. More...
NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title. More...
NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index. More...
NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index. More...
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title. More...
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title. More...
NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...
NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...
bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...
bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (NXOpen::AttributeIterator *iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...
std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...
int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...
bool	HasUserAttribute (NXOpen::AttributeIterator *iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator. More...
bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...
virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...
virtual NXString	Name ()
	Returns the custom name of the object. More...
virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...
virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...
virtual void	Print ()
	Prints a representation of this object to the system log file. More...
virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...
void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute. More...
void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute. More...
void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute. More...
void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute. More...
void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute. More...
void	SetAttribute (const char *title, const char *value)
	Creates or modifies a string attribute. More...
void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...
void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...
void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...
void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...
virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...
virtual void	SetName (const char *name)
	Sets the custom name of the object. More...
void	SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
	Sets the value of PDM Reference attribute on the object. More...
void	SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
	Sets the value of PDM Reference attribute on the object. More...
void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string. More...
void	SetReferenceAttribute (const char *title, const char *value)
	Creates or modifies a string attribute which uses a reference string. More...
void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
void	SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute. More...
void	SetTimeAttribute (const char *title, const char *value)
	Creates or modifies a time attribute. More...
void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...
void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Additional Inherited Members
Public Types inherited from NXOpen::NXObject
enum	AttributeType {   AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,   AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,   AttributeTypeAny = 100 }
	Specifies attribute type. More...
enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Detailed Description

Manages the plot template
Not support KF.

Created in NX7.5.0.

Member Function Documentation

void NXOpen::CAE::Xyplot::Plot::CommitRecordsChange

(

)

Accepts record changed and process data to update data model.

This method is only to update data model, it needs call CAE::Xyplot::BaseModel::UpdateDisplay to update display to reflect data change.

Created in NX12.0.0.

License requirements : None

NXOpen::CAE::Xyplot::NoteModel* NXOpen::CAE::Xyplot::Plot::CreateNote	(	std::vector< NXString > &	lines,
		const NXOpen::Point2d &	textPosition
	)

Creates a note on the plot.

Returns

Created in NX11.0.0.

License requirements : None

Parameters

lines	lines
textPosition	textposition

void NXOpen::CAE::Xyplot::Plot::DeleteRecord

(

int

recordIndex

)

Deletes the nth record.

The record index must be greater or equal to 0, and less than CAE::Xyplot::Plot::GetRecordCount
Procedure of deleting records from plot fully:

1. Call this method to delete record data from plot
2. Call CAE::Xyplot::Plot::CommitRecordsChange to precess record data change and update data model
3. Call CAE::Xyplot::BaseModel::UpdateDisplay to regenerate display to reflect data change
4. Optionally call CAE::Xyplot::Plot::FitView to make display fit the view;it is only required when the plot display boundary is changed

Created in NX12.0.0.

License requirements : None

Parameters

recordIndex

recordindex

NXOpen::TaggedObject* NXOpen::CAE::Xyplot::Plot::Find

(

const NXString &

journalIdentifier

)

Finds the NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns

Deprecated:

Deprecated in NX12.0.0. Use NXOpen::INXObject::FindObject

Created in NX10.0.0.

License requirements : None

Parameters

journalIdentifier

Journal identifier of the object

NXOpen::TaggedObject* NXOpen::CAE::Xyplot::Plot::Find

(

const char *

journalIdentifier

)

Finds the NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns

Deprecated:

Deprecated in NX12.0.0. Use NXOpen::INXObject::FindObject

Created in NX10.0.0.

License requirements : None

Parameters

journalIdentifier

Journal identifier of the object

void NXOpen::CAE::Xyplot::Plot::FitAxisLimit

(

)

Update axis limits for an overlaying plot if current displayed axis limits in plot do not fit for all records.

Created in NX10.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::Plot::FitView

(

)

Fits the display view on a reasonable region.

Created in NX12.0.0.

License requirements : None

NXOpen::CAE::FTK::IApplicationData* NXOpen::CAE::Xyplot::Plot::GetApplicationDataOfRecord

(

int

recordIndex

)

Returns application specific data associated to a record.

Returns

Created in NX12.0.0.

License requirements : None

Parameters

recordIndex

The record index starts form 0 to record count -1. Get record count from Plot::GetRecordCount

int NXOpen::CAE::Xyplot::Plot::GetDeviceAndViewIndex

(

int *

viewIndex

)

Gets the window device and view index of the plot graph.

Returns

the device of window
Created in NX9.0.0.

License requirements : None

Parameters

viewIndex

the index of view

void NXOpen::CAE::Xyplot::Plot::GetGraphs

(

std::vector< NXOpen::CAE::Xyplot::Graph * > &

graphs

)

Gets all graphs on the plot.

Created in NX10.0.0.

License requirements : None

Parameters

graphs

Graph objects

std::vector<NXOpen::CAE::Xyplot::LegendTable *> NXOpen::CAE::Xyplot::Plot::GetLegendTables

(

)

Gets the legend table models on the plot.

Returns

Legend Table Objects
Created in NX12.0.0.

License requirements : None

std::vector<NXOpen::CAE::Xyplot::BasicModel *> NXOpen::CAE::Xyplot::Plot::GetModels

(

NXOpen::CAE::Xyplot::ModelType

type

)

Gets the models by model type.

Returns

Created in NX12.0.0.

License requirements : None

Parameters

type

type

std::vector<NXOpen::CAE::Xyplot::NoteModel *> NXOpen::CAE::Xyplot::Plot::GetNotes

(

)

Gets all notes on the plot.

Returns

Created in NX11.0.0.

License requirements : None

int NXOpen::CAE::Xyplot::Plot::GetRecordCount

(

)

Returns the count of plotted records on the plot graph.

Returns

Record count
Created in NX9.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::Plot::GetRecordDisplayVisibility

(

int

recordIndex

)

Gets the visibility of specified record.

Returns

Created in NX12.0.0.

License requirements : None

Parameters

recordIndex

the index of specied record

std::vector<NXOpen::CAE::Xyplot::BasicModel *> NXOpen::CAE::Xyplot::Plot::GetTitles

(

)

Gets the titles on the plot.

Returns

Created in NX11.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::Plot::GetViewBoundingBox	(	NXOpen::Point3d *	leftBottom,
		NXOpen::Point3d *	rightTop
	)

Gets the bounding box of the plot view.

Created in NX11.0.0.

License requirements : None

Parameters

leftBottom	leftbottom
rightTop	righttop

NXOpen::CAE::Xyplot::PlotGraphTemplate* NXOpen::CAE::Xyplot::Plot::PlotTemplate

(

)

Returns the plot template
Created in NX10.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::Plot::SaveRecords	(	const std::vector< int > &	recordIndexes,
		std::vector< NXString > &	recordNames,
		const NXString &	outputFileName,
		bool	reportError
	)

Saves plotted records on a graph to an afu file.

The record index is between 0 and the value returned from NXOpen::CAE::Xyplot::Plot::GetRecordCount .
Created in NX10.0.0.

License requirements : None

Parameters

recordIndexes	The index of records to be saved
recordNames	The output record names
outputFileName	The destination file with full file name. The file suffix must be ".afu".
reportError	reporterror

void NXOpen::CAE::Xyplot::Plot::SaveRecords	(	const std::vector< int > &	recordIndexes,
		std::vector< NXString > &	recordNames,
		const char *	outputFileName,
		bool	reportError
	)

Saves plotted records on a graph to an afu file.

The record index is between 0 and the value returned from NXOpen::CAE::Xyplot::Plot::GetRecordCount .
Created in NX10.0.0.

License requirements : None

Parameters

recordIndexes	The index of records to be saved
recordNames	The output record names
outputFileName	The destination file with full file name. The file suffix must be ".afu".
reportError	reporterror

void NXOpen::CAE::Xyplot::Plot::SaveRecordsToCsv	(	const std::vector< int > &	recordIndex,
		std::vector< NXString > &	recordNames,
		const NXString &	csvFileName,
		bool	isWriteHeader
	)

Saves plotted records on a plot graph to a CSV file.

Created in NX10.0.0.

License requirements : None

Parameters

recordIndex	the indexes of records to be saved
recordNames	recordnames
csvFileName	the destination CSV file name
isWriteHeader	iswriteheader

void NXOpen::CAE::Xyplot::Plot::SaveRecordsToCsv	(	const std::vector< int > &	recordIndex,
		std::vector< NXString > &	recordNames,
		const char *	csvFileName,
		bool	isWriteHeader
	)

Saves plotted records on a plot graph to a CSV file.

Created in NX10.0.0.

License requirements : None

Parameters

recordIndex	the indexes of records to be saved
recordNames	recordnames
csvFileName	the destination CSV file name
isWriteHeader	iswriteheader

void NXOpen::CAE::Xyplot::Plot::SetRecordDisplayVisibility	(	int	recordIndex,
		bool	visibility
	)

Sets the visibility of specified record.

Created in NX12.0.0.

License requirements : None

Parameters

recordIndex	the index of specied record
visibility	visibility

int NXOpen::CAE::Xyplot::Plot::SubGraphCountInStack

(

)

Returns the sub-graph count in a stacked plot.

Created in NX10.0.0.

License requirements : None

NXString NXOpen::CAE::Xyplot::Plot::WriteToTemplateFile

(

const NXString &

inputTemplateFile

)

Writes the template setting of plot to template file.

1. If input file is a simple file:
   If environment variable of UGII_USER_DIR is not set, it will be written into file under user environment directory.
   
   If environment variable of UGII_USER_DIR is not set, it will write to write the template setting.
   
2. If input file is a file with full path, the template settings will be written into the file.

Returns

the file name with full path
Created in NX12.0.0.

License requirements : None

Parameters

inputTemplateFile

simple name or file name with full path

NXString NXOpen::CAE::Xyplot::Plot::WriteToTemplateFile

(

const char *

inputTemplateFile

)

Writes the template setting of plot to template file.

1. If input file is a simple file:
   If environment variable of UGII_USER_DIR is not set, it will be written into file under user environment directory.
   
   If environment variable of UGII_USER_DIR is not set, it will write to write the template setting.
   
2. If input file is a file with full path, the template settings will be written into the file.

Returns

the file name with full path
Created in NX12.0.0.

License requirements : None

Parameters

inputTemplateFile

simple name or file name with full path

---

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

• CAE_Xyplot_Plot.hxx