NX Open C++ Reference Guide
|
Represents an NX Validation object. More...
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< NXString > | GetKeys () |
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. |
Represents an NX Validation object.
To create a new instance of this class, use ValidationCollection::Create
Created in NX4.0.0.
Specifies the input type.
Specifies result of the validation.
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. |
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
key | Map key |
objs | Objects 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
key | Map key |
text | Text 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
key | Map key |
number | Real 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
key | Map key |
number | Integer 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
key | Map key |
day | Date to be associated with the key |
time | Time to be associate with the key |
void NXOpen::Validation::Delete | ( | ) |
Delete Validaion Object
Created in NX4.0.0.
License requirements : None
Manualy validate.
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
The initial result.
std::vector<NXString> NXOpen::Validation::GetKeys | ( | ) |
Get keys.
NXOpen::Validation::MapType NXOpen::Validation::GetKeyType | ( | const NXString & | key | ) |
Get key type.
key | Map key |
bool NXOpen::Validation::GetSuppressed | ( | ) |
The suppress state of the validation.
void NXOpen::Validation::Information | ( | ) |
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.
key | Map 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
key | Map key |
number | Integer associate with the key |
found | True 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
key | Map key |
number | Number associate with the key |
found | True 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
key | Map key |
text | Text associate with the key |
found | True 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
key | Map key |
day | Date associate with the key |
time | Time associate with the key |
found | True 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
key | Map 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
key | Map key |
objs | Objects to be associate with the key |
Returns the requirement path.
Created in NX8.0.0.
License requirements : None
void NXOpen::Validation::SetCheckResult | ( | NXOpen::Validation::Result | result | ) |
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
result | result |
void NXOpen::Validation::SetRequirement | ( | const NXString & | requirement | ) |
Sets the requirement path.
Created in NX8.0.0.
License requirements : None
requirement | requirement path |
void NXOpen::Validation::SetSuppressed | ( | bool | suppress | ) |
Created in NX4.0.0.
License requirements : None
suppress | Suppress flag true = supress, false = unsupress |
void NXOpen::Validation::SetUpdateControl | ( | NXOpen::Validation::UpdateTime | updateTime | ) |
Define the update behavior of the validation object
Created in NX4.0.0.
License requirements : None
updateTime | Sets the time of update |
void NXOpen::Validation::SetUserClassName | ( | const NXString & | name | ) |
Set user class name
Created in NX4.0.0.
License requirements : None
name | the class name NOTE: The full Unicode character set is not supported for this parameter. |