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

Represents a collection of NXOpen::Annotations::PmiAttribute objects. More...

Inheritance diagram for NXOpen::Annotations::PmiAttributeCollection:
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::Annotations::BalloonNoteBuilderCreateBalloonNoteBuilder (NXOpen::Annotations::BalloonNote *balloonNote)
 Creates a NXOpen::Annotations::BalloonNoteBuilder. More...
 
NXOpen::Annotations::CompanyProprietaryInformationBuilderCreateCompanyProprietaryInformationBuilder (NXOpen::Annotations::CompanyProprietaryInformation *companyProprietaryInformation)
 Creates a NXOpen::Annotations::CompanyProprietaryInformationBuilder. More...
 
NXOpen::Annotations::CoordinateNoteBuilderCreateCoordinateNoteBuilder (NXOpen::Annotations::CoordinateNote *coordinateNote)
 Creates a NXOpen::Annotations::CoordinateNoteBuilder. More...
 
NXOpen::Annotations::EnterpriseIdentificationBuilderCreateEnterpriseIdentificationBuilder (NXOpen::Annotations::EnterpriseIdentification *enterpriseIdentification)
 Creates a NXOpen::Annotations::EnterpriseIdentificationBuilder. More...
 
NXOpen::Annotations::ExportControlBuilderCreateExportControlBuilder (NXOpen::Annotations::ExportControl *exportControl)
 Creates a NXOpen::Annotations::ExportControlBuilder. More...
 
NXOpen::Annotations::GeneralNoteBuilderCreateGeneralNoteBuilder (NXOpen::Annotations::GeneralNote *generalNote)
 Creates a NXOpen::Annotations::GeneralNoteBuilder. More...
 
NXOpen::Annotations::GovernmentSecurityInformationBuilderCreateGovernmentSecurityInformationBuilder (NXOpen::Annotations::GovernmentSecurityInformation *governmentSecurityInformation)
 Creates a NXOpen::Annotations::GovernmentSecurityInformationBuilder. More...
 
NXOpen::Annotations::LocatorDesignatorBuilderCreateLocatorDesignatorBuilder (NXOpen::Annotations::LocatorDesignator *locatorDesignator)
 Creates a NXOpen::Annotations::LocatorDesignatorBuilder. More...
 
NXOpen::Annotations::MaterialSpecificationBuilderCreateMaterialSpecificationBuilder (NXOpen::Annotations::MaterialSpecification *materialSpecification)
 Creates a NXOpen::Annotations::MaterialSpecificationBuilder. More...
 
NXOpen::Annotations::PartIdentificationBuilderCreatePartIdentificationBuilder (NXOpen::Annotations::PartIdentification *partIdentification)
 Creates a NXOpen::Annotations::PartIdentificationBuilder. More...
 
NXOpen::Annotations::PmiAttributeBuilderCreatePmiAttributeBuilder (NXOpen::Annotations::PmiAttribute *pmiAttr)
 Creates a NXOpen::Annotations::PmiAttributeBuilder. More...
 
NXOpen::Annotations::PmiAttributeValueIntegerBuilderCreatePmiAttributeValueIntegerBuilder (NXOpen::Annotations::PmiAttributeValueInteger *pmiAttributeValueInteger)
 Creates a NXOpen::Annotations::PmiAttributeValueIntegerBuilder. More...
 
NXOpen::Annotations::PmiAttributeValueListBuilderCreatePmiAttributeValueListBuilder (NXOpen::Annotations::PmiAttributeValueList *pmiAttributeValueList)
 Creates a NXOpen::Annotations::PmiAttributeValueListBuilder. More...
 
NXOpen::Annotations::PmiAttributeValueMultipleStringBuilderCreatePmiAttributeValueMultipleStringBuilder (NXOpen::Annotations::PmiAttributeValueMultipleString *pmiAttributeValueMultipleString)
 Creates a NXOpen::Annotations::PmiAttributeValueMultipleStringBuilder. More...
 
NXOpen::Annotations::PmiAttributeValueNumberBuilderCreatePmiAttributeValueNumberBuilder (NXOpen::Annotations::PmiAttributeValueNumber *pmiAttributeValueNumber)
 Creates a NXOpen::Annotations::PmiAttributeValueNumberBuilder. More...
 
NXOpen::Annotations::PmiAttributeValueStringBuilderCreatePmiAttributeValueStringBuilder (NXOpen::Annotations::PmiAttributeValueString *pmiAttributeValueString)
 Creates a NXOpen::Annotations::PmiAttributeValueStringBuilder. More...
 
NXOpen::Annotations::PmiAttributeValueUrlBuilderCreatePmiAttributeValueUrlBuilder (NXOpen::Annotations::PmiAttributeValueUrl *pmiAttributeValueUrl)
 Creates a NXOpen::Annotations::PmiAttributeValueUrlBuilder. More...
 
