NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Display::DynamicSectionCollection Class Reference

Represents a collection of dynamic section objects
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Display::DynamicSectionCollection:
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...
 
std::vector
< NXOpen::Display::DynamicSection * > 
CopySections (const std::vector< NXOpen::Display::DynamicSection * > &sections, bool deleteOriginals)
 Copies the specified dynamic sections in the part. More...
 
NXOpen::Display::DynamicSectionBuilderCreateSectionBuilder (NXOpen::Display::DynamicSection *section, NXOpen::ModelingView *view)
 Creates a NXOpen::Display::DynamicSectionBuilder object if the section is NULL. More...
 
NXOpen::Display::DynamicSectionBuilderCreateSectionBuilder (NXOpen::ModelingView *view)
 Creates a NXOpen::Display::DynamicSectionBuilder object that is used to edit a section object in the specified view. More...
 
void DeleteSections (bool addUndoMark, const std::vector< NXOpen::Display::DynamicSection * > &sections)
 Deletes the specified dynamic sections in the part. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Display::DynamicSectionFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Display::DynamicSection with the given identifier as recorded in a journal. More...
 
NXOpen::Display::DynamicSectionFindObject (const char *journalIdentifier)
 Finds the NXOpen::Display::DynamicSection with the given identifier as recorded in a journal. More...
 
void MoveToDefaultLayer (const std::vector< NXOpen::Display::DynamicSection * > &dynamicSections)
 Moves the specified dynamic sections in the part to default layer. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of dynamic section objects
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX6.0.0.


Member Function Documentation

iterator NXOpen::Display::DynamicSectionCollection::begin ( )

Returns an iterator addressing the first element.

std::vector<NXOpen::Display::DynamicSection *> NXOpen::Display::DynamicSectionCollection::CopySections ( const std::vector< NXOpen::Display::DynamicSection * > &  sections,
bool  deleteOriginals 
)

Copies the specified dynamic sections in the part.

A copy of each specified dynamic section will be created and then added to the part. It is ensured that each dynamic section object in the part has a unique name. Hence, it is possible that the name of a pasted section object is different from that of the input section object if its name clashes with an existing section object in the part.
The section objects being copied must have been loaded in the memory. Otherwise this method will throw an exception.

Returns
Copied section objects in the part.
Created in NX6.0.0.

License requirements : None
Parameters
sectionsThe objects to be pasted in the part
deleteOriginalsFlag indicating whether the input sections should be deleted
NXOpen::Display::DynamicSectionBuilder* NXOpen::Display::DynamicSectionCollection::CreateSectionBuilder ( NXOpen::Display::DynamicSection section,
NXOpen::ModelingView view 
)

Creates a NXOpen::Display::DynamicSectionBuilder object if the section is NULL.

Otherwise, a Section object will be edited.
The specified view can be NULL, in which case the section object is not activated in any view.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
sectionsection
viewview
NXOpen::Display::DynamicSectionBuilder* NXOpen::Display::DynamicSectionCollection::CreateSectionBuilder ( NXOpen::ModelingView view)

Creates a NXOpen::Display::DynamicSectionBuilder object that is used to edit a section object in the specified view.

If no section object is available for the view, then a new one is created.
The specified view can not be NULL, otherwise an exception will be raised.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
viewview
void NXOpen::Display::DynamicSectionCollection::DeleteSections ( bool  addUndoMark,
const std::vector< NXOpen::Display::DynamicSection * > &  sections 
)

Deletes the specified dynamic sections in the part.

All views in which the dynamic sections were active are updated to reflect the change. An update will be performed to remove deleted objects.


Created in NX8.0.0.

License requirements : None

Parameters
addUndoMarkDetermines if a visible undo mark is added
sectionsThe dynamic sections to be deleted
iterator NXOpen::Display::DynamicSectionCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Display::DynamicSection* NXOpen::Display::DynamicSectionCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Display::DynamicSection with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.

Returns
Section found
Created in NX6.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
NXOpen::Display::DynamicSection* NXOpen::Display::DynamicSectionCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Display::DynamicSection with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.

Returns
Section found
Created in NX6.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
void NXOpen::Display::DynamicSectionCollection::MoveToDefaultLayer ( const std::vector< NXOpen::Display::DynamicSection * > &  dynamicSections)

Moves the specified dynamic sections in the part to default layer.

The default settings are obtained from the view sectioning customer defaults.
Created in NX9.0.0.

License requirements : None

Parameters
dynamicSectionsThe dynamic sections to be modified
tag_t NXOpen::Display::DynamicSectionCollection::Tag ( ) const

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.