RoughnessEntity

class PMI::RoughnessEntity

This class represents a roughness feature.

Inherits from: PMI::Entity

Methods

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

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

PMI::RoughnessEntity::RoughnessEntity(RoughnessEntity const &that)
virtual PMI::RoughnessEntity::~RoughnessEntity()

virtual

void PMI::RoughnessEntity::Set(RoughnessEntity const &that)
RoughnessEntity const &PMI::RoughnessEntity::operator=(RoughnessEntity const &that)
virtual Type PMI::RoughnessEntity::GetType() const

const virtual

Returns

the PMI::Type for this entity. Overridden by subclasses.
Roughness::Obtention::Type PMI::RoughnessEntity::GetObtentionType() const

const

Returns

the obtention type of this RoughnessEntity
void PMI::RoughnessEntity::SetObtentionType(Roughness::Obtention::Type const in_obtention_type)

Sets the obtention type of this RoughnessEntity. This will replace an existing obtention type.

Roughness::Applicability::Type PMI::RoughnessEntity::GetApplicabilityType() const

const

Returns

the applicability type of this RoughnessEntity
void PMI::RoughnessEntity::SetApplicabilityType(Roughness::Applicability::Type const in_applicability_type)

Sets the applicability type of this RoughnessEntity. This will replace an existing applicability type.

Roughness::Mode::Type PMI::RoughnessEntity::GetModeType() const

const

Returns

the mode type of this RoughnessEntity
void PMI::RoughnessEntity::SetModeType(Roughness::Mode::Type const in_mode_type)

Sets the mode type of this RoughnessEntity. This will replace an existing mode type.

unsigned int PMI::RoughnessEntity::GetFieldCount() const

const

Returns

the number of fields for this RoughnessEntity
void PMI::RoughnessEntity::GetFields(unsigned int &out_count, String out_fields[], TextAttributes out_text_attributes[]) const

const

Gets the fields for this RoughnessEntity.

Parameters

out_count: the number of fields for this RoughnessEntity. Returned to the user.

out_fields: the array of fields for this RoughnessEntity. 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_text_attributes: the array of TextAttributes for the fields for this RoughnessEntity. 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 PMI::RoughnessEntity::SetFields(unsigned int in_count, String const in_fields[], TextAttributes const in_text_attributes[])

Sets the fields for this RoughnessEntity. These will replace any existing fields.

Parameters

in_count: the number of fields in the array

in_fields: the array of fields for this RoughnessEntity

in_text_attributes: the array of TextAttributes for the fields for this RoughnessEntity