NXOpen::Annotations::PmiIntegerBuilderCreatePmiIntegerBuilder (NXOpen::Annotations::PmiInteger *pmiInteger)
 Creates a NXOpen::Annotations::PmiIntegerBuilder. More...
 
NXOpen::Annotations::PmiNumberBuilderCreatePmiNumberBuilder (NXOpen::Annotations::PmiNumber *pmiNumber)
 Creates a NXOpen::Annotations::PmiNumberBuilder. More...
 
NXOpen::Annotations::PmiStringBuilderCreatePmiStringBuilder (NXOpen::Annotations::PmiString *pmiString)
 Creates a NXOpen::Annotations::PmiStringBuilder. More...
 
NXOpen::Annotations::PmiUrlNoteBuilderCreatePmiUrlNoteBuilder (NXOpen::Annotations::PmiUrlNote *pmiUrlNote)
 Creates a NXOpen::Annotations::PmiUrlNoteBuilder. More...
 
NXOpen::Annotations::PmiUserDefinedBuilderCreatePmiUserDefinedBuilder (NXOpen::Annotations::PmiUserDefined *userDefined)
 Creates a NXOpen::Annotations::PmiUserDefinedBuilder. More...
 
NXOpen::Annotations::ProcessSpecificationBuilderCreateProcessSpecificationBuilder (NXOpen::Annotations::ProcessSpecification *processSpecification)
 Creates a NXOpen::Annotations::ProcessSpecificationBuilder. More...
 
NXOpen::Annotations::SpecificNoteBuilderCreateSpecificNoteBuilder (NXOpen::Annotations::SpecificNote *specificNote)
 Creates a NXOpen::Annotations::SpecificNoteBuilder. More...
 
NXOpen::Annotations::SurfaceFinishBuilderCreateSurfaceFinishBuilder (NXOpen::Annotations::SurfaceFinish *surfaceFinish)
 Creates a NXOpen::Annotations::SurfaceFinishBuilder. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::TaggedObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Annotations::PmiAttribute with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::Annotations::PmiAttribute with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Annotations::PmiAttribute objects.


To obtain an instance of this class, refer to NXOpen::Annotations::PmiManager

Created in NX6.0.0.

Member Function Documentation

iterator NXOpen::Annotations::PmiAttributeCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Annotations::BalloonNoteBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateBalloonNoteBuilder ( NXOpen::Annotations::BalloonNote balloonNote)

Creates a NXOpen::Annotations::BalloonNoteBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
balloonNoteballoon note
NXOpen::Annotations::CompanyProprietaryInformationBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateCompanyProprietaryInformationBuilder ( NXOpen::Annotations::CompanyProprietaryInformation companyProprietaryInformation)

Creates a NXOpen::Annotations::CompanyProprietaryInformationBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
companyProprietaryInformationcompany proprietary
NXOpen::Annotations::CoordinateNoteBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateCoordinateNoteBuilder ( NXOpen::Annotations::CoordinateNote coordinateNote)

Creates a NXOpen::Annotations::CoordinateNoteBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
coordinateNotecoordinate note
NXOpen::Annotations::EnterpriseIdentificationBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateEnterpriseIdentificationBuilder ( NXOpen::Annotations::EnterpriseIdentification enterpriseIdentification)

Creates a NXOpen::Annotations::EnterpriseIdentificationBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
enterpriseIdentificationenterprise identification
NXOpen::Annotations::ExportControlBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateExportControlBuilder ( NXOpen::Annotations::ExportControl exportControl)

Creates a NXOpen::Annotations::ExportControlBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
exportControlexport control
NXOpen::Annotations::GeneralNoteBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateGeneralNoteBuilder ( NXOpen::Annotations::GeneralNote generalNote)

Creates a NXOpen::Annotations::GeneralNoteBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
generalNotegeneral note
NXOpen::Annotations::GovernmentSecurityInformationBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateGovernmentSecurityInformationBuilder ( NXOpen::Annotations::GovernmentSecurityInformation governmentSecurityInformation)

Creates a NXOpen::Annotations::GovernmentSecurityInformationBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
governmentSecurityInformationeMarking government
NXOpen::Annotations::LocatorDesignatorBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateLocatorDesignatorBuilder ( NXOpen::Annotations::LocatorDesignator locatorDesignator)

Creates a NXOpen::Annotations::LocatorDesignatorBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
locatorDesignatorlocator designator
NXOpen::Annotations::MaterialSpecificationBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateMaterialSpecificationBuilder ( NXOpen::Annotations::MaterialSpecification materialSpecification)

