NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder Class Reference

Represents a PipeStockBuilder. More...

Inheritance diagram for NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder:

Public Member Functions
NXOpen::DiagrammingLibraryAuthor::AttributeHolder *	CreatePipeStock (const NXString &instanceId, const NXString &partId, const NXString &partName, const NXString &numberName)
	Creates a new pipe stock. More...
NXOpen::DiagrammingLibraryAuthor::AttributeHolder *	CreatePipeStock (const char *instanceId, const char *partId, const char *partName, const char *numberName)
	Creates a new pipe stock. More...
void	DeletePipeStock (NXOpen::DiagrammingLibraryAuthor::AttributeHolder *pipeStockObject)
	Deletes the pipe stock which is new created Created in NX11.0.1. More...
void	GetPipeStockObjects (std::vector< NXOpen::DiagrammingLibraryAuthor::AttributeHolder * > &pipeStockObjects)
	Gets the pipe stock objects which have user attributes of the pipe stock. More...
void	SelectFolder (const NXString &classId)
	Selects the pipe stock folder by the class ID Created in NX11.0.1. More...
void	SelectFolder (const char *classId)
	Selects the pipe stock folder by the class ID Created in NX11.0.1. More...
void	SelectPipeStock (const NXString &symbolId)
	Selects one pipe stock by the symbol ID Created in NX11.0.1. More...
void	SelectPipeStock (const char *symbolId)
	Selects one pipe stock by the symbol ID Created in NX11.0.1. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a PipeStockBuilder.

Created in NX11.0.1.

Member Function Documentation

NXOpen::DiagrammingLibraryAuthor::AttributeHolder* NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::CreatePipeStock	(	const NXString &	instanceId,
		const NXString &	partId,
		const NXString &	partName,
		const NXString &	numberName
	)

Creates a new pipe stock.

Returns

the pipe stock object
Created in NX11.0.1.

License requirements : None

Parameters

instanceId	instanceid
partId	partid
partName	partname
numberName	numbername

NXOpen::DiagrammingLibraryAuthor::AttributeHolder* NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::CreatePipeStock	(	const char *	instanceId,
		const char *	partId,
		const char *	partName,
		const char *	numberName
	)

Creates a new pipe stock.

Returns

the pipe stock object
Created in NX11.0.1.

License requirements : None

Parameters

instanceId	instanceid
partId	partid
partName	partname
numberName	numbername

void NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::DeletePipeStock

(

NXOpen::DiagrammingLibraryAuthor::AttributeHolder *

pipeStockObject

)

Deletes the pipe stock which is new created
Created in NX11.0.1.

License requirements : None

Parameters

pipeStockObject

the pipe stock object, only accept the object which is got by NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::CreatePipeStock

void NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::GetPipeStockObjects

(

std::vector< NXOpen::DiagrammingLibraryAuthor::AttributeHolder * > &

pipeStockObjects

)

Gets the pipe stock objects which have user attributes of the pipe stock.

Created in NX11.0.1.

License requirements : None

Parameters

pipeStockObjects

the pipe stock objects

void NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::SelectFolder

(

const NXString &

classId

)

Selects the pipe stock folder by the class ID
Created in NX11.0.1.

License requirements : None

Parameters

classId

classid

void NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::SelectFolder

(

const char *

classId

)

Selects the pipe stock folder by the class ID
Created in NX11.0.1.

License requirements : None

Parameters

classId

classid

void NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::SelectPipeStock

(

const NXString &

symbolId

)

Selects one pipe stock by the symbol ID
Created in NX11.0.1.

License requirements : None

Parameters

symbolId

symbolid

void NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::SelectPipeStock

(

const char *

symbolId

)

Selects one pipe stock by the symbol ID
Created in NX11.0.1.

License requirements : None

Parameters

symbolId

symbolid

virtual bool NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

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

• DiagrammingLibraryAuthor_PipeStockBuilder.hxx