NX Open C++ Reference Guide
|
Represents an NX NXOpen::Validate::RequirementCollection object. More...
Public Types | |
enum | SourceTypeOptions { SourceTypeOptionsLocalFile, SourceTypeOptionsTeamcenterFile, SourceTypeOptionsTeamcenter } |
This enum represents the type of external source where requirement is defined. More... | |
Public Member Functions | |
NXOpen::Validate::RequirementBuilder * | CreateRequirementBuilder (NXOpen::Validate::Requirement *requirement) |
Creates a NXOpen::Validate::RequirementBuilder. More... | |
NXOpen::Validate::Requirement * | FindObject (const NXString &id) |
Finds the NXOpen::Validate::Requirement with the given identifier. More... | |
NXOpen::Validate::Requirement * | FindObject (const char *id) |
Finds the NXOpen::Validate::Requirement with the given identifier. More... | |
void | LoadFromExternalSource (NXOpen::Validate::RequirementCollection::SourceTypeOptions sourceType, const NXString &source, const NXString &revision, const NXString &project) |
Loads NXOpen::Validate::Requirement from external source. More... | |
void | LoadFromExternalSource (NXOpen::Validate::RequirementCollection::SourceTypeOptions sourceType, const char *source, const char *revision, const char *project) |
Loads NXOpen::Validate::Requirement from external source. More... | |
void | RefreshFromExternalSource (const std::vector< NXOpen::Validate::Requirement * > &requirementTags) |
Refreshes the requirements from external source. More... | |
NXString | RevisionRule () |
Returns the revision rule for requirement from Teamcenter Created in NX8.5.0. More... | |
void | SetRevisionRule (const NXString &rule) |
Sets the revision rule for requirement from Teamcenter Created in NX8.5.0. More... | |
void | SetRevisionRule (const char *rule) |
Sets the revision rule for requirement from Teamcenter Created in NX8.5.0. More... | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents an NX NXOpen::Validate::RequirementCollection object.
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX8.5.0.
NXOpen::Validate::RequirementBuilder* NXOpen::Validate::RequirementCollection::CreateRequirementBuilder | ( | NXOpen::Validate::Requirement * | requirement | ) |
Creates a NXOpen::Validate::RequirementBuilder.
requirement | requirement |
NXOpen::Validate::Requirement* NXOpen::Validate::RequirementCollection::FindObject | ( | const NXString & | id | ) |
Finds the NXOpen::Validate::Requirement with the given identifier.
An exception will be thrown if no object can be found with given identifier.
id | The identifier of the NXOpen::Validate::Requirement |
NXOpen::Validate::Requirement* NXOpen::Validate::RequirementCollection::FindObject | ( | const char * | id | ) |
Finds the NXOpen::Validate::Requirement with the given identifier.
An exception will be thrown if no object can be found with given identifier.
id | The identifier of the NXOpen::Validate::Requirement |
void NXOpen::Validate::RequirementCollection::LoadFromExternalSource | ( | NXOpen::Validate::RequirementCollection::SourceTypeOptions | sourceType, |
const NXString & | source, | ||
const NXString & | revision, | ||
const NXString & | project | ||
) |
Loads NXOpen::Validate::Requirement from external source.
The source can be local file, Teamcenter requirement item or item revision, and Teamcenter spreadsheet dataset for which the input sourceType is LocalFile, Teamcenter and TeamcenterFile respectively.
Example inputs when sourceType is LocalFile
Example inputs when sourceType is Teamcenter
source is item revision 000084/A: source: "000084" revision: "A" project: empty string
source is item 000084: source: "000084" revision:empty string project: empty string
Example inputs when sourceType is TeamcenterFile
source is a spreadsheet dataset in an item revision 000085/A: source: 000085 revision: A project: "category_A" It's a sheet name in the source spreadsheet.
source is a spreadsheet dataset in item 000085: source: "000085" revision: empty string project: "category_A" It's a sheet name in the source spreadsheet.
Created in NX8.5.0.
License requirements : None
sourceType | Type of the external source |
source | File full path if sourceType is LocalFile; Item id if sourceType is Teamcenter or TeamcenterFile. |
revision | Only needed if sourceType is Teamcenter or TeamcenterFile. Revision id if source is an item revision. Null if source is an item. |
project | Required if sourceType is LocalFile or TeamcenterFile. Project name if the source is a XML file; Sheet name if source is a spreadsheet file. |
void NXOpen::Validate::RequirementCollection::LoadFromExternalSource | ( | NXOpen::Validate::RequirementCollection::SourceTypeOptions | sourceType, |
const char * | source, | ||
const char * | revision, | ||
const char * | project | ||
) |
Loads NXOpen::Validate::Requirement from external source.
The source can be local file, Teamcenter requirement item or item revision, and Teamcenter spreadsheet dataset for which the input sourceType is LocalFile, Teamcenter and TeamcenterFile respectively.
Example inputs when sourceType is LocalFile
Example inputs when sourceType is Teamcenter
source is item revision 000084/A: source: "000084" revision: "A" project: empty string
source is item 000084: source: "000084" revision:empty string project: empty string
Example inputs when sourceType is TeamcenterFile
source is a spreadsheet dataset in an item revision 000085/A: source: 000085 revision: A project: "category_A" It's a sheet name in the source spreadsheet.
source is a spreadsheet dataset in item 000085: source: "000085" revision: empty string project: "category_A" It's a sheet name in the source spreadsheet.
Created in NX8.5.0.
License requirements : None
sourceType | Type of the external source |
source | File full path if sourceType is LocalFile; Item id if sourceType is Teamcenter or TeamcenterFile. |
revision | Only needed if sourceType is Teamcenter or TeamcenterFile. Revision id if source is an item revision. Null if source is an item. |
project | Required if sourceType is LocalFile or TeamcenterFile. Project name if the source is a XML file; Sheet name if source is a spreadsheet file. |
void NXOpen::Validate::RequirementCollection::RefreshFromExternalSource | ( | const std::vector< NXOpen::Validate::Requirement * > & | requirementTags | ) |
Refreshes the requirements from external source.
Created in NX10.0.0.
License requirements : None
requirementTags | requirementtags |
NXString NXOpen::Validate::RequirementCollection::RevisionRule | ( | ) |
Returns the revision rule for requirement from Teamcenter
Created in NX8.5.0.
License requirements : None
void NXOpen::Validate::RequirementCollection::SetRevisionRule | ( | const NXString & | rule | ) |
Sets the revision rule for requirement from Teamcenter
Created in NX8.5.0.
License requirements : None
rule | rule |
void NXOpen::Validate::RequirementCollection::SetRevisionRule | ( | const char * | rule | ) |
Sets the revision rule for requirement from Teamcenter
Created in NX8.5.0.
License requirements : None
rule | rule |
tag_t NXOpen::Validate::RequirementCollection::Tag | ( | ) | const |
Returns the tag of this object.