NXOpen.Validate.RequirementCollection Class Reference

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

Inheritance diagram for NXOpen.Validate.RequirementCollection:

Public Types
enum	SourceTypeOptions { LocalFile, TeamcenterFile, Teamcenter, MeasurableAttribute }
	This enum represents the type of external source where requirement is defined More...

Public Member Functions
unsafe NXOpen.Validate.RequirementBuilder	CreateRequirementBuilder (NXOpen.Validate.Requirement requirement)
	Creates a NXOpen.Validate.RequirementBuilder More...
unsafe NXOpen.Validate.Requirement	FindObject (string id)
	Finds the NXOpen.Validate.Requirement with the given identifier. More...
unsafe void	LoadFromExternalSource (NXOpen.Validate.RequirementCollection.SourceTypeOptions sourceType, string source, string revision, string project)
	Loads NXOpen.Validate.Requirement from external source. More...
unsafe void	RefreshFromExternalSource (NXOpen.Validate.Requirement[] requirementTags)
	Refreshes the requirements from external source. More...
NXOpen.Validate.Requirement[]	ToArray ()
	Returns an array of NXOpen.Validate.Requirement objects. More...
Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator	GetEnumerator ()
	Returns an enumerator that iterates through a collection. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Protected Member Functions
override int	EnumerateMoveNext (ref Tag currentTag, byte[] state)
	Advances the enumerator to the next element of the collection. More...
Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void	initialize ()
	<exclude> More...
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Properties
unsafe string	RevisionRule [get, set]
	Returns or sets the revision rule for requirement from Teamcenter More...
Tag	Tag [get]
	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
LocalFile
TeamcenterFile
Teamcenter
MeasurableAttribute

Member Function Documentation

unsafe NXOpen.Validate.RequirementBuilder NXOpen.Validate.RequirementCollection.CreateRequirementBuilder ( NXOpen.Validate.Requirement  requirement )

inline

Creates a NXOpen.Validate.RequirementBuilder

Created in NX8.5.0

License requirements: None.

Parameters

requirement

Returns

override int NXOpen.Validate.RequirementCollection.EnumerateMoveNext ( ref Tag  currentTag, byte[]  state  )

inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.Validate.Requirement NXOpen.Validate.RequirementCollection.FindObject ( string  id )

inline

Finds the NXOpen.Validate.Requirement with the given identifier.

An exception will be thrown if no object can be found with given identifier.

Created in NX8.5.0

License requirements: None.

Parameters

id	The identifier of the NXOpen.Validate.Requirement

Returns

NXOpen.Validate.Requirement with the identifier

unsafe void NXOpen.Validate.RequirementCollection.LoadFromExternalSource ( NXOpen.Validate.RequirementCollection.SourceTypeOptions  sourceType, string  source, string  revision, string  project  )

inline

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

1. source: "C:\requirement.xml" or "C:\requirement_spreadsheet.xls"
2. revision: empty string
3. 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:

1. source: "000084"
2. revision: "A"
3. project: empty string

If source is item 000084:

1. source: "000084"
2. revision:empty string
3. project: empty string

Example inputs when sourceType is TeamcenterFile

If source is a spreadsheet dataset in an item revision 000085/A:

1. source: 000085
2. revision: A
3. project: "category_A" It's a sheet name in the source spreadsheet.

If source is a spreadsheet dataset in item 000085:

1. source: "000085"
2. revision: empty string
3. 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.

unsafe void NXOpen.Validate.RequirementCollection.RefreshFromExternalSource ( NXOpen.Validate.Requirement[]  requirementTags )

inline

Refreshes the requirements from external source.

Created in NX10.0.0

License requirements: None.

Parameters

requirementTags

NXOpen.Validate.Requirement [] NXOpen.Validate.RequirementCollection.ToArray ( )

inline

Returns an array of NXOpen.Validate.Requirement objects.

Property Documentation

unsafe string NXOpen.Validate.RequirementCollection.RevisionRule

getset

Returns or sets the revision rule for requirement from Teamcenter

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.Validate.RequirementCollection.Tag

get

Returns the tag of this object.

---

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

• Validate_RequirementCollection.cs