NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::Annotations::CustomSymbolCollection Class Reference

Represents a collection of Annotations::CustomSymbol objects
To obtain an instance of this class, refer to Annotations::AnnotationManager

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::CustomSymbolCollection:
NXOpen::TaggedObjectCollection

List of all members.

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::Annotations::CustomSymbolCreateCustomSymbol (NXOpen::Annotations::CustomSymbolData *customSymbolData, const NXOpen::Point3d &origin, NXOpen::Annotations::LeaderBundle *leader)
 Creates a custom symbol.
NXOpen::Annotations::DraftingCustomSymbolBuilderCreateDraftingCustomSymbolBuilder (NXOpen::Annotations::CustomSymbol *symbolTag)
 Creates the Drafting Symbol placement builder.
NXOpen::Annotations::MasterSymbolBuilderCreateMasterSymbolBuilder (NXOpen::Annotations::MasterSymbol *masterSymbolTag)
 Creates the Master Symbol builder.
NXOpen::Annotations::MasterSymbolListItemBuilderCreateMasterSymbolListItemBuilder ()
 Creates the Master Symbol List Item builder.
NXOpen::Annotations::PmiCustomSymbolCreatePmiCustomSymbol (NXOpen::Annotations::CustomSymbolData *customSymbolData, NXOpen::Annotations::PmiData *pmiData, NXOpen::Xform *annotationPlane, const NXOpen::Point3d &origin, NXOpen::Annotations::LeaderBundle *leader)
 Creates a PMI custom symbol.
NXOpen::Annotations::PmiCustomSymbolBuilderCreatePmiCustomSymbolBuilder (NXOpen::Annotations::PmiCustomSymbol *symbolTag)
 Creates the PMI Symbol Placement builder.
NXOpen::Annotations::ReplaceSymbolBuilderCreateReplaceSymbolBuilder ()
 Creates a Annotations::ReplaceSymbolBuilder.
NXOpen::Annotations::SmashCustomSymbolBuilderCreateSmashCustomSymbolBuilder ()
 Smashes a custom symbol.
NXOpen::Annotations::SymbolCatalogBuilderCreateSymbolCatalogBuilder ()
 Creates a symbol catalog dialog builder.
NXOpen::Annotations::EditSymbolDisplayBuilderEditSymbolDisplayBuilder (NXOpen::Annotations::BaseCustomSymbol *symbolTag)
 Creates a edit custom symbol dialog builder.
iterator end ()
 Returns an iterator addressing one past the last element.
NXOpen::Annotations::MasterSymbolFindObject (const NXString &name)
 Finds the Annotations::MasterSymbol with the given name.
NXOpen::Annotations::CustomSymbolDataNewCustomSymbolData (const NXString &masterFileName)
 Creates new CustomSymbolData object.
NXOpen::Annotations::CustomSymbolDataNewPartSymbolData (const NXString &partSymbolName)
 Creates new CustomSymbolData object to create a part symbol instance.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents a collection of Annotations::CustomSymbol objects
To obtain an instance of this class, refer to Annotations::AnnotationManager

Created in NX4.0.0.



Member Function Documentation

Returns an iterator addressing the first element.

Creates a custom symbol.

Returns:
New custom symbol
Created in NX4.0.0.

License requirements : drafting ("DRAFTING")
Parameters:
customSymbolDatacustom symbol data
originOrigin for the custom symbol
leaderSpecifies the leaders for the custom symbol

Creates the Drafting Symbol placement builder.

Returns:
DraftingCustomSymbolBuilder object
Created in NX7.5.0.

License requirements : None
Parameters:
symbolTagSymbol as input

Creates the Master Symbol builder.

Returns:
MasterSymbolBuilder object
Created in NX7.5.0.

License requirements : None
Parameters:
masterSymbolTagAnnotations::MasterSymbol to be set as master symbol

Creates the Master Symbol List Item builder.

Returns:
CustomSymbolListItemBuilder object
Created in NX7.5.0.

License requirements : None

Creates a PMI custom symbol.

Returns:
New PMI custom symbol
Created in NX4.0.0.

License requirements : geometric_tol ("GDT")
Parameters:
customSymbolDatacustom symbol data
pmiDataPMI data
annotationPlaneAnnotation plane on which the custom symbol lies
originOrigin for the custom symbol
leaderSpecifies the leaders for the custom symbol

Creates the PMI Symbol Placement builder.

Returns:
PMICustomSymbolBuilder object
Created in NX7.5.0.

License requirements : None
Parameters:
symbolTagSymbol as input

Creates a Annotations::ReplaceSymbolBuilder.

Returns:

Created in NX8.0.1.

License requirements : drafting ("DRAFTING")

Smashes a custom symbol.

Returns:

Created in NX6.0.0.

License requirements : None

Creates a symbol catalog dialog builder.

Returns:

Created in NX8.0.0.

License requirements : nx_drafting_plus ("Drafting Plus")

Creates a edit custom symbol dialog builder.

Returns:

Created in NX7.5.0.

License requirements : None
Parameters:
symbolTagSymbol as input

Returns an iterator addressing one past the last element.

Finds the Annotations::MasterSymbol with the given name.

An exception will be thrown if no object can be found with the given name.

Returns:
Master custom symbol object
Created in NX7.5.0.

License requirements : None
Parameters:
nameMaster custom symbol name

Creates new CustomSymbolData object.

Returns:
New CustomSymbolData
Created in NX4.0.0.

License requirements : None
Parameters:
masterFileNameAbsolute path of the master symbol(with .sym.prt extension)
NOTE: The full Unicode character set is not supported for this parameter.

Creates new CustomSymbolData object to create a part symbol instance.

Returns:
New CustomSymbolData
Created in NX4.0.0.

License requirements : None
Parameters:
partSymbolNamePart symbol name. Part symbol is a master symbol that is created and instantiated in the same part.
NOTE: The full Unicode character set is not supported for this parameter.

Returns the tag of this object.


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