DatumEntity
-
class
PMI::DatumEntity This class represents datum identifiers and datum targets.
Inherits from:
PMI::Entity
Methods
-
PMI::DatumEntity::DatumEntity(HC_KEY segment_key = INVALID_KEY) Constructs a
DatumEntityobject. It requires specifying the segment key where theDatumEntitywill insert associated geometry.
-
PMI::DatumEntity::DatumEntity(DatumEntity const &that)
-
virtual
PMI::DatumEntity::~DatumEntity() virtual
-
void
PMI::DatumEntity::Set(DatumEntity const &that)
-
DatumEntity const &
PMI::DatumEntity::operator=(DatumEntity const &that)
-
virtual Type
PMI::DatumEntity::GetType() const const virtual
Returns
the PMI::Type for this entity. Overridden by subclasses.
-
Datum::Type
PMI::DatumEntity::GetDatumType() const const
Returns
the datum type of thisDatumEntity
-
void
PMI::DatumEntity::SetDatumType(Datum::Type const in_type) Sets the datum type of this
DatumEntity. This will replace an existing datum type.
-
unsigned int
PMI::DatumEntity::GetLabelCount() const const
-
void
PMI::DatumEntity::GetLabels(unsigned int &out_count, String out_labels[], TextAttributes out_text_attributes[]) const const
Gets the labels for this
DatumEntity.Parameters
out_count: the number of labels for this
DatumEntity. Returned to the user.out_labels: the array of labels for this
DatumEntity. 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
TextAttributesfor the labels for thisDatumEntity. 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::DatumEntity::SetLabels(unsigned int in_count, String const in_labels[], TextAttributes const in_text_attributes[]) Sets the labels for this
DatumEntity. These will replace any existing labels.Parameters
in_count: the number of labels in the array
in_labels: the array of labels for this
DatumEntityin_text_attributes: the array of
TextAttributesfor the labels for thisDatumEntity