NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::VisualReporting::Condition Class Reference

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

Inheritance diagram for NXOpen::VisualReporting::Condition:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

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 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::ConditionGetChildCondition (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::ConditionParentCondition ()
 Returns the parent condition of this VisualReporting::Condition .
NXOpen::VisualReporting::PropertyProperty ()
 Returns the VisualReporting::Property of this VisualReporting::Condition .
void SetDescription (const NXString &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 SetValue (const NXString &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 .

Detailed Description

A Condition within a VisualReporting::Rule .


Created in NX7.0.0.


Member Enumeration Documentation

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

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

Returns the description for this VisualReporting::Condition .

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")

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

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
indexThe index of the returned Condition.

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

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns whether this VisualReporting::Condition requires user input.

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")

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

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
childConditionThe possible child Condition

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

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")

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")

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")

Sets the description for this VisualReporting::Condition .

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:
descriptiondescription

Sets whether this VisualReporting::Condition requires user input.

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:
isUserSpecifiedisuserspecified

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

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:
operatorTypeoperatortype

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:
propertyproperty

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:
userPromptuserprompt
void NXOpen::VisualReporting::Condition::SetValue ( const NXString conditionValue)

Sets the value of this VisualReporting::Condition .

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:
conditionValueconditionvalue

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")

Returns the value of this VisualReporting::Condition .

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")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.