PMI::FeatureControlFrameEntity Class Reference

#include <HUtilityPMI.h>

Public Member Functions

 FeatureControlFrameEntity (HC_KEY segment_key=INVALID_KEY)
 
 FeatureControlFrameEntity (FeatureControlFrameEntity const &that)
 
unsigned int GetDatumReferenceCount () const
 
void GetDatumReferences (unsigned int &out_count, String out_labels[], TextAttributes out_label_attributes[], DatumModifier::Type out_modifiers[], TextAttributes out_modifier_attributes[])
 
void GetDiameterModifierType (DiameterModifier::Type &out_diameter_modifier_type, TextAttributes &out_text_attributes) const
 
void GetFirstZoneModifierType (ZoneModifier::Type &out_zone_modifier_type, TextAttributes &out_text_attributes) const
 
void GetProjectedMagnitude (String &out_projected_magnitude, TextAttributes &out_text_attributes) const
 
void GetSecondZoneModifierType (ZoneModifier::Type &out_zone_modifier_type, TextAttributes &out_text_attributes) const
 
void GetToleranceType (Tolerance::Type &out_tolerance_type, TextAttributes &out_text_attributes) const
 
virtual Type GetType () const
 
void GetZoneToleranceMagnitude (String &out_zone_tolerance_magnitude, TextAttributes &out_text_attributes) const
 
FeatureControlFrameEntity const & operator= (FeatureControlFrameEntity const &that)
 
void Set (FeatureControlFrameEntity const &that)
 
void SetDatumReferences (unsigned int in_count, String const in_labels[], TextAttributes const in_label_attributes[], DatumModifier::Type const in_modifiers[], TextAttributes const in_modifier_attributes[])
 
void SetDiameterModifierType (DiameterModifier::Type const in_diameter_modifier_type, TextAttributes const &in_text_attributes)
 
void SetFirstZoneModifierType (ZoneModifier::Type const in_zone_modifier_type, TextAttributes const &in_text_attributes)
 
void SetProjectedMagnitude (String const &in_projected_magnitude, TextAttributes const &in_text_attributes)
 
void SetSecondZoneModifierType (ZoneModifier::Type const in_zone_modifier_type, TextAttributes const &in_text_attributes)
 
void SetToleranceType (Tolerance::Type const in_tolerance_type, TextAttributes const &in_text_attributes)
 
void SetZoneToleranceMagnitude (String const &in_zone_tolerance_magnitude, TextAttributes const &in_text_attributes)
 
- Public Member Functions inherited from PMI::Entity
 Entity (HC_KEY segment_key=INVALID_KEY)
 
 Entity (Entity const &that)
 
void GetDrawing (Drawing &out_drawing) const
 
void GetFrame (Frame &out_frame) const
 
unsigned int GetLeaderLineCount () const
 
void GetLeaderLines (unsigned int &out_count, Polyline out_leader_lines[]) const
 
unsigned int GetLeaderSymbolCount () const
 
void GetLeaderSymbols (unsigned int &out_count, Polygon out_leader_symbols[]) const
 
HC_KEY GetSegmentKey () const
 
bool IsDisplayParallelToScreen () const
 
Entity const & operator= (Entity const &that)
 
void Set (Entity const &that)
 
void SetDisplayParallelToScreen (bool const in_parallel=true)
 
void SetDrawing (Drawing const &in_drawing)
 
void SetFrame (Frame const &in_frame)
 
void SetLeaderLines (unsigned int in_count, Polyline const in_leader_lines[])
 
void SetLeaderSymbols (unsigned int in_count, Polygon const in_leader_symbols[])
 

Additional Inherited Members

- Protected Attributes inherited from PMI::Entity
PMII::PrivateImpl * impl_
 

Detailed Description

This class represents a feature control frame.

Constructor & Destructor Documentation

◆ FeatureControlFrameEntity()

PMI::FeatureControlFrameEntity::FeatureControlFrameEntity ( HC_KEY  segment_key = INVALID_KEY)

