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

Represents an NX Validation object. More...

Inheritance diagram for NXOpen::Validation:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  InputType {
  InputTypeKfClass, InputTypeSpreadsheet, InputTypeTextFile, InputTypeXml,
  InputTypeTcr, InputTypeApplication, InputTypeNum
}
 Specifies the input type. More...
enum  MapType {
  MapTypeText, MapTypeReal, MapTypeInt, MapTypeTime,
  MapTypeTag, MapTypeNone
}
 Specifies the map types. More...
enum  Result {
  ResultPass, ResultInformation, ResultWarning, ResultFailed,
  ResultUnknown, ResultSkipped
}
 Specifies result of the validation. More...
enum  UpdateTime { UpdateTimeEveryChange, UpdateTimeSave }
 Specifies when to validate. More...

Public Member Functions

void Add (const NXString &key, const std::vector< NXOpen::NXObject * > &objs)
 Add a objects to the validation map
Created in NX4.0.0.
void Add (const NXString &key, const NXString &text)
 Add a text to the validation map
Created in NX4.0.0.
void Add (const NXString &key, double number)
 Add a real to the validation map
Created in NX4.0.0.
void Add (const NXString &key, int number)
 Add a integer to the validation map
Created in NX4.0.0.
void Add (const NXString &key, int day, int time)
 Add a time to the validation map
Created in NX4.0.0.
void Delete ()
 Delete Validaion Object
Created in NX4.0.0.
NXOpen::Validation::Result Evaluate ()
 Manualy validate.
NXOpen::Validation::Result GetCheckResult ()
 The validation result.
NXOpen::Validation::Result GetInitialResult ()
 The initial result.
std::vector< NXStringGetKeys ()
 Get keys.
NXOpen::Validation::MapType GetKeyType (const NXString &key)
 Get key type.
bool GetSuppressed ()
 The suppress state of the validation.
void Information ()
 Information display on a Validation Object
Created in NX4.0.0.
std::vector< NXOpen::NXObject * > Lookup (const NXString &key)
 Lookup a objects to the validation map.
void LookupInteger (const NXString &key, int *number, bool *found)
 Lookup a integer to the validation map
Created in NX4.0.0.
void LookupNumber (const NXString &key, double *number, bool *found)
 Lookup a real to the validation map
Created in NX4.0.0.
void LookupText (const NXString &key, NXString *text, bool *found)
 Lookup a text to the validation map
Created in NX4.0.0.
void LookupTime (const NXString &key, int *day, int *time, bool *found)
 Lookup a time to the validation map
Created in NX4.0.0.
void Remove (const NXString &key)
 Remove a key from the map
Created in NX4.0.0.
void Replace (const NXString &key, const std::vector< NXOpen::NXObject * > &objs)
 Replace objects of a key in the validation map
Created in NX4.0.0.
NXString Requirement ()
 Returns the requirement path.
void SetCheckResult (NXOpen::Validation::Result result)
 Set the result of validation.
void SetRequirement (const NXString &requirement)
 Sets the requirement path.
void SetSuppressed (bool suppress)
 
Created in NX4.0.0.
void SetUpdateControl (NXOpen::Validation::UpdateTime updateTime)
 Define the update behavior of the validation object
Created in NX4.0.0.
void SetUserClassName (const NXString &name)
 Set user class name
Created in NX4.0.0.

Detailed Description

Represents an NX Validation object.


To create a new instance of this class, use ValidationCollection::Create

Created in NX4.0.0.


Member Enumeration Documentation

Specifies the input type.

Enumerator:
InputTypeKfClass 

Input rules are in a KF class.

InputTypeSpreadsheet 

Input rules are from a spreadsheet.

InputTypeTextFile 

Input rules are from a text file.

InputTypeXml 

Input rules are from XML file.

InputTypeTcr 

Input rules are from TcR.

InputTypeApplication 

Input rules are from validation applications.

InputTypeNum 

Last item define the number of the input source, not used as a type.

Specifies the map types.

Enumerator:
MapTypeText 

Text map.

MapTypeReal 

Real map.

MapTypeInt 

Integer map.

MapTypeTime 

Time map.

MapTypeTag 

NX Object identifier map.

MapTypeNone 

map is not define

Specifies result of the validation.

Enumerator:
ResultPass 

Validation Pass all checks.

