NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::LeaderData Class Reference

Represents a Annotations::LeaderData . More...

Inheritance diagram for NXOpen::Annotations::LeaderData:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ArrowheadType {
  ArrowheadTypeClosedArrow, ArrowheadTypeClosedSolidArrow, ArrowheadTypeOpenArrow, ArrowheadTypeFilledArrow,
  ArrowheadTypeClosedDoubleArrow, ArrowheadTypeClosedDoubleSolidArrow, ArrowheadTypeOpenDoubleArrow, ArrowheadTypeFilledDoubleArrow,
  ArrowheadTypeNone, ArrowheadTypeOrigin, ArrowheadTypeCross, ArrowheadTypeIntegral,
  ArrowheadTypeDot, ArrowheadTypeFilledDot, ArrowheadTypeSquare, ArrowheadTypeFilledSquare,
  ArrowheadTypeDatum, ArrowheadTypeFilledDatum, ArrowheadTypeTopOpenArrow, ArrowheadTypeBottomOpenArrow,
  ArrowheadTypeTopFilledArrow, ArrowheadTypeBottomFilledArrow
}
 the set of arrowhead types used to define a leader arrowhead More...
enum  LeaderType {
  LeaderTypePlain, LeaderTypeAllAround, LeaderTypePlainWithoutStub, LeaderTypeFlag,
  LeaderTypeDatum, LeaderTypeDotTerminated, LeaderTypeExtension, LeaderTypeAllOver
}
 the set of datatypes used to define the types of leaders that can be applied to an annotation More...

Public Member Functions

NXOpen::Annotations::LeaderData::ArrowheadType Arrowhead ()
 Returns the arrowhead
Created in NX6.0.0.
NXOpen::SelectDisplayableObjectListJogs ()
 Returns the jogs
Created in NX6.0.0.
NXOpen::SelectDisplayableObjectLeader ()
 Returns the leader
Created in NX6.0.0.
bool Perpendicular ()
 Returns the perpendicular relationship between the first segment and stub
Created in NX7.0.0.
void SetArrowhead (NXOpen::Annotations::LeaderData::ArrowheadType arrowhead)
 Sets the arrowhead
Created in NX6.0.0.
void SetPerpendicular (bool isPerpendicular)
 Sets the perpendicular relationship between the first segment and stub
Created in NX7.0.0.
void SetStubSide (NXOpen::Annotations::LeaderSide stubSide)
 Sets the stub side
Created in NX6.0.0.
void SetStubSize (double stubSize)
 Sets the stub size
Created in NX6.0.0.
void SetTerminatorType (NXOpen::Annotations::LeaderData::LeaderType terminatorType)
 Sets the terminator type
Created in NX6.0.0.
NXOpen::Annotations::LeaderSide StubSide ()
 Returns the stub side
Created in NX6.0.0.
double StubSize ()
 Returns the stub size
Created in NX6.0.0.
NXOpen::Annotations::LeaderData::LeaderType TerminatorType ()
 Returns the terminator type
Created in NX6.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a Annotations::LeaderData .

This class is used to construct the definition for a single leader object.
To create a new instance of this class, use Annotations::AnnotationManager::CreateLeaderData

Created in NX6.0.0.


Member Enumeration Documentation

the set of arrowhead types used to define a leader arrowhead

Enumerator:
ArrowheadTypeClosedArrow 

Closed arrowhead type.

ArrowheadTypeClosedSolidArrow 

Closed solid arrowhead type.

ArrowheadTypeOpenArrow 

Open arrowhead type.

ArrowheadTypeFilledArrow 

Filled arrowhead type.

ArrowheadTypeClosedDoubleArrow 

Closed double arrowhead type.

ArrowheadTypeClosedDoubleSolidArrow 

Closed double solid arrowhead type.

ArrowheadTypeOpenDoubleArrow 

Open double arrowhead type.

ArrowheadTypeFilledDoubleArrow 

Filled double arrowhead type.

ArrowheadTypeNone 

No terminating symbol.

ArrowheadTypeOrigin 

Origin symbol.

ArrowheadTypeCross 

Cross symbol.

ArrowheadTypeIntegral 

Integral symbol.

ArrowheadTypeDot 

Dot symbol.

ArrowheadTypeFilledDot 

Filled dot symbol.

ArrowheadTypeSquare 

Square symbol.

ArrowheadTypeFilledSquare 

Filled square symbol.

ArrowheadTypeDatum 

Datum symbol.

ArrowheadTypeFilledDatum 

Filled datum symbol.

ArrowheadTypeTopOpenArrow 

Top open arrowhead.

ArrowheadTypeBottomOpenArrow 

bottom open arrowhead

ArrowheadTypeTopFilledArrow 

top filled arrowhead

ArrowheadTypeBottomFilledArrow 

bottom filled arrowhead

the set of datatypes used to define the types of leaders that can be applied to an annotation

Enumerator:
LeaderTypePlain 

Plain leader style.

LeaderTypeAllAround 

Plain leader style with all around symbol.

LeaderTypePlainWithoutStub 

Plain leader style with no stub.

LeaderTypeFlag 

Flag style.

LeaderTypeDatum 

Datum feature symbol style.

LeaderTypeDotTerminated 

Datum feature on stub of dot terminated style.

LeaderTypeExtension 

Id symbol extension style leader.

LeaderTypeAllOver 

all over


Member Function Documentation

Returns the arrowhead
Created in NX6.0.0.



License requirements : None

Returns the jogs
Created in NX6.0.0.



License requirements : None

Returns the leader
Created in NX6.0.0.



License requirements : None

Returns the perpendicular relationship between the first segment and stub
Created in NX7.0.0.



License requirements : None

Sets the arrowhead
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
arrowheadarrowhead
void NXOpen::Annotations::LeaderData::SetPerpendicular ( bool  isPerpendicular)

Sets the perpendicular relationship between the first segment and stub
Created in NX7.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
isPerpendicularisperpendicular

Sets the stub side
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
stubSidestub side

Sets the stub size
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
stubSizestubsize

Sets the terminator type
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
terminatorTypeterminatortype

Returns the stub side
Created in NX6.0.0.



License requirements : None

Returns the stub size
Created in NX6.0.0.



License requirements : None

Returns the terminator type
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::Annotations::LeaderData::Validate ( ) [virtual]

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns:
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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