FeatureControlFrameEntity
Functions
void |
|
FeatureControlFrameEntity const & |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
unsigned int |
|
void |
|
void |
Detailed Description
-
class FeatureControlFrameEntity : public PMI::Entity
This class represents a feature control frame.
Public Functions
-
FeatureControlFrameEntity(HC_KEY segment_key = (-1L))
Constructs a FeatureControlFrameEntity object. It requires specifying the segment key where the FeatureControlFrameEntity will insert associated geometry.
-
FeatureControlFrameEntity(FeatureControlFrameEntity const &that)
-
virtual ~FeatureControlFrameEntity()
-
void Set(FeatureControlFrameEntity const &that)
-
FeatureControlFrameEntity const &operator=(FeatureControlFrameEntity const &that)
-
inline virtual Type GetType() const
- Returns
the PMI::Type for this entity. Overridden by subclasses.
-
void GetToleranceType(Tolerance::Type &out_tolerance_type, TextAttributes &out_text_attributes) const
Gets the tolerance type information for this FeatureControlFrameEntity.
- Parameters
out_tolerance_type – the tolerance type. Returned to the user.
out_text_attributes – the TextAttributes indicating where the symbol for this tolerance type is placed. Returned to the user.
-
void 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_type – the tolerance type
in_text_attributes – the TextAttributes indicating where the symbol for this tolerance type is placed
-
void 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_type – the diameter modifier type. Returned to the user.
out_text_attributes – the TextAttributes indicating where the symbol for this diameter modifier type is placed. Returned to the user.
-
void 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_type – the diameter modifier type
in_text_attributes – the TextAttributes indicating where the symbol for this diameter modifier type is placed
-
void GetZoneToleranceMagnitude(String &out_zone_tolerance_magnitude, TextAttributes &out_text_attributes) const
Gets the zone tolerance magnitude information for this FeatureControlFrameEntity.
- Parameters
out_zone_tolerance_magnitude – the zone tolerance magnitude. Returned to the user.
out_text_attributes – the TextAttributes indicating where the text for this zone tolerance magnitude is placed. Returned to the user.
-
void 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_type – the diameter modifier type
in_text_attributes – the TextAttributes indicating where the text for this zone tolerance magnitude is placed
-
void 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_type – the zone modifier type. Returned to the user.
out_text_attributes – the TextAttributes indicating where the symbol for this zone modifier type is placed. Returned to the user.
-
void 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_type – the zone modifier type
in_text_attributes – the TextAttributes indicating where the symbol for this zone modifier type is placed
-
void 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_type – the zone modifier type. Returned to the user.
out_text_attributes – the TextAttributes indicating where the symbol for this zone modifier type is placed. Returned to the user.
-
void 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_type – the zone modifier type
in_text_attributes – the TextAttributes indicating where the symbol for this zone modifier type is placed
-
void GetProjectedMagnitude(String &out_projected_magnitude, TextAttributes &out_text_attributes) const
Gets the projected magnitude information for this FeatureControlFrameEntity.
- Parameters
out_projected_magnitude – the projected magnitude. Returned to the user.
out_text_attributes – the TextAttributes indicating where the text for this projected magnitude is placed. Returned to the user.
-
void 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_magnitude – the projected magnitude
in_text_attributes – the TextAttributes indicating where the text for this projected magnitude is placed
-
unsigned int GetDatumReferenceCount() const
- Returns
the number of datum references for this FeatureControlFrameEntity
-
void 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_count – the number of datum references for this FeatureControlFrameEntity. Returned to the user.
out_labels – the 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_attributes – the 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_modifiers – the 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_attributes – the 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.
-
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[])
Sets the datum reference information for this FeatureControlFrameEntity. These will replace any existing datum references.
- Parameters
in_count – the number of datum references in the arrays
in_labels – the array of datum reference labels for this FeatureControlFrameEntity
in_label_attributes – the array of TextAttributes for the datum reference labels for this FeatureControlFrameEntity
in_modifiers – the array of datum modifiers for this FeatureControlFrameEntity
in_modifier_attributes – the array of TextAttributes for the datum modifiers for this FeatureControlFrameEntity
-
FeatureControlFrameEntity(HC_KEY segment_key = (-1L))