A visual report can be activated by the VisualReporting::VisualReportManager to apply colors to objects in the graphics window. More...

Inheritance diagram for NXOpen::VisualReporting::VisualReport:

Public Types
enum	ObjectTypeOption { ObjectTypeOptionBody, ObjectTypeOptionFace }
	Represents the possible report object type options for a VisualReporting::VisualReport . More...

enum	ReportContextOption { ReportContextOptionAssembly, ReportContextOptionWorkPart }
	Represents the possible VisualReporting::VisualReport::ReportContext options for a VisualReporting::VisualReport . More...

enum	ReportingObjectTypeOption { ReportingObjectTypeOptionPart, ReportingObjectTypeOptionComponent, ReportingObjectTypeOptionInferred }
	Represents the possible VisualReporting::VisualReport::ReportingObjectType for a VisualReporting::VisualReport . More...

enum	ReportingStyleOption { ReportingStyleOptionColorObject, ReportingStyleOptionTagObject, ReportingStyleOptionColorAndTagObject }
	Represents the possible VisualReporting::VisualReport::ReportingStyle for a VisualReporting::VisualReport . More...

enum	SaveDestinationOption { SaveDestinationOptionLocal, SaveDestinationOptionTeamcenter }
	Represents the possible VisualReporting::VisualReport::SaveDestination options for a VisualReporting::VisualReport . More...

enum	ScopeTypeOption { ScopeTypeOptionComponent, ScopeTypeOptionSubPart }
	Represents the possible VisualReporting::VisualReport::ScopeType options for a VisualReporting::VisualReport . More...

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...

Public Member Functions
NXString	BitmapName ()
	Returns the bitmap name of this VisualReporting::VisualReport .

NXString	CustomMessage ()
	Returns the custom message of this VisualReporting::VisualReport .

NXString	Description ()
	Returns the description of this VisualReporting::VisualReport.

NXString	DescriptiveCategory ()
	Returns the category of this VisualReporting::VisualReport .

NXString	DestinationTeamcenterFolder ()
	Returns the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.

NXString	Filename ()
	Returns the filename where this VisualReporting::VisualReport was opened from or will be saved to.

std::vector < NXOpen::VisualReporting::Property * >	GetAllDefinedProperties ()
	Returns the VisualReporting::Property s which has been defined in this VisualReporting::VisualReport .

std::vector < NXOpen::VisualReporting::GroupLabel * >	GetGroupLabels ()
	Returns the result VisualReporting::GroupLabel s from the activated VisualReporting::VisualReport .

std::vector < NXOpen::VisualReporting::GroupLabel * >	GetGroupLabelsOfResultCategory (NXOpen::VisualReporting::ResultCategory *category)
	Returns the result VisualReporting::GroupLabel s of a VisualReporting::ResultCategory from the activated VisualReporting::VisualReport .

NXString	GetKeywords ()
	Gets a comma separated string of the keywords for this VisualReporting::VisualReport .

