NXOpen::Drawings::OrderManager Class Reference

Represents an object that manages orders. More...

Public Member Functions
void	ApplyOrder (NXOpen::Sketch *parentObject, const NXString &orderName)
	Applies the order matching the specified name Created in NX11.0.0. More...
void	ApplyOrder (NXOpen::Sketch *parentObject, const char *orderName)
	Applies the order matching the specified name Created in NX11.0.0. More...
void	CreateNewOrder (NXOpen::Sketch *parentObject, const NXString &newOrderName, const std::vector< NXOpen::Layout2d::Component * > &objectsInOrder)
	Creates an order of the 2D Components provided in the list Created in NX11.0.0. More...
void	CreateNewOrder (NXOpen::Sketch *parentObject, const char *newOrderName, const std::vector< NXOpen::Layout2d::Component * > &objectsInOrder)
	Creates an order of the 2D Components provided in the list Created in NX11.0.0. More...
void	DeleteOrder (NXOpen::Sketch *parentObject, const NXString &newOrderName)
	Delete the order matching the specified name Created in NX11.0.0. More...
void	DeleteOrder (NXOpen::Sketch *parentObject, const char *newOrderName)
	Delete the order matching the specified name Created in NX11.0.0. More...
void	GetAvailableOrdersNames (NXOpen::Sketch *parentObject, std::vector< NXString > &ordersNames)
	Gets all available orders names for specified sketch parent Created in NX11.0.0. More...
NXString	GetCurrentOrderName (NXOpen::Sketch *parentObject)
	Gets the current applied order name Created in NX11.0.0. More...
bool	IsSystemOrder (NXOpen::Sketch *parentObject, const NXString &orderName)
	Validates the order matching the specified name is system order Created in NX11.0.0. More...
bool	IsSystemOrder (NXOpen::Sketch *parentObject, const char *orderName)
	Validates the order matching the specified name is system order Created in NX11.0.0. More...
void	RenameOrder (NXOpen::Sketch *parentObject, const NXString &orderName, const NXString &newOrderName)
	Renames the order matching the specified name with the new name provided Created in NX11.0.0. More...
void	RenameOrder (NXOpen::Sketch *parentObject, const char *orderName, const char *newOrderName)
	Renames the order matching the specified name with the new name provided Created in NX11.0.0. More...
void	Reorder (NXOpen::Sketch *parentObject, const std::vector< NXOpen::Layout2d::Component * > &objectsInOrder)
	Updates the current order based on the provided list of 2D components if the order is user-defined, and creates a new order otherwide Created in NX11.0.0. More...
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents an object that manages orders.

An order represents the way 2D components are presented in the sketch node in the part navigator. There are two types of orders, system and user-defined. System orders cannot be modified.
To obtain an instance of this class, refer to NXOpen::Layout2d::ComponentCollection

Created in NX11.0.0.

Member Function Documentation

void NXOpen::Drawings::OrderManager::ApplyOrder	(	NXOpen::Sketch *	parentObject,
		const NXString &	orderName
	)

Applies the order matching the specified name
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
orderName	ordername

void NXOpen::Drawings::OrderManager::ApplyOrder	(	NXOpen::Sketch *	parentObject,
		const char *	orderName
	)

Applies the order matching the specified name
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
orderName	ordername

void NXOpen::Drawings::OrderManager::CreateNewOrder	(	NXOpen::Sketch *	parentObject,
		const NXString &	newOrderName,
		const std::vector< NXOpen::Layout2d::Component * > &	objectsInOrder
	)

Creates an order of the 2D Components provided in the list
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
newOrderName	newordername
objectsInOrder	Array of objects to be reordered

void NXOpen::Drawings::OrderManager::CreateNewOrder	(	NXOpen::Sketch *	parentObject,
		const char *	newOrderName,
		const std::vector< NXOpen::Layout2d::Component * > &	objectsInOrder
	)

Creates an order of the 2D Components provided in the list
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
newOrderName	newordername
objectsInOrder	Array of objects to be reordered

void NXOpen::Drawings::OrderManager::DeleteOrder	(	NXOpen::Sketch *	parentObject,
		const NXString &	newOrderName
	)

Delete the order matching the specified name
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
newOrderName	newordername

void NXOpen::Drawings::OrderManager::DeleteOrder	(	NXOpen::Sketch *	parentObject,
		const char *	newOrderName
	)

Delete the order matching the specified name
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
newOrderName	newordername

void NXOpen::Drawings::OrderManager::GetAvailableOrdersNames	(	NXOpen::Sketch *	parentObject,
		std::vector< NXString > &	ordersNames
	)

Gets all available orders names for specified sketch parent
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
ordersNames	ordersnames

NXString NXOpen::Drawings::OrderManager::GetCurrentOrderName

(

NXOpen::Sketch *

parentObject

)

Gets the current applied order name
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject

parentobject

bool NXOpen::Drawings::OrderManager::IsSystemOrder	(	NXOpen::Sketch *	parentObject,
		const NXString &	orderName
	)

Validates the order matching the specified name is system order
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
orderName	ordername

bool NXOpen::Drawings::OrderManager::IsSystemOrder	(	NXOpen::Sketch *	parentObject,
		const char *	orderName
	)

Validates the order matching the specified name is system order
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
orderName	ordername

void NXOpen::Drawings::OrderManager::RenameOrder	(	NXOpen::Sketch *	parentObject,
		const NXString &	orderName,
		const NXString &	newOrderName
	)

Renames the order matching the specified name with the new name provided
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
orderName	ordername
newOrderName	newordername

void NXOpen::Drawings::OrderManager::RenameOrder	(	NXOpen::Sketch *	parentObject,
		const char *	orderName,
		const char *	newOrderName
	)

Renames the order matching the specified name with the new name provided
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
orderName	ordername
newOrderName	newordername

void NXOpen::Drawings::OrderManager::Reorder	(	NXOpen::Sketch *	parentObject,
		const std::vector< NXOpen::Layout2d::Component * > &	objectsInOrder
	)

Updates the current order based on the provided list of 2D components if the order is user-defined, and creates a new order otherwide
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

parentObject	parentobject
objectsInOrder	Array of objects to be reordered

tag_t NXOpen::Drawings::OrderManager::Tag

(

)

const

Returns the tag of this object.

---

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

• Drawings_OrderManager.hxx