The builder to define room attributes More...

Inheritance diagram for NXOpen.Features.ShipDesign.RoomAttributeListBuilder:

Public Member Functions
unsafe void	EditItem (int row, string roomPurpose, string roomSubPurpose)
	Updates the room purpose and sub-purpose. More...

unsafe void	InitFromObject (NXOpen.TaggedObject objectTag)
	Initializes the builder from an object. More...

unsafe void	InitializeFromMultipleObjects (NXOpen.TaggedObject[] objs)
	Initializes the builder from objects. More...

unsafe void	SetAttribute (int index, string attrName, string attrValue)
	Sets the specific attribute name and value given the index in the list. More...

unsafe void	SetRoomPurpose (string roomPurpose)
	Sets the room purpose. More...

unsafe void	SetRoomSubPurpose (string roomSubPurpose)
	Sets the room sub purpose. More...

unsafe void	UpdateAttributes (string[] attrNames, string[] attrValues)
	Updates all attributes with new name and values. More...

unsafe void	UpdateAttributeValue (int row, string headString, string value)
	Updates the specific attribute value. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. 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...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Detailed Description

The builder to define room attributes

Created in NX12.0.0

Member Function Documentation

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.EditItem	(	int	row,
		string	roomPurpose,
		string	roomSubPurpose
	)

inline

Updates the room purpose and sub-purpose.

Created in NX12.0.2

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

row
roomPurpose
roomSubPurpose

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.InitFromObject ( NXOpen.TaggedObject objectTag )

inline

Initializes the builder from an object.

Created in NX12.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

objectTag Body or Component

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.InitializeFromMultipleObjects ( NXOpen.TaggedObject[] objs )

inline

Initializes the builder from objects.

Created in NX12.0.2

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

objs	Bodies or Components

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.SetAttribute	(	int	index,
		string	attrName,
		string	attrValue
	)

inline

Sets the specific attribute name and value given the index in the list.

Created in NX12.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

index
attrName
attrValue

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.SetRoomPurpose ( string roomPurpose )

inline

Sets the room purpose.

If room purpose changes, this will try to reconstruct the attribute list because different attributes are pre-defined for different room purposes.

Created in NX12.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

roomPurpose

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.SetRoomSubPurpose ( string roomSubPurpose )

inline

Sets the room sub purpose.

If the room sub purpose is changed, this method will try to reconstruct the attribute list because different attributes are pre-defined for different room sub purposes.

Created in NX12.0.2

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

roomSubPurpose

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.UpdateAttributes	(	string[]	attrNames,
		string[]	attrValues
	)

inline

Updates all attributes with new name and values.

Created in NX12.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

attrNames
attrValues

unsafe void NXOpen.Features.ShipDesign.RoomAttributeListBuilder.UpdateAttributeValue	(	int	row,
		string	headString,
		string	value
	)

inline

Updates the specific attribute value.

Created in NX12.0.2

License requirements: nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

row
headString
value

unsafe bool NXOpen.Features.ShipDesign.RoomAttributeListBuilder.Validate ( )

inline

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.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

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

Features_ShipDesign_RoomAttributeListBuilder.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation