A Condition within a VisualReporting::Rule . More...

Inheritance diagram for NXOpen::VisualReporting::Condition:

Public Types
enum	OperatorOption { OperatorOptionEqualOperator, OperatorOptionLessThanOperator, OperatorOptionNotLessThanOperator, OperatorOptionGreaterThanOperator, OperatorOptionNotGreaterThanOperator, OperatorOptionNotEqualOperator, OperatorOptionRegularExpressionOperator, OperatorOptionContainsOperator, OperatorOptionDoesNotContainOperator, OperatorOptionOnOrBeforeOperator, OperatorOptionOnOrAfterOperator }
	Represents the possible operator type options. More...

enum	TypeOption { TypeOptionAndCondition, TypeOptionOrCondition, TypeOptionNotCondition, TypeOptionValueCondition }
	Represents the possible type options for a VisualReporting::Condition . 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
NXOpen::VisualReporting::Property::DatatypeOption	Datatype ()
	Returns the VisualReporting::Property::DatatypeOption of this VisualReporting::Condition .

NXString	Description ()
	Returns the description for this VisualReporting::Condition .

NXOpen::VisualReporting::Condition *	GetChildCondition (int index)
	Return the specified child Condition from this VisualReporting::Condition.

std::vector < NXOpen::VisualReporting::Condition * >	GetChildConditions ()
	Returns all the child Conditions in this VisualReporting::Condition.

bool	HasUserSpecifiedValue ()
	Returns whether this VisualReporting::Condition requires user input.

bool	IsChildCondition (NXOpen::VisualReporting::Condition *childCondition)
	Returns whether the given VisualReporting::Condition is an immediate child of this condition.

NXOpen::VisualReporting::Condition::OperatorOption	OperatorType ()
	Returns the VisualReporting::Condition::OperatorOption of this VisualReporting::Condition .

NXOpen::VisualReporting::Condition *	ParentCondition ()
	Returns the parent condition of this VisualReporting::Condition .

NXOpen::VisualReporting::Property *	Property ()
	Returns the VisualReporting::Property of this VisualReporting::Condition .

void	SetDescription (const NXString &description)
	Sets the description for this VisualReporting::Condition .

void	SetDescription (const char *description)
	Sets the description for this VisualReporting::Condition .

void	SetHasUserSpecifiedValue (bool isUserSpecified)
	Sets whether this VisualReporting::Condition requires user input.

