NXOpen::Features::ShipDesign::RoomAttributeListBuilder Class Reference

The builder to define room attributes
Created in NX12.0.0. More...

Inheritance diagram for NXOpen::Features::ShipDesign::RoomAttributeListBuilder:

Public Member Functions
void	InitFromObject (NXOpen::TaggedObject *objectTag)
	Initializes the builder from an object. More...
void	SetAttribute (int index, const NXString &attrName, const NXString &attrValue)
	Sets the specific attribute name and value given the index in the list. More...
void	SetAttribute (int index, const char *attrName, const char *attrValue)
	Sets the specific attribute name and value given the index in the list. More...
void	SetRoomPurpose (const NXString &roomPurpose)
	Sets the room purpose. More...
void	SetRoomPurpose (const char *roomPurpose)
	Sets the room purpose. More...
void	UpdateAttributes (std::vector< NXString > &attrNames, std::vector< NXString > &attrValues)
	Updates all attributes with new name and values. 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

The builder to define room attributes
Created in NX12.0.0.

Member Function Documentation

void NXOpen::Features::ShipDesign::RoomAttributeListBuilder::InitFromObject

(

NXOpen::TaggedObject *

objectTag

)

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

void NXOpen::Features::ShipDesign::RoomAttributeListBuilder::SetAttribute	(	int	index,
		const NXString &	attrName,
		const NXString &	attrValue
	)

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	index
attrName	attrname
attrValue	attrvalue

void NXOpen::Features::ShipDesign::RoomAttributeListBuilder::SetAttribute	(	int	index,
		const char *	attrName,
		const char *	attrValue
	)

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	index
attrName	attrname
attrValue	attrvalue

void NXOpen::Features::ShipDesign::RoomAttributeListBuilder::SetRoomPurpose

(

const NXString &

roomPurpose

)

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

roompurpose

void NXOpen::Features::ShipDesign::RoomAttributeListBuilder::SetRoomPurpose

(

const char *

roomPurpose

)

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

roompurpose

void NXOpen::Features::ShipDesign::RoomAttributeListBuilder::UpdateAttributes	(	std::vector< NXString > &	attrNames,
		std::vector< NXString > &	attrValues
	)

Updates all attributes with new name and values.

Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

attrNames	attrnames
attrValues	attrvalues

virtual bool NXOpen::Features::ShipDesign::RoomAttributeListBuilder::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:

• Features_ShipDesign_RoomAttributeListBuilder.hxx