SIM_PointMapping Class Reference

#include <SIM_PointMapping.h>

Inheritance diagram for SIM_PointMapping:

SIM_Data SIM_OptionsUser

List of all members.

Public Member Functions

 GETSET_DATA_FUNCS_S (SIM_NAME_ATTRIBUTENAME, AttributeName)
 The name of the attribute to use for our mapping.
int getPointWithAttributeValue (int attribvalue) const
 The name of the attribute to map.

Protected Member Functions

 SIM_PointMapping (const SIM_DataFactory *factory)
virtual ~SIM_PointMapping ()
virtual void initializeSubclass ()
virtual int64 getMemorySizeSubclass () const
virtual bool getIsAlternateRepresentationSubclass () const
virtual void initAlternateRepresentationSubclass (const SIM_Data &)


Detailed Description

This class holds a mapping from some point attribute to point numbers on the parent geometry data. The attribute must be a single integer.

Definition at line 31 of file SIM_PointMapping.h.


Constructor & Destructor Documentation

SIM_PointMapping::SIM_PointMapping ( const SIM_DataFactory factory  )  [explicit, protected]

virtual SIM_PointMapping::~SIM_PointMapping (  )  [protected, virtual]


Member Function Documentation

virtual bool SIM_PointMapping::getIsAlternateRepresentationSubclass (  )  const [protected, virtual]

Override this method to return true if your data type is built on demand. This is true for data that is just an alternative representation of some other data. This has several consequences. First, it implies that the data can be rebuilt from other data on the object, therefore it is not saved to disk. Also, it is assumed to be represent its parent data, so any modifications to the parent data cause this data to be deleted. If you override this method, do not call the base class implementation.

Reimplemented from SIM_Data.

virtual int64 SIM_PointMapping::getMemorySizeSubclass (  )  const [protected, virtual]

Override this function to return an accurate representation of the amount of memory used by this piece of data. The size of subdata should not be included in this calculation.

Reimplemented from SIM_Data.

int SIM_PointMapping::getPointWithAttributeValue ( int  attribvalue  )  const

The name of the attribute to map.

SIM_PointMapping::GETSET_DATA_FUNCS_S ( SIM_NAME_ATTRIBUTENAME  ,
AttributeName   
)

The name of the attribute to use for our mapping.

virtual void SIM_PointMapping::initAlternateRepresentationSubclass ( const SIM_Data  )  [protected, virtual]

Override this function if getIsAlternateRepresentationSubclass() is overridden to return true. This function is used to initialize the alternate representation based on the data to which it was just attached.

Reimplemented from SIM_Data.

virtual void SIM_PointMapping::initializeSubclass (  )  [protected, virtual]

Override this method to set this data to its default empty state. Remember to call the base class implementation. The default implementation clears all subdata, and if the data is a subclass of SIM_OptionsUser, calls initializeFromParmDefaults().

Reimplemented from SIM_Data.


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

Generated on Mon Jan 28 00:48:53 2013 for HDK by  doxygen 1.5.9