void	SetOperatorType (NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Sets the VisualReporting::Condition::OperatorOption of this VisualReporting::Condition .

void	SetProperty (NXOpen::VisualReporting::Property *property)
	Sets the VisualReporting::Property of this VisualReporting::Condition .

void	SetUserPrompt (const NXString &userPrompt)
	Sets the user prompt for this VisualReporting::Condition .

void	SetUserPrompt (const char *userPrompt)
	Sets the user prompt for this VisualReporting::Condition .

void	SetValue (const NXString &conditionValue)
	Sets the value of this VisualReporting::Condition .

void	SetValue (const char *conditionValue)
	Sets the value of this VisualReporting::Condition .

NXOpen::VisualReporting::Condition::TypeOption	Type ()
	Returns the VisualReporting::Condition::TypeOption of this VisualReporting::Condition.

NXString	UserPrompt ()
	Returns the user prompt for this VisualReporting::Condition .

NXString	Value ()
	Returns the value of this VisualReporting::Condition .

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 Condition within a VisualReporting::Rule .

Created in NX7.0.0.

Member Enumeration Documentation

enum NXOpen::VisualReporting::Condition::OperatorOption

Represents the possible operator type options.

for a VisualReporting::Condition .

Enumerator:

OperatorOptionEqualOperator	equal operator
OperatorOptionLessThanOperator	less than operator
OperatorOptionNotLessThanOperator	not less than operator
OperatorOptionGreaterThanOperator	greater than operator
OperatorOptionNotGreaterThanOperator	not greater than operator
OperatorOptionNotEqualOperator	not equal operator
OperatorOptionRegularExpressionOperator	regular expression operator
OperatorOptionContainsOperator	contains operator
OperatorOptionDoesNotContainOperator	does not contain operator
OperatorOptionOnOrBeforeOperator	on or before operator
OperatorOptionOnOrAfterOperator	on or after operator

enum NXOpen::VisualReporting::Condition::TypeOption

Represents the possible type options for a VisualReporting::Condition .

If the type is a VisualReporting::Condition::TypeOptionValueCondition the type of value can be found from VisualReporting::Condition::Datatype .

Enumerator:

TypeOptionAndCondition	and condition
TypeOptionOrCondition	or condition
TypeOptionNotCondition	not condition
TypeOptionValueCondition	value condition

Member Function Documentation

NXOpen::VisualReporting::Property::DatatypeOption NXOpen::VisualReporting::Condition::Datatype ( )

Returns the VisualReporting::Property::DatatypeOption of this VisualReporting::Condition .

       The returned data type will never be
       @link VisualReporting::Property::DatatypeOptionUnknown VisualReporting::Property::DatatypeOptionUnknown@endlink .

       Note that this @link VisualReporting::Condition::Datatype VisualReporting::Condition::Datatype@endlink  cannot be modified. 
       Instead it is specified when creating this @link VisualReporting::Condition VisualReporting::Condition@endlink  by using the appropriate function:
        - @link VisualReporting::VisualReportBuilder::CreateStringCondition VisualReporting::VisualReportBuilder::CreateStringCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateIntegerCondition VisualReporting::VisualReportBuilder::CreateIntegerCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateRealCondition VisualReporting::VisualReportBuilder::CreateRealCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateBooleanCondition VisualReporting::VisualReportBuilder::CreateBooleanCondition@endlink 

       Note that the @link VisualReporting::Condition VisualReporting::Condition@endlink s created using the following functions do not
       have @link VisualReporting::Property::DatatypeOption VisualReporting::Property::DatatypeOption@endlink s and calling this function will cause an error for these:
        - @link VisualReporting::VisualReportBuilder::CreateAndCondition VisualReporting::VisualReportBuilder::CreateAndCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateOrCondition VisualReporting::VisualReportBuilder::CreateOrCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateNotCondition VisualReporting::VisualReportBuilder::CreateNotCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::Condition::Description ( )

Returns the description for this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::Condition::GetChildCondition ( int index )

Return the specified child Condition from this VisualReporting::Condition.

    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

index The index of the returned Condition.

std::vector<NXOpen::VisualReporting::Condition *> NXOpen::VisualReporting::Condition::GetChildConditions ( )

Returns all the child Conditions in this VisualReporting::Condition.

    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

bool NXOpen::VisualReporting::Condition::HasUserSpecifiedValue ( )

Returns whether this VisualReporting::Condition requires user input.

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

bool NXOpen::VisualReporting::Condition::IsChildCondition ( NXOpen::VisualReporting::Condition * childCondition )

Returns whether the given VisualReporting::Condition is an immediate child of this condition.

    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

childCondition The possible child Condition

NXOpen::VisualReporting::Condition::OperatorOption NXOpen::VisualReporting::Condition::OperatorType ( )

Returns the VisualReporting::Condition::OperatorOption of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::Condition::ParentCondition ( )

Returns the parent condition of this VisualReporting::Condition .

If this condition has no parent or if the parent isn't a condition then this returns NULL.

Note that this VisualReporting::Condition::ParentCondition cannot be modified. Instead it is determined when inserting this VisualReporting::Condition in the VisualReporting::Rule by using the appropriate function:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Property* NXOpen::VisualReporting::Condition::Property ( )

Returns the VisualReporting::Property of this VisualReporting::Condition .

If the VisualReporting::Property is set to NULL, then it is deleted. Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

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

Sets the description for this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

description description

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

Sets the description for this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

description description

void NXOpen::VisualReporting::Condition::SetHasUserSpecifiedValue ( bool isUserSpecified )

Sets whether this VisualReporting::Condition requires user input.

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

isUserSpecified isuserspecified

void NXOpen::VisualReporting::Condition::SetOperatorType ( NXOpen::VisualReporting::Condition::OperatorOption operatorType )

Sets the VisualReporting::Condition::OperatorOption of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

operatorType operatortype

void NXOpen::VisualReporting::Condition::SetProperty ( NXOpen::VisualReporting::Property * property )

Sets the VisualReporting::Property of this VisualReporting::Condition .

If the VisualReporting::Property is set to NULL, then it is deleted. Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property property

void NXOpen::VisualReporting::Condition::SetUserPrompt ( const NXString & userPrompt )

Sets the user prompt for this VisualReporting::Condition .

Only useful for a condition where VisualReporting::Condition::HasUserSpecifiedValue is true. Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

userPrompt userprompt

void NXOpen::VisualReporting::Condition::SetUserPrompt ( const char * userPrompt )

Sets the user prompt for this VisualReporting::Condition .

Only useful for a condition where VisualReporting::Condition::HasUserSpecifiedValue is true. Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

userPrompt userprompt

void NXOpen::VisualReporting::Condition::SetValue ( const NXString & conditionValue )

Sets the value of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

conditionValue conditionvalue

void NXOpen::VisualReporting::Condition::SetValue ( const char * conditionValue )

Sets the value of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

conditionValue conditionvalue

NXOpen::VisualReporting::Condition::TypeOption NXOpen::VisualReporting::Condition::Type ( )

Returns the VisualReporting::Condition::TypeOption of this VisualReporting::Condition.

       Note that this @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  cannot be modified. 
       Instead it is determined when creating this @link VisualReporting::Condition VisualReporting::Condition@endlink  by using the appropriate function:
        - @link VisualReporting::VisualReportBuilder::CreateStringCondition VisualReporting::VisualReportBuilder::CreateStringCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateIntegerCondition VisualReporting::VisualReportBuilder::CreateIntegerCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateRealCondition VisualReporting::VisualReportBuilder::CreateRealCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateBooleanCondition VisualReporting::VisualReportBuilder::CreateBooleanCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateAndCondition VisualReporting::VisualReportBuilder::CreateAndCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateOrCondition VisualReporting::VisualReportBuilder::CreateOrCondition@endlink 
        - @link VisualReporting::VisualReportBuilder::CreateNotCondition VisualReporting::VisualReportBuilder::CreateNotCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::Condition::UserPrompt ( )

Returns the user prompt for this VisualReporting::Condition .

Only useful for a condition where VisualReporting::Condition::HasUserSpecifiedValue is true. Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::Condition::Value ( )

Returns the value of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

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

VisualReporting_Condition.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation