Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

PMI::NoteEntity Class Reference

#include <HUtilityPMI.h>

Inheritance diagram for PMI::NoteEntity:

PMI::Entity

List of all members.

Public Member Functions

unsigned int GetStringCount () const
void GetStrings (unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const
virtual Type GetType () const
 NoteEntity (NoteEntity const &that)
 NoteEntity (HC_KEY segment_key=INVALID_KEY)
NoteEntity const & operator= (NoteEntity const &that)
void Set (NoteEntity const &that)
void SetStrings (unsigned int in_count, String const in_strings[], TextAttributes const in_text_attributes[])


Detailed Description

This class represents a single or multi-line block of text.

Constructor & Destructor Documentation

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

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


Member Function Documentation

unsigned int PMI::NoteEntity::GetStringCount (  )  const

Returns:
the number of strings for this NoteEntity

void PMI::NoteEntity::GetStrings ( unsigned int &  out_count,
String  out_strings[],
TextAttributes  out_text_attributes[] 
) const

Gets the strings for this NoteEntity.

Parameters:
out_count the number of strings for this NoteEntity. Returned to the user.
out_strings the array of strings for this NoteEntity. 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 strings for this NoteEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

virtual Type PMI::NoteEntity::GetType (  )  const [inline, virtual]

Returns:
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented from PMI::Entity.

void PMI::NoteEntity::SetStrings ( unsigned int  in_count,
String const   in_strings[],
TextAttributes const   in_text_attributes[] 
)

Sets the strings for this NoteEntity. These will replace any existing strings.

Parameters:
in_count the number of strings in the array
in_strings the array of strings for this NoteEntity
in_text_attributes the array of TextAttributes for the strings for this NoteEntity


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