ResultInformation 

Validation Pass with information.

ResultWarning 

Validation Pass with warning.

ResultFailed 

Validation Failed.

ResultUnknown 

Unknown validation result.

ResultSkipped 

Validation Skipped.

Specifies when to validate.

Enumerator:
UpdateTimeEveryChange 

Every update when the input was changed.

UpdateTimeSave 

During save time.


Member Function Documentation

void NXOpen::Validation::Add ( const NXString key,
const std::vector< NXOpen::NXObject * > &  objs 
)

Add a objects to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
objsObjects to be associate with the key
void NXOpen::Validation::Add ( const NXString key,
const NXString text 
)

Add a text to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
textText to be associate with the key
void NXOpen::Validation::Add ( const NXString key,
double  number 
)

Add a real to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
numberReal to be associate with the key
void NXOpen::Validation::Add ( const NXString key,
int  number 
)

Add a integer to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
numberInteger to be associate with the key
void NXOpen::Validation::Add ( const NXString key,
int  day,
int  time 
)

Add a time to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
dayDate to be associated with the key
timeTime to be associate with the key

Delete Validaion Object
Created in NX4.0.0.



License requirements : None

Manualy validate.

Returns:

Created in NX4.0.0.

License requirements : None

The validation result.

Result is represented as a Name, with the following options: pass : Validation Pass all checks information : Validation Pass with information warning : Validation Pass with warning failed : Validation Failed unknown : Unknown validation result

Returns:

Created in NX4.0.0.

License requirements : None

The initial result.

Returns:
result of validation object.
Created in NX4.0.0.

License requirements : None

Get keys.

Returns:
keys in the map
Created in NX4.0.0.

License requirements : None

Get key type.

Returns:

Created in NX4.0.0.

License requirements : None
Parameters:
keyMap key

The suppress state of the validation.

Returns:
Supress flag true = supress false unsupress
Created in NX4.0.0.

License requirements : None

Information display on a Validation Object
Created in NX4.0.0.



License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::Validation::Lookup ( const NXString key)

Lookup a objects to the validation map.

Returns:
objects associate with the key
Created in NX4.0.0.

License requirements : None
Parameters:
keyMap key
void NXOpen::Validation::LookupInteger ( const NXString key,
int *  number,
bool *  found 
)

Lookup a integer to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
numberInteger associate with the key
foundTrue integer found False not found in map
void NXOpen::Validation::LookupNumber ( const NXString key,
double *  number,
bool *  found 
)

Lookup a real to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
numberNumber associate with the key
foundTrue text found False not found in map
void NXOpen::Validation::LookupText ( const NXString key,
NXString text,
bool *  found 
)

Lookup a text to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
textText associate with the key
foundTrue text found False not found in map
void NXOpen::Validation::LookupTime ( const NXString key,
int *  day,
int *  time,
bool *  found 
)

Lookup a time to the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
dayDate associate with the key
timeTime associate with the key
foundTrue time found False not found in map
void NXOpen::Validation::Remove ( const NXString key)

Remove a key from the map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
void NXOpen::Validation::Replace ( const NXString key,
const std::vector< NXOpen::NXObject * > &  objs 
)

Replace objects of a key in the validation map
Created in NX4.0.0.



License requirements : None

Parameters:
keyMap key
objsObjects to be associate with the key

Returns the requirement path.


Created in NX8.0.0.

License requirements : None

Set the result of validation.

Result is represented as a Name, with the following options: pass : Validation Pass all checks information : Validation Pass with information warning : Validation Pass with warning failed : Validation Failed unknown : Unknown validation result


Created in NX4.0.0.

License requirements : None

Parameters:
resultresult
void NXOpen::Validation::SetRequirement ( const NXString requirement)

Sets the requirement path.


Created in NX8.0.0.

License requirements : None

Parameters:
requirementrequirement path
void NXOpen::Validation::SetSuppressed ( bool  suppress)


Created in NX4.0.0.



License requirements : None

Parameters:
suppressSuppress flag true = supress, false = unsupress

Define the update behavior of the validation object
Created in NX4.0.0.



License requirements : None

Parameters:
updateTimeSets the time of update

Set user class name
Created in NX4.0.0.



License requirements : None

Parameters:
namethe class name
NOTE: The full Unicode character set is not supported for this parameter.

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