Creates a NXOpen::Annotations::MaterialSpecificationBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
materialSpecificationmaterial specification
NXOpen::Annotations::PartIdentificationBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePartIdentificationBuilder ( NXOpen::Annotations::PartIdentification partIdentification)

Creates a NXOpen::Annotations::PartIdentificationBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
partIdentificationpart identification
NXOpen::Annotations::PmiAttributeBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiAttributeBuilder ( NXOpen::Annotations::PmiAttribute pmiAttr)

Creates a NXOpen::Annotations::PmiAttributeBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiAttrpmi base class
NXOpen::Annotations::PmiAttributeValueIntegerBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiAttributeValueIntegerBuilder ( NXOpen::Annotations::PmiAttributeValueInteger pmiAttributeValueInteger)

Creates a NXOpen::Annotations::PmiAttributeValueIntegerBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiAttributeValueIntegerinteger value
NXOpen::Annotations::PmiAttributeValueListBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiAttributeValueListBuilder ( NXOpen::Annotations::PmiAttributeValueList pmiAttributeValueList)

Creates a NXOpen::Annotations::PmiAttributeValueListBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiAttributeValueListlist value
NXOpen::Annotations::PmiAttributeValueMultipleStringBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiAttributeValueMultipleStringBuilder ( NXOpen::Annotations::PmiAttributeValueMultipleString pmiAttributeValueMultipleString)

Creates a NXOpen::Annotations::PmiAttributeValueMultipleStringBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiAttributeValueMultipleStringmultiple string value
NXOpen::Annotations::PmiAttributeValueNumberBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiAttributeValueNumberBuilder ( NXOpen::Annotations::PmiAttributeValueNumber pmiAttributeValueNumber)

Creates a NXOpen::Annotations::PmiAttributeValueNumberBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiAttributeValueNumbernumber value
NXOpen::Annotations::PmiAttributeValueStringBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiAttributeValueStringBuilder ( NXOpen::Annotations::PmiAttributeValueString pmiAttributeValueString)

Creates a NXOpen::Annotations::PmiAttributeValueStringBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiAttributeValueStringstring value
NXOpen::Annotations::PmiAttributeValueUrlBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiAttributeValueUrlBuilder ( NXOpen::Annotations::PmiAttributeValueUrl pmiAttributeValueUrl)

Creates a NXOpen::Annotations::PmiAttributeValueUrlBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiAttributeValueUrllist value
NXOpen::Annotations::PmiIntegerBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiIntegerBuilder ( NXOpen::Annotations::PmiInteger pmiInteger)

Creates a NXOpen::Annotations::PmiIntegerBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiIntegerinteger
NXOpen::Annotations::PmiNumberBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiNumberBuilder ( NXOpen::Annotations::PmiNumber pmiNumber)

Creates a NXOpen::Annotations::PmiNumberBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiNumbernumber
NXOpen::Annotations::PmiStringBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiStringBuilder ( NXOpen::Annotations::PmiString pmiString)

Creates a NXOpen::Annotations::PmiStringBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiStringstring
NXOpen::Annotations::PmiUrlNoteBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiUrlNoteBuilder ( NXOpen::Annotations::PmiUrlNote pmiUrlNote)

Creates a NXOpen::Annotations::PmiUrlNoteBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
pmiUrlNoteurl note
NXOpen::Annotations::PmiUserDefinedBuilder* NXOpen::Annotations::PmiAttributeCollection::CreatePmiUserDefinedBuilder ( NXOpen::Annotations::PmiUserDefined userDefined)

Creates a NXOpen::Annotations::PmiUserDefinedBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
userDefineduser defined
NXOpen::Annotations::ProcessSpecificationBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateProcessSpecificationBuilder ( NXOpen::Annotations::ProcessSpecification processSpecification)

Creates a NXOpen::Annotations::ProcessSpecificationBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
processSpecificationprocess specification
NXOpen::Annotations::SpecificNoteBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateSpecificNoteBuilder ( NXOpen::Annotations::SpecificNote specificNote)

Creates a NXOpen::Annotations::SpecificNoteBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
specificNotespecific note
NXOpen::Annotations::SurfaceFinishBuilder* NXOpen::Annotations::PmiAttributeCollection::CreateSurfaceFinishBuilder ( NXOpen::Annotations::SurfaceFinish surfaceFinish)

Creates a NXOpen::Annotations::SurfaceFinishBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
surfaceFinishsurface finish
iterator NXOpen::Annotations::PmiAttributeCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::TaggedObject* NXOpen::Annotations::PmiAttributeCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Annotations::PmiAttribute 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
PMI with this identifier
Created in NX6.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the pmi
NXOpen::TaggedObject* NXOpen::Annotations::PmiAttributeCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Annotations::PmiAttribute 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
PMI with this identifier
Created in NX6.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the pmi
tag_t NXOpen::Annotations::PmiAttributeCollection::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.