std::vector< NXOpen::NXObject * >	GetObjectsInGroup (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Returns the NXObject s that belong to the group with this VisualReporting::GroupLabel .

std::vector < NXOpen::VisualReporting::VisualReport::ObjectTypeOption >	GetObjectTypes ()
	Returns the VisualReporting::VisualReport::ObjectTypeOption s of this VisualReporting::VisualReport .

NXString	GetPropertyValueOfObject (NXOpen::VisualReporting::Property property, NXOpen::VisualReporting::GroupLabel groupLabel, NXOpen::NXObject *nxObject)
	Returns the value of the VisualReporting::Property s for the NXObject in the result VisualReporting::GroupLabel .

std::vector < NXOpen::VisualReporting::ResultCategory * >	GetResultCategories ()
	Returns the VisualReporting::ResultCategory s from the activated VisualReporting::VisualReport .

NXOpen::VisualReporting::Rule *	GetRule (int index)
	Return the specified VisualReporting::Rule from this VisualReporting::VisualReport.

std::vector < NXOpen::VisualReporting::Rule * >	GetRules ()
	Returns all the VisualReporting::Rule s in this VisualReporting::VisualReport.

bool	IsUnmatchedGroupEnabled ()
	Returns whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.

void	RemoveResultCategory (NXOpen::VisualReporting::ResultCategory *theCategory)
	Removes the VisualReporting::ResultCategory from VisualReporting::VisualReport .

NXOpen::VisualReporting::VisualReport::ReportContextOption	ReportContext ()
	Returns the VisualReporting::VisualReport::ReportContextOption of this VisualReporting::VisualReport .

NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption	ReportingObjectType ()
	Returns the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .

NXOpen::VisualReporting::VisualReport::ReportingStyleOption	ReportingStyle ()
	Returns the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .

void	Save ()
	Saves this VisualReporting::VisualReport to its current VisualReporting::VisualReport::Filename .

NXOpen::VisualReporting::VisualReport::SaveDestinationOption	SaveDestination ()
	Returns the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .

NXOpen::VisualReporting::VisualReport::ScopeTypeOption	ScopeType ()
	Returns the VisualReporting::VisualReport::ScopeTypeOption of this VisualReporting::VisualReport .

void	SetBitmapName (const NXString &bitmapName)
	Sets the bitmap name of this VisualReporting::VisualReport .

void	SetBitmapName (const char *bitmapName)
	Sets the bitmap name of this VisualReporting::VisualReport .

void	SetCustomMessage (const NXString &customMessage)
	Sets the custom message of this VisualReporting::VisualReport .

void	SetCustomMessage (const char *customMessage)
	Sets the custom message of this VisualReporting::VisualReport .

void	SetDescription (const NXString &description)
	Sets the description of this VisualReporting::VisualReport.

void	SetDescription (const char *description)
	Sets the description of this VisualReporting::VisualReport.

void	SetDescriptiveCategory (const NXString &category)
	Sets the category of this VisualReporting::VisualReport .

void	SetDescriptiveCategory (const char *category)
	Sets the category of this VisualReporting::VisualReport .

void	SetDestinationTeamcenterFolder (const NXString &foldername)
	Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.

void	SetDestinationTeamcenterFolder (const char *foldername)
	Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.

void	SetFilename (const NXString &filename)
	Sets the filename where this VisualReporting::VisualReport was opened from or will be saved to.

void	SetFilename (const char *filename)
	Sets the filename where this VisualReporting::VisualReport was opened from or will be saved to.

void	SetKeywords (const NXString &keywords)
	Sets a comma separated string of the keywords for this VisualReporting::VisualReport .

void	SetKeywords (const char *keywords)
	Sets a comma separated string of the keywords for this VisualReporting::VisualReport .

void	SetReportingObjectType (NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption reportingObjectType)
	Sets the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .

void	SetReportingStyle (NXOpen::VisualReporting::VisualReport::ReportingStyleOption reportingStyle)
	Sets the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .

void	SetSaveDestination (NXOpen::VisualReporting::VisualReport::SaveDestinationOption destinationOption)
	Sets the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .

void	SetUnmatchedGroupEnabled (bool isUnmatchedGroupEnabled)
	Sets whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.

NXOpen::VisualReporting::GroupLabel *	UnmatchedGroupLabel ()
	Returns the VisualReporting::GroupLabel which is used for unmatched object.

NXOpen::VisualReporting::UnmatchedResultCategory *	UnmatchedResultCategory ()
	Returns the VisualReporting::UnmatchedResultCategory from the activated VisualReporting::VisualReport .

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

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.

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.

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 and Index.

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 and Index.

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

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.

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.

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.

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.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

virtual void	Print ()
	Prints a representation of this object to the system log file.

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

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.

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.

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

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.

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.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string.

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.

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.

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

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.

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.

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.

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.

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.

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.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

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.

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.

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.

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.

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.

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.

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

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.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

Detailed Description

A visual report can be activated by the VisualReporting::VisualReportManager to apply colors to objects in the graphics window.

   An active visual report groups objects according to filtering conditions and classification 
   rules.  The contents of the groups can be accessed via @link VisualReporting::VisualReport::GetGroupLabels VisualReporting::VisualReport::GetGroupLabels@endlink 
   and @link VisualReporting::VisualReport::GetObjectsInGroup VisualReporting::VisualReport::GetObjectsInGroup@endlink .

Created in NX7.0.0.

Member Enumeration Documentation

enum NXOpen::VisualReporting::VisualReport::ObjectTypeOption

Represents the possible report object type options for a VisualReporting::VisualReport .

Only valid if the VisualReporting::VisualReport::ScopeType of the VisualReporting::VisualReport is VisualReporting::VisualReport::ScopeTypeOptionSubPart type.

Enumerator:

ObjectTypeOptionBody	The report objects are bodies.
ObjectTypeOptionFace	The report objects are faces.

enum NXOpen::VisualReporting::VisualReport::ReportContextOption

Represents the possible VisualReporting::VisualReport::ReportContext options for a VisualReporting::VisualReport .

Enumerator:

ReportContextOptionAssembly	Collect objects from entire assembly.
ReportContextOptionWorkPart	Collect objects from work part only.

enum NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption

Represents the possible VisualReporting::VisualReport::ReportingObjectType for a VisualReporting::VisualReport .

Only valid if the VisualReporting::VisualReport::ScopeType of the VisualReporting::VisualReport is VisualReporting::VisualReport::ScopeTypeOptionComponent type.

Enumerator:

ReportingObjectTypeOptionPart	The reporting objects are parts.
ReportingObjectTypeOptionComponent	The reporting objects are components.
ReportingObjectTypeOptionInferred	The reporting objects are inferred from the properties used in the report.

enum NXOpen::VisualReporting::VisualReport::ReportingStyleOption

Represents the possible VisualReporting::VisualReport::ReportingStyle for a VisualReporting::VisualReport .

Enumerator:

ReportingStyleOptionColorObject	Matching objects will be colored.
ReportingStyleOptionTagObject	Matching objects will be tagged.
ReportingStyleOptionColorAndTagObject	Matching objects will be both colored and tagged.

enum NXOpen::VisualReporting::VisualReport::SaveDestinationOption

Represents the possible VisualReporting::VisualReport::SaveDestination options for a VisualReporting::VisualReport .

Enumerator:

SaveDestinationOptionLocal	Saves the report in the local file system.
SaveDestinationOptionTeamcenter	Saves the report in the Teamcenter database.

enum NXOpen::VisualReporting::VisualReport::ScopeTypeOption

Represents the possible VisualReporting::VisualReport::ScopeType options for a VisualReporting::VisualReport .

Enumerator:

ScopeTypeOptionComponent	The report is assembly component report.
ScopeTypeOptionSubPart	The report is sub-part object report.

Member Function Documentation

NXString NXOpen::VisualReporting::VisualReport::BitmapName ( )

Returns the bitmap name of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReport::CustomMessage ( )

Returns the custom message of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReport::Description ( )

Returns the description of this VisualReporting::VisualReport.

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReport::DescriptiveCategory ( )

Returns the category of this VisualReporting::VisualReport .

Created in NX7.5.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReport::DestinationTeamcenterFolder ( )

Returns the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.

       Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database.
       This @link VisualReporting::VisualReport::DestinationTeamcenterFolder VisualReporting::VisualReport::DestinationTeamcenterFolder@endlink  may return NULL if you haven't 
       set a folder name on this property.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReport::Filename ( )

Returns the filename where this VisualReporting::VisualReport was opened from or will be saved to.

       Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database. 
       If it is a new report, it will be the report dataset name. When the report is save by @link VisualReporting::VisualReport::Save VisualReporting::VisualReport::Save@endlink , 
       the report dataset identifier will be saved in this property.

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

std::vector<NXOpen::VisualReporting::Property *> NXOpen::VisualReporting::VisualReport::GetAllDefinedProperties ( )

Returns the VisualReporting::Property s which has been defined in this VisualReporting::VisualReport .

       The returned properties include those properties defined in @link VisualReporting::Condition VisualReporting::Condition@endlink s, in @link VisualReporting::Classifier VisualReporting::Classifier@endlink s,
       and in the referenced properties.
    @return  Properties defined in this visual report

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

std::vector<NXOpen::VisualReporting::GroupLabel *> NXOpen::VisualReporting::VisualReport::GetGroupLabels ( )

Returns the result VisualReporting::GroupLabel s from the activated VisualReporting::VisualReport .

       There are no @link VisualReporting::GroupLabel VisualReporting::GroupLabel@endlink s if the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink  is not activated.
       You can acess the user defined @link VisualReporting::GroupLabel VisualReporting::GroupLabel@endlink s by @link VisualReporting::VisualReportBuilder::GetManualGroupLabelsOfRule VisualReporting::VisualReportBuilder::GetManualGroupLabelsOfRule@endlink .
    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

std::vector<NXOpen::VisualReporting::GroupLabel *> NXOpen::VisualReporting::VisualReport::GetGroupLabelsOfResultCategory ( NXOpen::VisualReporting::ResultCategory * category )

Returns the result VisualReporting::GroupLabel s of a VisualReporting::ResultCategory from the activated VisualReporting::VisualReport .

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

category category

NXString NXOpen::VisualReporting::VisualReport::GetKeywords ( )

Gets a comma separated string of the keywords for this VisualReporting::VisualReport .

    @return

Created in NX7.5.0.

License requirements : nx_visual_reporting ("Visual Reporting")

std::vector<NXOpen::NXObject *> NXOpen::VisualReporting::VisualReport::GetObjectsInGroup ( NXOpen::VisualReporting::GroupLabel * groupLabel )

Returns the NXObject s that belong to the group with this VisualReporting::GroupLabel .

    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel A group label of this visual report

std::vector<NXOpen::VisualReporting::VisualReport::ObjectTypeOption> NXOpen::VisualReporting::VisualReport::GetObjectTypes ( )

Returns the VisualReporting::VisualReport::ObjectTypeOption s of this VisualReporting::VisualReport .

       Only valid if the @link VisualReporting::VisualReport::ScopeType VisualReporting::VisualReport::ScopeType@endlink  of the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink 
       is @link VisualReporting::VisualReport::ScopeTypeOptionSubPart VisualReporting::VisualReport::ScopeTypeOptionSubPart@endlink  type.
    @return  The object types

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReport::GetPropertyValueOfObject	(	NXOpen::VisualReporting::Property *	property,
		NXOpen::VisualReporting::GroupLabel *	groupLabel,
		NXOpen::NXObject *	nxObject
	)

Returns the value of the VisualReporting::Property s for the NXObject in the result VisualReporting::GroupLabel .

       It will return NULL if the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink  is not activated, or the @link VisualReporting::Property VisualReporting::Property@endlink 
       does not belong to the properties defined in this @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink , or the @link NXObject NXObject@endlink  doesn't belong to
       the specified result @link VisualReporting::GroupLabel VisualReporting::GroupLabel@endlink .
    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	A property defined in this visual report
groupLabel	A result group of this visual report
nxObject	A NXObject which belongs to the result group

std::vector<NXOpen::VisualReporting::ResultCategory *> NXOpen::VisualReporting::VisualReport::GetResultCategories ( )

Returns the VisualReporting::ResultCategory s from the activated VisualReporting::VisualReport .

       There are no @link VisualReporting::ResultCategory VisualReporting::ResultCategory@endlink s if the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink  is not activated.
    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Rule* NXOpen::VisualReporting::VisualReport::GetRule ( int index )

Return the specified VisualReporting::Rule from this VisualReporting::VisualReport.

    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

index The index of the returned VisualReporting::Rule .

std::vector<NXOpen::VisualReporting::Rule *> NXOpen::VisualReporting::VisualReport::GetRules ( )

Returns all the VisualReporting::Rule s in this VisualReporting::VisualReport.

    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

bool NXOpen::VisualReporting::VisualReport::IsUnmatchedGroupEnabled ( )

Returns whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

void NXOpen::VisualReporting::VisualReport::RemoveResultCategory ( NXOpen::VisualReporting::ResultCategory * theCategory )

Removes the VisualReporting::ResultCategory from VisualReporting::VisualReport .

       The @link VisualReporting::Classifier VisualReporting::Classifier@endlink  which populates this @link VisualReporting::ResultCategory VisualReporting::ResultCategory@endlink  
       will also be removed from the @link VisualReporting::Rule VisualReporting::Rule@endlink  in the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

theCategory thecategory

NXOpen::VisualReporting::VisualReport::ReportContextOption NXOpen::VisualReporting::VisualReport::ReportContext ( )

Returns the VisualReporting::VisualReport::ReportContextOption of this VisualReporting::VisualReport .

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption NXOpen::VisualReporting::VisualReport::ReportingObjectType ( )

Returns the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .

       Only valid if the @link VisualReporting::VisualReport::ScopeType VisualReporting::VisualReport::ScopeType@endlink  of the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink 
       is @link VisualReporting::VisualReport::ScopeTypeOptionComponent VisualReporting::VisualReport::ScopeTypeOptionComponent@endlink  type.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::VisualReport::ReportingStyleOption NXOpen::VisualReporting::VisualReport::ReportingStyle ( )

Returns the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

void NXOpen::VisualReporting::VisualReport::Save ( )

Saves this VisualReporting::VisualReport to its current VisualReporting::VisualReport::Filename .

       Note that when NX is connected to Teamcenter, the @link VisualReporting::VisualReport::Filename VisualReporting::VisualReport::Filename@endlink  will be 
       updated to the report dataset identifier after the report is saved to Teamcenter database.

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::VisualReport::SaveDestinationOption NXOpen::VisualReporting::VisualReport::SaveDestination ( )

Returns the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .

       Note that this property will always be @link VisualReporting::VisualReport::SaveDestinationOptionLocal VisualReporting::VisualReport::SaveDestinationOptionLocal@endlink  when NX is not connected to Teamcenter.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::VisualReport::ScopeTypeOption NXOpen::VisualReporting::VisualReport::ScopeType ( )

Returns the VisualReporting::VisualReport::ScopeTypeOption of this VisualReporting::VisualReport .

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

void NXOpen::VisualReporting::VisualReport::SetBitmapName ( const NXString & bitmapName )

Sets the bitmap name of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

bitmapName bitmapname

void NXOpen::VisualReporting::VisualReport::SetBitmapName ( const char * bitmapName )

Sets the bitmap name of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

bitmapName bitmapname

void NXOpen::VisualReporting::VisualReport::SetCustomMessage ( const NXString & customMessage )

Sets the custom message of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

customMessage custommessage

void NXOpen::VisualReporting::VisualReport::SetCustomMessage ( const char * customMessage )

Sets the custom message of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

customMessage custommessage

void NXOpen::VisualReporting::VisualReport::SetDescription ( const NXString & description )

Sets the description of this VisualReporting::VisualReport.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

description description

void NXOpen::VisualReporting::VisualReport::SetDescription ( const char * description )

Sets the description of this VisualReporting::VisualReport.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

description description

void NXOpen::VisualReporting::VisualReport::SetDescriptiveCategory ( const NXString & category )

Sets the category of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

category category

void NXOpen::VisualReporting::VisualReport::SetDescriptiveCategory ( const char * category )

Sets the category of this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

category category

void NXOpen::VisualReporting::VisualReport::SetDestinationTeamcenterFolder ( const NXString & foldername )

Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.

       Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database.
       This @link VisualReporting::VisualReport::DestinationTeamcenterFolder VisualReporting::VisualReport::DestinationTeamcenterFolder@endlink  may return NULL if you haven't 
       set a folder name on this property.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

foldername The Teamcenter folder name

void NXOpen::VisualReporting::VisualReport::SetDestinationTeamcenterFolder ( const char * foldername )

Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.

       Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database.
       This @link VisualReporting::VisualReport::DestinationTeamcenterFolder VisualReporting::VisualReport::DestinationTeamcenterFolder@endlink  may return NULL if you haven't 
       set a folder name on this property.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

foldername The Teamcenter folder name

void NXOpen::VisualReporting::VisualReport::SetFilename ( const NXString & filename )

Sets the filename where this VisualReporting::VisualReport was opened from or will be saved to.

       Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database. 
       If it is a new report, it will be the report dataset name. When the report is save by @link VisualReporting::VisualReport::Save VisualReporting::VisualReport::Save@endlink , 
       the report dataset identifier will be saved in this property.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

filename filename

void NXOpen::VisualReporting::VisualReport::SetFilename ( const char * filename )

Sets the filename where this VisualReporting::VisualReport was opened from or will be saved to.

       Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database. 
       If it is a new report, it will be the report dataset name. When the report is save by @link VisualReporting::VisualReport::Save VisualReporting::VisualReport::Save@endlink , 
       the report dataset identifier will be saved in this property.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

filename filename

void NXOpen::VisualReporting::VisualReport::SetKeywords ( const NXString & keywords )

Sets a comma separated string of the keywords for this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReport::SetKeywords ( const char * keywords )

Sets a comma separated string of the keywords for this VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReport::SetReportingObjectType ( NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption reportingObjectType )

Sets the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .

       Only valid if the @link VisualReporting::VisualReport::ScopeType VisualReporting::VisualReport::ScopeType@endlink  of the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink 
       is @link VisualReporting::VisualReport::ScopeTypeOptionComponent VisualReporting::VisualReport::ScopeTypeOptionComponent@endlink  type.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

reportingObjectType reportingobjecttype

void NXOpen::VisualReporting::VisualReport::SetReportingStyle ( NXOpen::VisualReporting::VisualReport::ReportingStyleOption reportingStyle )

Sets the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .

Created in NX7.5.1.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

reportingStyle reportingstyle

void NXOpen::VisualReporting::VisualReport::SetSaveDestination ( NXOpen::VisualReporting::VisualReport::SaveDestinationOption destinationOption )

Sets the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .

       Note that this property will always be @link VisualReporting::VisualReport::SaveDestinationOptionLocal VisualReporting::VisualReport::SaveDestinationOptionLocal@endlink  when NX is not connected to Teamcenter.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

destinationOption The destination option

void NXOpen::VisualReporting::VisualReport::SetUnmatchedGroupEnabled ( bool isUnmatchedGroupEnabled )

Sets whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

isUnmatchedGroupEnabled Whether the unmatched group is enabled

NXOpen::VisualReporting::GroupLabel* NXOpen::VisualReporting::VisualReport::UnmatchedGroupLabel ( )

Returns the VisualReporting::GroupLabel which is used for unmatched object.

       It will return NULL if the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink  is not activated.

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::UnmatchedResultCategory* NXOpen::VisualReporting::VisualReport::UnmatchedResultCategory ( )

Returns the VisualReporting::UnmatchedResultCategory from the activated VisualReporting::VisualReport .

       It will return NULL if the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink  is not activated.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

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

VisualReporting_VisualReport.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation