A visual report can be activated by the NXOpen::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 NXOpen::VisualReporting::VisualReport . More...

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

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

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

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

enum	ScopeTypeOption { ScopeTypeOptionComponent, ScopeTypeOptionSubPart }
	Represents the possible NXOpen::VisualReporting::VisualReport::ScopeType options for a NXOpen::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 NXOpen::VisualReporting::VisualReport . More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	SetReportContext (NXOpen::VisualReporting::VisualReport::ReportContextOption reportContext)
	Sets the NXOpen::VisualReporting::VisualReport::ReportContextOption of this NXOpen::VisualReporting::VisualReport . More...

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

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

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

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

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

NXOpen::VisualReporting::UnmatchedResultCategory *	UnmatchedResultCategory ()
	Returns the NXOpen::VisualReporting::UnmatchedResultCategory from the activated NXOpen::VisualReporting::VisualReport . 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...

Detailed Description

A visual report can be activated by the NXOpen::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 NXOpen::VisualReporting::VisualReport::GetGroupLabels and NXOpen::VisualReporting::VisualReport::GetObjectsInGroup .

Created in NX7.0.0.

Member Enumeration Documentation

enum NXOpen::VisualReporting::VisualReport::ObjectTypeOption

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

Only valid if the NXOpen::VisualReporting::VisualReport::ScopeType of the NXOpen::VisualReporting::VisualReport is NXOpen::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 NXOpen::VisualReporting::VisualReport::ReportContext options for a NXOpen::VisualReporting::VisualReport .

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

enum NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption

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

Only valid if the NXOpen::VisualReporting::VisualReport::ScopeType of the NXOpen::VisualReporting::VisualReport is NXOpen::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 NXOpen::VisualReporting::VisualReport::ReportingStyle for a NXOpen::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 NXOpen::VisualReporting::VisualReport::SaveDestination options for a NXOpen::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 NXOpen::VisualReporting::VisualReport::ScopeType options for a NXOpen::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 NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

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

Returns the custom message of this NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

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

Returns the description of this NXOpen::VisualReporting::VisualReport.

Created in NX7.0.0.

License requirements : None

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

Returns the category of this NXOpen::VisualReporting::VisualReport .

Created in NX7.5.0.

License requirements : None

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

Returns the destination Teamcenter folder for saving the NXOpen::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 NXOpen::VisualReporting::VisualReport::DestinationTeamcenterFolder may return NULL if you haven't set a folder name on this property.

Created in NX8.0.0.

License requirements : None

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

Returns the filename where this NXOpen::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 NXOpen::VisualReporting::VisualReport::Save , the report dataset identifier will be saved in this property.

Created in NX7.0.0.

License requirements : None

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

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

The returned properties include those properties defined in NXOpen::VisualReporting::Condition s, in NXOpen::VisualReporting::Classifier s, and in the referenced properties.

Returns: Properties defined in this visual report
Created in NX8.0.0.

License requirements : None

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

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

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

Returns: Created in NX7.0.0.

License requirements : None

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

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

category category

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

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

Returns: Created in NX7.5.0.

License requirements : None

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

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

Returns: Created in NX7.0.0.

License requirements : None

Parameters

groupLabel A group label of this visual report

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

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

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

Returns: The object types
Created in NX9.0.0.

License requirements : None

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

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

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

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

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

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

There are no NXOpen::VisualReporting::ResultCategory s if the NXOpen::VisualReporting::VisualReport is not activated.

Returns: Created in NX8.0.0.

License requirements : None

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

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

Returns: Created in NX7.0.0.

License requirements : None

Parameters

index The index of the returned NXOpen::VisualReporting::Rule .

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

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

Returns: Created in NX7.0.0.

License requirements : None

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

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

Created in NX7.0.0.

License requirements : None

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

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

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

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 NXOpen::VisualReporting::VisualReport::ReportContextOption of this NXOpen::VisualReporting::VisualReport .

Created in NX9.0.0.

License requirements : None

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

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

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

Created in NX8.0.0.

License requirements : None

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

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

Created in NX7.0.0.

License requirements : None

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

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

Note that when NX is connected to Teamcenter, the NXOpen::VisualReporting::VisualReport::Filename 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 NXOpen::VisualReporting::VisualReport::SaveDestinationOption of the NXOpen::VisualReporting::VisualReport .

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

Created in NX8.0.0.

License requirements : None

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

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

Created in NX9.0.0.

License requirements : None

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

Sets the bitmap name of this NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::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 NXOpen::VisualReporting::VisualReport::DestinationTeamcenterFolder 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 NXOpen::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 NXOpen::VisualReporting::VisualReport::DestinationTeamcenterFolder 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 NXOpen::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 NXOpen::VisualReporting::VisualReport::Save , 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 NXOpen::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 NXOpen::VisualReporting::VisualReport::Save , 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 NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

keywords keywords

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

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

keywords keywords

void NXOpen::VisualReporting::VisualReport::SetReportContext ( NXOpen::VisualReporting::VisualReport::ReportContextOption reportContext )

Sets the NXOpen::VisualReporting::VisualReport::ReportContextOption of this NXOpen::VisualReporting::VisualReport .

Created in NX9.0.3.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

reportContext reportcontext

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

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

Only valid if the NXOpen::VisualReporting::VisualReport::ScopeType of the NXOpen::VisualReporting::VisualReport is NXOpen::VisualReporting::VisualReport::ScopeTypeOptionComponent 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 NXOpen::VisualReporting::VisualReport::ReportingStyleOption of this NXOpen::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 NXOpen::VisualReporting::VisualReport::SaveDestinationOption of the NXOpen::VisualReporting::VisualReport .

Note that this property will always be NXOpen::VisualReporting::VisualReport::SaveDestinationOptionLocal 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 NXOpen::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 NXOpen::VisualReporting::GroupLabel which is used for unmatched object.

It will return NULL if the NXOpen::VisualReporting::VisualReport is not activated.

Created in NX7.0.0.

License requirements : None

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

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

It will return NULL if the NXOpen::VisualReporting::VisualReport is not activated.

Created in NX8.0.0.

License requirements : None

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