Represents a AutomaticTableBuilder. More...

Inheritance diagram for NXOpen::PID::AutomaticTableBuilder:

Public Types
enum	ObjectTypeOption { ObjectTypeOptionEquipment, ObjectTypeOptionInlineEquipment, ObjectTypeOptionRun, ObjectTypeOptionPipeStock }
	Represents the object type. More...

enum	ScopeTypeOption { ScopeTypeOptionCurrentSheet, ScopeTypeOptionOtherSheet, ScopeTypeOptionSystem }
	Represents the scope type. More...

Public Member Functions
int	GetNumberOfPropertyCellRanges ()
	Gets the number of property cell ranges. More...

NXOpen::PID::PropertyCellRangeBuilder *	GetPropertyCellRange (int index)
	Gets the property cell range at the given index. More...

void	InsertPropertyCellRanges (int index, const std::vector< NXOpen::PID::PropertyType > &propertyTypes, const std::vector< NXString > &propertyKeys)
	Inserts the given number of property cell ranges at the given index. More...

bool	ManualUpdate ()
	Returns the manual update flag. More...

NXOpen::PID::AutomaticTableBuilder::ObjectTypeOption	ObjectType ()
	Returns the object type. More...

void	RemovePropertyCellRanges (int index, int number)
	Removes the given number of property cell ranges starting with the given index. More...

NXOpen::PID::AutomaticTableBuilder::ScopeTypeOption	ScopeType ()
	Returns the scope type. More...

void	SetManualUpdate (bool manualUpdate)
	Sets the manual update flag. More...

void	SetObjectType (NXOpen::PID::AutomaticTableBuilder::ObjectTypeOption objectType)
	Sets the object type. More...

void	SetScopeType (NXOpen::PID::AutomaticTableBuilder::ScopeTypeOption scopeType)
	Sets the scope type. More...

void	SetSheet (NXOpen::PID::Sheet *sheet)
	Sets the sheet, only available if the ScopeType is OtherSheet. More...

void	SetSystem (NXOpen::Assemblies::Partition *system)
	Sets the system, only available if the ScopeType is System. More...

NXOpen::PID::Sheet *	Sheet ()
	Returns the sheet, only available if the ScopeType is OtherSheet. More...

NXOpen::Assemblies::Partition *	System ()
	Returns the system, only available if the ScopeType is System. More...

NXOpen::Diagramming::Tables::TableBuilder *	Table ()
	Returns the NXOpen::Diagramming::Tables::TableBuilder of the NXOpen::Diagramming::Tables::Table . More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 AutomaticTableBuilder.

To create a new instance of this class, use NXOpen::PID::PidManager::CreateAutomaticTableBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::PID::AutomaticTableBuilder::ObjectTypeOption

Represents the object type.

Created in NX1847.0.0.

Enumerator
ObjectTypeOptionEquipment	Equipment.
ObjectTypeOptionInlineEquipment	Inline quipment.
ObjectTypeOptionRun	Run.
ObjectTypeOptionPipeStock	Pipe Stock.

enum NXOpen::PID::AutomaticTableBuilder::ScopeTypeOption

Represents the scope type.

Created in NX1847.0.0.

Enumerator
ScopeTypeOptionCurrentSheet	Lists objects in current sheet.
ScopeTypeOptionOtherSheet	Lists objects in other sheet.
ScopeTypeOptionSystem	Lists objects in specific system.

Member Function Documentation

int NXOpen::PID::AutomaticTableBuilder::GetNumberOfPropertyCellRanges ( )

Gets the number of property cell ranges.

Returns: the number of property cell ranges
Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::PID::PropertyCellRangeBuilder* NXOpen::PID::AutomaticTableBuilder::GetPropertyCellRange ( int index )

Gets the property cell range at the given index.

The index must be greater than or equal to 0, and less than the number of property cell ranges.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

index the index of property cell range

void NXOpen::PID::AutomaticTableBuilder::InsertPropertyCellRanges	(	int	index,
		const std::vector< NXOpen::PID::PropertyType > &	propertyTypes,
		const std::vector< NXString > &	propertyKeys
	)

Inserts the given number of property cell ranges at the given index.

The index must be greater than or equal to 0, and less than or equal to the number of property cell ranges. The number of property types and the number of property keys must be same, and must be greater than 0.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

index	the index of the first inserted property cell range
propertyTypes	the property types of inserted property cell ranges
propertyKeys	the property keys of inserted property cell ranges

bool NXOpen::PID::AutomaticTableBuilder::ManualUpdate ( )

Returns the manual update flag.

If true, the automatic update will be disabled, the table could be updated manually.
Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::PID::AutomaticTableBuilder::ObjectTypeOption NXOpen::PID::AutomaticTableBuilder::ObjectType ( )

Returns the object type.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

void NXOpen::PID::AutomaticTableBuilder::RemovePropertyCellRanges	(	int	index,
		int	number
	)

Removes the given number of property cell ranges starting with the given index.

The index must be greater than or equal to 0, and less than the number of property cell ranges. The number must be greater than 0, and "index + number" must be less than or equal to the number of property cell ranges.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

index	the index of the first removed property cell range
number	the number of removed property cell ranges

NXOpen::PID::AutomaticTableBuilder::ScopeTypeOption NXOpen::PID::AutomaticTableBuilder::ScopeType ( )

Returns the scope type.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

void NXOpen::PID::AutomaticTableBuilder::SetManualUpdate ( bool manualUpdate )

Sets the manual update flag.

If true, the automatic update will be disabled, the table could be updated manually.
Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

manualUpdate manualupdate

void NXOpen::PID::AutomaticTableBuilder::SetObjectType ( NXOpen::PID::AutomaticTableBuilder::ObjectTypeOption objectType )

Sets the object type.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

objectType objecttype

void NXOpen::PID::AutomaticTableBuilder::SetScopeType ( NXOpen::PID::AutomaticTableBuilder::ScopeTypeOption scopeType )

Sets the scope type.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

scopeType scopetype

void NXOpen::PID::AutomaticTableBuilder::SetSheet ( NXOpen::PID::Sheet * sheet )

Sets the sheet, only available if the ScopeType is OtherSheet.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

sheet sheet

void NXOpen::PID::AutomaticTableBuilder::SetSystem ( NXOpen::Assemblies::Partition * system )

Sets the system, only available if the ScopeType is System.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

system system

NXOpen::PID::Sheet* NXOpen::PID::AutomaticTableBuilder::Sheet ( )

Returns the sheet, only available if the ScopeType is OtherSheet.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::Assemblies::Partition* NXOpen::PID::AutomaticTableBuilder::System ( )

Returns the system, only available if the ScopeType is System.

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::Diagramming::Tables::TableBuilder* NXOpen::PID::AutomaticTableBuilder::Table ( )

Returns the NXOpen::Diagramming::Tables::TableBuilder of the NXOpen::Diagramming::Tables::Table .

Created in NX1847.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

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

PID_AutomaticTableBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation