NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Routing::Electrical::ElectricalFormatCollection Class Reference

Represents a Routing NXOpen::Routing::Electrical::ElectricalFormatCollection object. More...

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

Classes

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

Public Member Functions

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

Detailed Description

Represents a Routing NXOpen::Routing::Electrical::ElectricalFormatCollection object.


To obtain an instance of this class, refer to NXOpen::Routing::RouteManager

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 NXOpen::Routing::Electrical::ElectricalFormat object.

Returns

Created in NX5.0.1.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
namename
typetype
NXOpen::Routing::Electrical::ElectricalFormat* NXOpen::Routing::Electrical::ElectricalFormatCollection::CreateFormat ( const char *  name,
NXOpen::Routing::Electrical::ElectricalFormat::Type  type 
)

Creates a NXOpen::Routing::Electrical::ElectricalFormat object.

Returns

Created in NX5.0.1.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
namename
typetype
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 NXOpen::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
typetype
void NXOpen::Routing::Electrical::ElectricalFormatCollection::SetDisplayFormat ( NXOpen::Routing::Electrical::ElectricalFormat::Type  type,
NXOpen::Routing::Electrical::ElectricalFormat format 
)

Set the NXOpen::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
typetype
formatformat
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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.