Constructs a FeatureControlFrameEntity object. It requires specifying the segment key where the FeatureControlFrameEntity will insert associated geometry.

Member Function Documentation

◆ GetDatumReferenceCount()

unsigned int PMI::FeatureControlFrameEntity::GetDatumReferenceCount ( ) const
Returns
the number of datum references for this FeatureControlFrameEntity

◆ GetDatumReferences()

void PMI::FeatureControlFrameEntity::GetDatumReferences ( unsigned int &  out_count,
String  out_labels[],
TextAttributes  out_label_attributes[],
DatumModifier::Type  out_modifiers[],
TextAttributes  out_modifier_attributes[] 
)

Gets the datum reference information for this FeatureControlFrameEntity.

Parameters
out_countthe number of datum references for this FeatureControlFrameEntity. Returned to the user.
out_labelsthe array of datum reference labels for this FeatureControlFrameEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
out_label_attributesthe array of TextAttributes for the datum reference labels for this FeatureControlFrameEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
out_modifiersthe array of datum modifiers for this FeatureControlFrameEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
out_modifier_attributesthe array of TextAttributes for the datum modifiers for this FeatureControlFrameEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

◆ GetDiameterModifierType()

void PMI::FeatureControlFrameEntity::GetDiameterModifierType ( DiameterModifier::Type &  out_diameter_modifier_type,
TextAttributes out_text_attributes 
) const

Gets the diameter modifier type information for this FeatureControlFrameEntity.

Parameters
out_diameter_modifier_typethe diameter modifier type. Returned to the user.
out_text_attributesthe TextAttributes indicating where the symbol for this diameter modifier type is placed. Returned to the user.

◆ GetFirstZoneModifierType()

void PMI::FeatureControlFrameEntity::GetFirstZoneModifierType ( ZoneModifier::Type &  out_zone_modifier_type,
TextAttributes out_text_attributes 
) const

Gets the first zone modifier type information for this FeatureControlFrameEntity.

Parameters
out_zone_modifier_typethe zone modifier type. Returned to the user.
out_text_attributesthe TextAttributes indicating where the symbol for this zone modifier type is placed. Returned to the user.

◆ GetProjectedMagnitude()

void PMI::FeatureControlFrameEntity::GetProjectedMagnitude ( String out_projected_magnitude,
TextAttributes out_text_attributes 
) const

Gets the projected magnitude information for this FeatureControlFrameEntity.

Parameters
out_projected_magnitudethe projected magnitude. Returned to the user.
out_text_attributesthe TextAttributes indicating where the text for this projected magnitude is placed. Returned to the user.

◆ GetSecondZoneModifierType()

void PMI::FeatureControlFrameEntity::GetSecondZoneModifierType ( ZoneModifier::Type &  out_zone_modifier_type,
TextAttributes out_text_attributes 
) const

Gets the second zone modifier type information for this FeatureControlFrameEntity.

Parameters
out_zone_modifier_typethe zone modifier type. Returned to the user.
out_text_attributesthe TextAttributes indicating where the symbol for this zone modifier type is placed. Returned to the user.

◆ GetToleranceType()

void PMI::FeatureControlFrameEntity::GetToleranceType ( Tolerance::Type &  out_tolerance_type,
TextAttributes out_text_attributes 
) const

Gets the tolerance type information for this FeatureControlFrameEntity.

Parameters
out_tolerance_typethe tolerance type. Returned to the user.
out_text_attributesthe TextAttributes indicating where the symbol for this tolerance type is placed. Returned to the user.

◆ GetType()

virtual Type PMI::FeatureControlFrameEntity::GetType ( ) const
inlinevirtual
Returns
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented from PMI::Entity.

◆ GetZoneToleranceMagnitude()

void PMI::FeatureControlFrameEntity::GetZoneToleranceMagnitude ( String out_zone_tolerance_magnitude,
TextAttributes out_text_attributes 
) const

Gets the zone tolerance magnitude information for this FeatureControlFrameEntity.

