Represents an NX 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 Validate::RequirementBuilder.

NXOpen::Validate::Requirement *	FindObject (const NXString &id)
	Finds the Validate::Requirement with the given identifier.

NXOpen::Validate::Requirement *	FindObject (const char *id)
	Finds the Validate::Requirement with the given identifier.

void	LoadFromExternalSource (NXOpen::Validate::RequirementCollection::SourceTypeOptions sourceType, const NXString &source, const NXString &revision, const NXString &project)
	Loads Validate::Requirement from external source.

void	LoadFromExternalSource (NXOpen::Validate::RequirementCollection::SourceTypeOptions sourceType, const char source, const char revision, const char *project)
	Loads Validate::Requirement from external source.

NXString	RevisionRule ()
	Returns the revision rule for requirement from Teamcenter Created in NX8.5.0.

void	SetRevisionRule (const NXString &rule)
	Sets the revision rule for requirement from Teamcenter Created in NX8.5.0.

void	SetRevisionRule (const char *rule)
	Sets the revision rule for requirement from Teamcenter Created in NX8.5.0.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents an NX Validate::RequirementCollection object.

<br> To obtain an instance of this class, refer to @link BasePart  BasePart @endlink  <br>

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

Member Function Documentation

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

Creates a Validate::RequirementBuilder.

Returns: Created in NX8.5.0.

License requirements : None

Parameters

requirement requirement

NXOpen::Validate::Requirement* NXOpen::Validate::RequirementCollection::FindObject ( const NXString & id )

Finds the Validate::Requirement with the given identifier.

       An exception will be thrown if no object can be found with given identifier.  @return  @link Validate::Requirement Validate::Requirement@endlink  with the identifier

Created in NX8.5.0.

License requirements : None

Parameters

id	The identifier of the Validate::Requirement

NXOpen::Validate::Requirement* NXOpen::Validate::RequirementCollection::FindObject ( const char * id )

Finds the Validate::Requirement with the given identifier.

       An exception will be thrown if no object can be found with given identifier.  @return  @link Validate::Requirement Validate::Requirement@endlink  with the identifier

Created in NX8.5.0.

License requirements : None

Parameters

id	The identifier of the Validate::Requirement

void NXOpen::Validate::RequirementCollection::LoadFromExternalSource	(	NXOpen::Validate::RequirementCollection::SourceTypeOptions	sourceType,
		const NXString &	source,
		const NXString &	revision,
		const NXString &	project
	)

Loads 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.
    <br/>
        Example inputs when sourceType is LocalFile
    <ol>
    <li>source: "C:\requirement.xml" or "C:\requirement_spreadsheet.xls"</li>
    <li>revision: empty string</li>
    <li>project: "category_A" It's a project node name in the source XML file or a sheet name in the source spreadsheet file.</li>
    </ol>
    <br/>
        Example inputs when sourceType is Teamcenter
    <ol>
        If source is item revision 000084/A:
    <li>source: "000084"</li>
    <li>revision: "A"</li>
    <li>project: empty string</li>
    </ol>
    <ol>
        If source is item 000084:
    <li>source: "000084"</li>
    <li>revision:empty string</li>
    <li>project: empty string</li>
    </ol>
    <br/>
        Example inputs when sourceType is TeamcenterFile
    <ol>
        If source is a spreadsheet dataset in an item revision 000085/A:
    <li>source: 000085</li>
    <li>revision: A</li>
    <li>project: "category_A" It's a sheet name in the source spreadsheet.</li>
    </ol>
    <ol>
        If source is a spreadsheet dataset in item 000085:
    <li>source: "000085"</li>
    <li>revision: empty string</li>
    <li>project: "category_A" It's a sheet name in the source spreadsheet.</li>
    </ol>

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 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.
    <br/>
        Example inputs when sourceType is LocalFile
    <ol>
    <li>source: "C:\requirement.xml" or "C:\requirement_spreadsheet.xls"</li>
    <li>revision: empty string</li>
    <li>project: "category_A" It's a project node name in the source XML file or a sheet name in the source spreadsheet file.</li>
    </ol>
    <br/>
        Example inputs when sourceType is Teamcenter
    <ol>
        If source is item revision 000084/A:
    <li>source: "000084"</li>
    <li>revision: "A"</li>
    <li>project: empty string</li>
    </ol>
    <ol>
        If source is item 000084:
    <li>source: "000084"</li>
    <li>revision:empty string</li>
    <li>project: empty string</li>
    </ol>
    <br/>
        Example inputs when sourceType is TeamcenterFile
    <ol>
        If source is a spreadsheet dataset in an item revision 000085/A:
    <li>source: 000085</li>
    <li>revision: A</li>
    <li>project: "category_A" It's a sheet name in the source spreadsheet.</li>
    </ol>
    <ol>
        If source is a spreadsheet dataset in item 000085:
    <li>source: "000085"</li>
    <li>revision: empty string</li>
    <li>project: "category_A" It's a sheet name in the source spreadsheet.</li>
    </ol>

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.

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation