Represents an NX NXOpen::Validate::RequirementCollection object. More...

Inheritance diagram for NXOpen::Validate::RequirementCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Types
enum	SourceTypeOptions { SourceTypeOptionsLocalFile, SourceTypeOptionsTeamcenterFile, SourceTypeOptionsTeamcenter, SourceTypeOptionsMeasurableAttribute }
	This enum represents the type of external source where requirement is defined. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element. More...

NXOpen::Validate::RequirementBuilder *	CreateRequirementBuilder (NXOpen::Validate::Requirement *requirement)
	Creates a NXOpen::Validate::RequirementBuilder. More...

iterator	end ()
	Returns an iterator addressing one past the last element. 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...

Detailed Description

Represents an NX NXOpen::Validate::RequirementCollection object.

To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::Validate::RequirementCollection::SourceTypeOptions

This enum represents the type of external source where requirement is defined.

Enumerator
SourceTypeOptionsLocalFile	local file
SourceTypeOptionsTeamcenterFile	teamcenter file
SourceTypeOptionsTeamcenter	teamcenter
SourceTypeOptionsMeasurableAttribute	measurable attribute

Member Function Documentation

iterator NXOpen::Validate::RequirementCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Validate::RequirementBuilder* NXOpen::Validate::RequirementCollection::CreateRequirementBuilder ( NXOpen::Validate::Requirement * requirement )

Creates a NXOpen::Validate::RequirementBuilder.

Returns: Created in NX8.5.0.

License requirements : None

Parameters

requirement requirement

iterator NXOpen::Validate::RequirementCollection::end ( )

Returns an iterator addressing one past the last element.

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.

Returns: NXOpen::Validate::Requirement with the identifier
Created in NX8.5.0.

License requirements : None

Parameters

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.

Returns: NXOpen::Validate::Requirement with the identifier
Created in NX8.5.0.

License requirements : None

Parameters

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

source: "C:\requirement.xml" or "C:\requirement_spreadsheet.xls"
revision: empty string
project: "category_A" It's a project node name in the source XML file or a sheet name in the source spreadsheet file.

Example inputs when sourceType is Teamcenter

If source is item revision 000084/A:

source: "000084"
revision: "A"
project: empty string

If source is item 000084:

source: "000084"
revision:empty string
project: empty string

Example inputs when sourceType is TeamcenterFile

If 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.

If 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

Parameters

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

source: "C:\requirement.xml" or "C:\requirement_spreadsheet.xls"
revision: empty string
project: "category_A" It's a project node name in the source XML file or a sheet name in the source spreadsheet file.

Example inputs when sourceType is Teamcenter

If source is item revision 000084/A:

source: "000084"
revision: "A"
project: empty string

If source is item 000084:

source: "000084"
revision:empty string
project: empty string

Example inputs when sourceType is TeamcenterFile

If 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.

If 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

Parameters

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

Parameters

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

Parameters

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

Parameters

rule rule

tag_t NXOpen::Validate::RequirementCollection::Tag ( ) const

Returns the tag of this object.

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

Validate_RequirementCollection.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation