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

Represents a collection of 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.
 
NXOpen::Annotations::BalloonNoteBuilder * CreateBalloonNoteBuilder (NXOpen::Annotations::BalloonNote *balloonNote)
 Creates a Annotations::BalloonNoteBuilder.
 
NXOpen::Annotations::CompanyProprietaryInformationBuilder * CreateCompanyProprietaryInformationBuilder (NXOpen::Annotations::CompanyProprietaryInformation *companyProprietaryInformation)
 Creates a Annotations::CompanyProprietaryInformationBuilder.
 
NXOpen::Annotations::CoordinateNoteBuilder * CreateCoordinateNoteBuilder (NXOpen::Annotations::CoordinateNote *coordinateNote)
 Creates a Annotations::CoordinateNoteBuilder.
 
NXOpen::Annotations::EnterpriseIdentificationBuilder * CreateEnterpriseIdentificationBuilder (NXOpen::Annotations::EnterpriseIdentification *enterpriseIdentification)
 Creates a Annotations::EnterpriseIdentificationBuilder.
 
NXOpen::Annotations::ExportControlBuilder * CreateExportControlBuilder (NXOpen::Annotations::ExportControl *exportControl)
 Creates a Annotations::ExportControlBuilder.
 
NXOpen::Annotations::GeneralNoteBuilder * CreateGeneralNoteBuilder (NXOpen::Annotations::GeneralNote *generalNote)
 Creates a Annotations::GeneralNoteBuilder.
 
NXOpen::Annotations::GovernmentSecurityInformationBuilder * CreateGovernmentSecurityInformationBuilder (NXOpen::Annotations::GovernmentSecurityInformation *governmentSecurityInformation)
 Creates a Annotations::GovernmentSecurityInformationBuilder.
 
NXOpen::Annotations::LocatorDesignatorBuilder * CreateLocatorDesignatorBuilder (NXOpen::Annotations::LocatorDesignator *locatorDesignator)
 Creates a Annotations::LocatorDesignatorBuilder.
 
NXOpen::Annotations::MaterialSpecificationBuilder * CreateMaterialSpecificationBuilder (NXOpen::Annotations::MaterialSpecification *materialSpecification)
 Creates a Annotations::MaterialSpecificationBuilder.
 
NXOpen::Annotations::PartIdentificationBuilder * CreatePartIdentificationBuilder (NXOpen::Annotations::PartIdentification *partIdentification)
 Creates a Annotations::PartIdentificationBuilder.
 
NXOpen::Annotations::PmiAttributeBuilder * CreatePmiAttributeBuilder (NXOpen::Annotations::PmiAttribute *pmiAttr)
 Creates a Annotations::PmiAttributeBuilder.
 
NXOpen::Annotations::PmiAttributeValueIntegerBuilder * CreatePmiAttributeValueIntegerBuilder (NXOpen::Annotations::PmiAttributeValueInteger *pmiAttributeValueInteger)
 Creates a Annotations::PmiAttributeValueIntegerBuilder.
 
NXOpen::Annotations::PmiAttributeValueListBuilder * CreatePmiAttributeValueListBuilder (NXOpen::Annotations::PmiAttributeValueList *pmiAttributeValueList)
 Creates a Annotations::PmiAttributeValueListBuilder.
 
NXOpen::Annotations::PmiAttributeValueMultipleStringBuilder * CreatePmiAttributeValueMultipleStringBuilder (NXOpen::Annotations::PmiAttributeValueMultipleString *pmiAttributeValueMultipleString)
 Creates a Annotations::PmiAttributeValueMultipleStringBuilder.
 
NXOpen::Annotations::PmiAttributeValueNumberBuilder * CreatePmiAttributeValueNumberBuilder (NXOpen::Annotations::PmiAttributeValueNumber *pmiAttributeValueNumber)
 Creates a Annotations::PmiAttributeValueNumberBuilder.
 
NXOpen::Annotations::PmiAttributeValueStringBuilder * CreatePmiAttributeValueStringBuilder (NXOpen::Annotations::PmiAttributeValueString *pmiAttributeValueString)
 Creates a Annotations::PmiAttributeValueStringBuilder.
 
NXOpen::Annotations::PmiAttributeValueUrlBuilder * CreatePmiAttributeValueUrlBuilder (NXOpen::Annotations::PmiAttributeValueUrl *pmiAttributeValueUrl)
 Creates a Annotations::PmiAttributeValueUrlBuilder.
 
NXOpen::Annotations::PmiIntegerBuilder * CreatePmiIntegerBuilder (NXOpen::Annotations::PmiInteger *pmiInteger)
 Creates a Annotations::PmiIntegerBuilder.
 
NXOpen::Annotations::PmiNumberBuilder * CreatePmiNumberBuilder (NXOpen::Annotations::PmiNumber *pmiNumber)
 Creates a Annotations::PmiNumberBuilder.
 
NXOpen::Annotations::PmiStringBuilder * CreatePmiStringBuilder (NXOpen::Annotations::PmiString *pmiString)
 Creates a Annotations::PmiStringBuilder.
 
NXOpen::Annotations::PmiUrlNoteBuilder * CreatePmiUrlNoteBuilder (NXOpen::Annotations::PmiUrlNote *pmiUrlNote)
 Creates a Annotations::PmiUrlNoteBuilder.
 
NXOpen::Annotations::PmiUserDefinedBuilder * CreatePmiUserDefinedBuilder (NXOpen::Annotations::PmiUserDefined *userDefined)
 Creates a Annotations::PmiUserDefinedBuilder.
 
NXOpen::Annotations::ProcessSpecificationBuilder * CreateProcessSpecificationBuilder (NXOpen::Annotations::ProcessSpecification *processSpecification)
 Creates a Annotations::ProcessSpecificationBuilder.
 
NXOpen::Annotations::SpecificNoteBuilder * CreateSpecificNoteBuilder (NXOpen::Annotations::SpecificNote *specificNote)
 Creates a Annotations::SpecificNoteBuilder.
 
NXOpen::Annotations::SurfaceFinishBuilder * CreateSurfaceFinishBuilder (NXOpen::Annotations::SurfaceFinish *surfaceFinish)
 Creates a Annotations::SurfaceFinishBuilder.
 
iterator end ()
 Returns an iterator addressing one past the last element.
 
NXOpen::TaggedObject * FindObject (const NXString &journalIdentifier)
 Finds the Annotations::PmiAttribute with the given identifier as recorded in a journal.
 
NXOpen::TaggedObject * FindObject (const char *journalIdentifier)
 Finds the Annotations::PmiAttribute with the given identifier as recorded in a journal.
 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a collection of Annotations::PmiAttribute objects.


To obtain an instance of this class, refer to 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.  @return  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 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.  @return  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 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.