NXOpen::Routing::Electrical::ElectricalFormatCollection Class Reference

Represents a Routing ElectricalFormatCollection object. More...

Inheritance diagram for NXOpen::Routing::Electrical::ElectricalFormatCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element.
NXOpen::Routing::Electrical::ElectricalFormat *	CreateFormat (const NXString &name, NXOpen::Routing::Electrical::ElectricalFormat::Type type)
	Creates a Routing::Electrical::ElectricalFormat object.
NXOpen::Routing::Electrical::ElectricalFormat *	CreateFormat (const char *name, NXOpen::Routing::Electrical::ElectricalFormat::Type type)
	Creates a Routing::Electrical::ElectricalFormat object.
iterator	end ()
	Returns an iterator addressing one past the last element.
NXOpen::Routing::Electrical::ElectricalFormat *	GetDisplayFormat (NXOpen::Routing::Electrical::ElectricalFormat::Type type)
	Get the displayed Routing::Electrical::ElectricalFormat object for the given navigator type.
void	SetDisplayFormat (NXOpen::Routing::Electrical::ElectricalFormat::Type type, NXOpen::Routing::Electrical::ElectricalFormat *format)
	Set the Routing::Electrical::ElectricalFormat object as displayed format for the given navigator type.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Routing ElectricalFormatCollection object.

     <br> To obtain an instance of this class, refer to @link Routing::RouteManager  Routing::RouteManager @endlink  <br> 

Created in NX5.0.1.

Member Function Documentation

iterator NXOpen::Routing::Electrical::ElectricalFormatCollection::begin

(

)

Returns an iterator addressing the first element.

NXOpen::Routing::Electrical::ElectricalFormat* NXOpen::Routing::Electrical::ElectricalFormatCollection::CreateFormat	(	const NXString &	name,
		NXOpen::Routing::Electrical::ElectricalFormat::Type	type
	)

Creates a Routing::Electrical::ElectricalFormat object.

Returns

Created in NX5.0.1.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
type	type

NXOpen::Routing::Electrical::ElectricalFormat* NXOpen::Routing::Electrical::ElectricalFormatCollection::CreateFormat	(	const char *	name,
		NXOpen::Routing::Electrical::ElectricalFormat::Type	type
	)

Creates a Routing::Electrical::ElectricalFormat object.

Returns

Created in NX5.0.1.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
type	type

iterator NXOpen::Routing::Electrical::ElectricalFormatCollection::end

(

)

Returns an iterator addressing one past the last element.

NXOpen::Routing::Electrical::ElectricalFormat* NXOpen::Routing::Electrical::ElectricalFormatCollection::GetDisplayFormat

(

NXOpen::Routing::Electrical::ElectricalFormat::Type

type

)

Get the displayed Routing::Electrical::ElectricalFormat object for the given navigator type.

Returns

Created in NX5.0.1.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

type

type

void NXOpen::Routing::Electrical::ElectricalFormatCollection::SetDisplayFormat	(	NXOpen::Routing::Electrical::ElectricalFormat::Type	type,
		NXOpen::Routing::Electrical::ElectricalFormat *	format
	)

Set the Routing::Electrical::ElectricalFormat object as displayed format for the given navigator type.

Created in NX5.0.1.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

type	type
format	format

tag_t NXOpen::Routing::Electrical::ElectricalFormatCollection::Tag

(

)

const

Returns the tag of this object.

---

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

• Routing_Electrical_ElectricalFormatCollection.hxx