Represents a collection of Annotation. More...
Inheritance diagram for NXOpen::Diagramming::AnnotationCollection:
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::Diagramming::AnnotationBuilder * | CreateAnnotationBuilder (NXOpen::Diagramming::Annotation *annotation) |
| Creates a NXOpen::Diagramming::AnnotationBuilder . More... | |
| iterator | end () |
| Returns an iterator addressing one past the last element. More... | |
| NXOpen::Diagramming::Annotation * | FindObject (const NXString &journalIdentifier) |
| Finds the NXOpen::Diagramming::Annotation with the given identifier as recorded in a journal. More... | |
| NXOpen::Diagramming::Annotation * | FindObject (const char *journalIdentifier) |
| Finds the NXOpen::Diagramming::Annotation 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 Annotation.
To obtain an instance of this class, refer to NXOpen::Diagramming::DiagrammingManager
Created in NX10.0.0.
Member Function Documentation
| iterator NXOpen::Diagramming::AnnotationCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| NXOpen::Diagramming::AnnotationBuilder* NXOpen::Diagramming::AnnotationCollection::CreateAnnotationBuilder | ( | NXOpen::Diagramming::Annotation * | annotation | ) |
Creates a NXOpen::Diagramming::AnnotationBuilder .
- Returns
Created in NX10.0.0.
License requirements : None
- Parameters
-
annotation NXOpen::Diagramming::Annotation to be edited, if NULL then create a new one
| iterator NXOpen::Diagramming::AnnotationCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Diagramming::Annotation* NXOpen::Diagramming::AnnotationCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the NXOpen::Diagramming::Annotation with the given identifier as recorded in a journal.
An exception will be thrown if no object can be found with given name.
- Returns
- NXOpen::Diagramming::Annotation with this name.
Created in NX10.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| NXOpen::Diagramming::Annotation* NXOpen::Diagramming::AnnotationCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the NXOpen::Diagramming::Annotation with the given identifier as recorded in a journal.
An exception will be thrown if no object can be found with given name.
- Returns
- NXOpen::Diagramming::Annotation with this name.
Created in NX10.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| tag_t NXOpen::Diagramming::AnnotationCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Diagramming_AnnotationCollection.hxx