Parameters
out_zone_tolerance_magnitudethe zone tolerance magnitude. Returned to the user.
out_text_attributesthe TextAttributes indicating where the text for this zone tolerance magnitude is placed. Returned to the user.

◆ SetDatumReferences()

void PMI::FeatureControlFrameEntity::SetDatumReferences ( unsigned int  in_count,
String const  in_labels[],
TextAttributes const  in_label_attributes[],
DatumModifier::Type const  in_modifiers[],
TextAttributes const  in_modifier_attributes[] 
)

Sets the datum reference information for this FeatureControlFrameEntity. These will replace any existing datum references.

Parameters
in_countthe number of datum references in the arrays
in_labelsthe array of datum reference labels for this FeatureControlFrameEntity
in_label_attributesthe array of TextAttributes for the datum reference labels for this FeatureControlFrameEntity
in_modifiersthe array of datum modifiers for this FeatureControlFrameEntity
in_modifier_attributesthe array of TextAttributes for the datum modifiers for this FeatureControlFrameEntity

◆ SetDiameterModifierType()

void PMI::FeatureControlFrameEntity::SetDiameterModifierType ( DiameterModifier::Type const  in_diameter_modifier_type,
TextAttributes const &  in_text_attributes 
)

Sets the diameter modifier type information for this FeatureControlFrameEntity. This will replace an existing diameter modifier.

Parameters
in_diameter_modifier_typethe diameter modifier type
in_text_attributesthe TextAttributes indicating where the symbol for this diameter modifier type is placed

◆ SetFirstZoneModifierType()

void PMI::FeatureControlFrameEntity::SetFirstZoneModifierType ( ZoneModifier::Type const  in_zone_modifier_type,
TextAttributes const &  in_text_attributes 
)

Sets the first zone modifier type information for this FeatureControlFrameEntity. This will replace an existing first zone modifier type.

Parameters
in_zone_modifier_typethe zone modifier type
in_text_attributesthe TextAttributes indicating where the symbol for this zone modifier type is placed

◆ SetProjectedMagnitude()

void PMI::FeatureControlFrameEntity::SetProjectedMagnitude ( String const &  in_projected_magnitude,
TextAttributes const &  in_text_attributes 
)

Sets the projected magnitude information for this FeatureControlFrameEntity. This will replace an existing projected magnitude.

Parameters
in_projected_magnitudethe projected magnitude
in_text_attributesthe TextAttributes indicating where the text for this projected magnitude is placed

◆ SetSecondZoneModifierType()

void PMI::FeatureControlFrameEntity::SetSecondZoneModifierType ( ZoneModifier::Type const  in_zone_modifier_type,
TextAttributes const &  in_text_attributes 
)

Sets the second zone modifier type information for this FeatureControlFrameEntity. This will replace an existing second zone modifier type.

Parameters
in_zone_modifier_typethe zone modifier type
in_text_attributesthe TextAttributes indicating where the symbol for this zone modifier type is placed

◆ SetToleranceType()

void PMI::FeatureControlFrameEntity::SetToleranceType ( Tolerance::Type const  in_tolerance_type,
TextAttributes const &  in_text_attributes 
)

Sets the tolerance type information for this FeatureControlFrameEntity. This will replace an existing tolerance type.

Parameters
in_tolerance_typethe tolerance type
in_text_attributesthe TextAttributes indicating where the symbol for this tolerance type is placed

◆ SetZoneToleranceMagnitude()

void PMI::FeatureControlFrameEntity::SetZoneToleranceMagnitude ( String const &  in_zone_tolerance_magnitude,
TextAttributes const &  in_text_attributes 
)

Sets the zone tolerance magnitude information for this FeatureControlFrameEntity. This will replace an existing zone tolerance magnitude.

Parameters
in_diameter_modifier_typethe diameter modifier type
in_text_attributesthe TextAttributes indicating where the text for this zone tolerance magnitude is placed

The documentation for this class was generated from the following file: