UnitGroup Class Reference

A UnitGroup is a set of ScaleUnits that are interconvertible Notes: It is possible to violate the integrity of the UnitGroup by changing ScaleUnits included in the group. Kindly use the UpdateUnit method provided. More...

#include <scunit.h>

List of all members.

Public Member Functions
	UnitGroup ()
	Default constructor for a UnitGroup. Provides safe defaults. Scope: public.
	UnitGroup (const UnitGroup &GroupToCopy)
	Do not use Scope: public.
BOOL	IsValid ()
virtual	~UnitGroup ()
	Default destructor for the group Scope: public.
virtual UnitGroup &	operator= (const UnitGroup &GroupToCopy)
	Do not use Scope: public.
virtual BOOL	operator== (const UnitGroup &RhsGroup) const
	Do not use Scope: public.
virtual BOOL	operator!= (const UnitGroup &RhsGroup) const
	Do not use Scope: public.
BOOL	AddUnit (ScaleUnit *pUnit)
	Adds a ScaleUnit to a UnitGroup.
BOOL	AddUnit (ScaleUnit &NewUnit)
	Adds a ScaleUnit to a UnitGroup.
ScaleUnit *	UpdateUnit (const UINT32 uIndex, ScaleUnit &NewUnit)
	Allows you to update a ScaleUnit in a UnitGroup.
BOOL	DeleteUnit (ScaleUnit &UnitToDelete)
	Lets you delete a ScaleUnit from the UnitGroup Scope: public.
ScaleUnit *	FindUnitFromQualifier (const String_32 &qualifier) const
	Identifies a ScaleUnit from the given qualifier token, e.g., '', 'd', etc Scope: public.
ScaleUnit *	FindUnitFromIndex (const UINT32 uIndex) const
	Find a unit by index Scope: public.
INT32	FindIndexFromUnit (const ScaleUnit &thisUnit) const
	Gets a unique index for the given ScaleUnit in the UnitGroup by which it may be referred. Scope: public.
UINT32	GetUnitCount () const
	Provides a check for parameters usually Scope: public.
BOOL	SetDefaultUnit (ScaleUnit *pUnit)
	To provide a default ScaleUnit to use when no unit is specified for ScaleFromString (& no ScaleUnit has a NULL qualifier) Scope: public.
ScaleUnit *	GetDefaultUnit () const
	Provides a pointer to the default unit in the group. (NULL is no default) Scope: public.
BOOL	ScaleFromString (const StringBase &string, double &dNumber) const
	Given a string of the form <number>[<qualifier>] | <qualifier><number> this method will produce a number in the range 0 to 1 depending on the qualifier. If no qualifier is given the default for the group is used. If no default is provided FALSE is returned.
Protected Member Functions
virtual void	OnUnitChanged (const ScaleUnit &UpdatedUnit)
virtual BOOL	AllowDeletion (const ScaleUnit &UnitToDelete)
virtual void	OnDeleteCompletion (const ScaleUnit &DeletedUnit)
Protected Attributes
List	m_UnitList
List	m_UnitRefList
ScaleUnit *	m_pDefaultUnit
Private Member Functions
	CC_DECLARE_MEMDUMP (UnitGroup)
Private Attributes
BOOL	m_bConstructedOK

---

Detailed Description

A UnitGroup is a set of ScaleUnits that are interconvertible Notes: It is possible to violate the integrity of the UnitGroup by changing ScaleUnits included in the group. Kindly use the UpdateUnit method provided.

Author:

Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>

Date:

02/05/96

Definition at line 318 of file scunit.h.

---

Constructor & Destructor Documentation

UnitGroup::UnitGroup (   )

Default constructor for a UnitGroup. Provides safe defaults. Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Definition at line 910 of file scunit.cpp. { m_pDefaultUnit = NULL; m_bConstructedOK = TRUE; }

UnitGroup::UnitGroup (  const UnitGroup &  GroupToCopy  )

Do not use Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Definition at line 946 of file scunit.cpp. { ERROR3("UnitGroup::UnitGroup - not expected to work"); *this = GroupToCopy; }

UnitGroup::~UnitGroup (   )  [virtual]

Default destructor for the group Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Definition at line 927 of file scunit.cpp. { ScaleUnit* pUnit; while ((pUnit = (ScaleUnit*)m_UnitList.RemoveHead()) != NULL) ; }

---

Member Function Documentation

BOOL UnitGroup::AddUnit (  ScaleUnit &  NewUnit  )

Adds a ScaleUnit to a UnitGroup. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: NewUnit  : a ScaleUnit to add to this UnitGroup [INPUTS] Returns: TRUE : If unit added to group FALSE : Errors: Not allowed to add a NULL pointer to a UnitGroup ERROR3's if UnitGroup is corrupt Scope: public Definition at line 1131 of file scunit.cpp. { ERROR2IF(TRUE, FALSE, "Not tested"); // Check for duplicate units in a group ScaleUnitReference* pCurrentRef = (ScaleUnitReference*)m_UnitRefList.GetHead(); const Qualifier* pCurrentQualifier = NewUnit.GetQualifier(); ERROR3IF(!(pCurrentQualifier->IS_KIND_OF(Qualifier)), "NewUnit contains alien qualifier"); while (pCurrentRef != NULL) { ERROR3IF(!(pCurrentRef->IS_KIND_OF(ScaleUnitReference)), "UnitGroup contains alien objects"); { const ScaleUnit* pNewUnit = pCurrentRef->GetUnit(); const Qualifier* pNewQualifier = pNewUnit->GetQualifier(); ERROR3IF(!(pNewQualifier->IS_KIND_OF(Qualifier)), "RhsRef has alien qualifier"); if (*(pNewQualifier->GetToken()) == *(pCurrentQualifier->GetToken())) { ERROR3("Adding unit with duplicate qualifier"); return FALSE; } } pCurrentRef = (ScaleUnitReference*)m_UnitRefList.GetNext((ListItem*)pCurrentRef); } // Unit not already in list so add on the end pCurrentRef = new ScaleUnitReference(NewUnit); m_UnitRefList.AddTail((ListItem*)pCurrentRef); return TRUE; }

BOOL UnitGroup::AddUnit (  ScaleUnit *  pNewUnit  )

Adds a ScaleUnit to a UnitGroup. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: pNewUnit  = ptr to a unit to add to the group [INPUTS] Returns: TRUE : If unit added to group FALSE : Errors: Not allowed to add a NULL pointer to a UnitGroup ERROR3's if UnitGroup is corrupt Scope: public Definition at line 1086 of file scunit.cpp. { ERROR2IF(pNewUnit == NULL && !pNewUnit->IS_KIND_OF(ScaleUnit), FALSE, "Adding a bogus ScaleUnit"); // Check for duplicate units in a group ScaleUnit* pCurrentUnit = (ScaleUnit*)m_UnitList.GetHead(); while (pCurrentUnit != NULL) { ERROR3IF(!(pCurrentUnit->IS_KIND_OF(ScaleUnit)), "UnitGroup contains alien objects"); const Qualifier* pNewQualifier = pNewUnit->GetQualifier(); ERROR3IF(!(pNewQualifier->IS_KIND_OF(Qualifier)), "pNewUnit has alien qualifier"); const Qualifier* pCurrentQualifier = pCurrentUnit->GetQualifier(); ERROR3IF(!(pCurrentQualifier->IS_KIND_OF(Qualifier)), "UnitGroup contains alien qualifier"); if (*(pNewQualifier->GetToken()) == *(pCurrentQualifier->GetToken())) { // ScaleUnit qualifier already in group ERROR3IF(*pNewUnit == *pCurrentUnit, "Adding unit with duplicate qualifier"); return TRUE; } pCurrentUnit = (ScaleUnit*)m_UnitList.GetNext((ListItem*)pCurrentUnit); } // Unit not already in list so add on the end m_UnitList.AddTail((ListItem*)pNewUnit); return TRUE; }

virtual BOOL UnitGroup::AllowDeletion (  const ScaleUnit &  UnitToDelete  )  [protected, virtual]

UnitGroup::CC_DECLARE_MEMDUMP (  UnitGroup   )  [private]

BOOL UnitGroup::DeleteUnit (  ScaleUnit &  UnitToDelete  )

Lets you delete a ScaleUnit from the UnitGroup Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: pUnit  : A pointer to the ScaleUnit to delete. [INPUTS] Returns: TRUE : Deletion completed FALSE : Not completed Definition at line 1205 of file scunit.cpp. { ERROR2IF(TRUE, FALSE, "UnitGroup::DeleteUnit - Not tested"); ScaleUnit* pUnit = &UnitToDelete; // Allow something to prevent the deletion if (!AllowDeletion(UnitToDelete)) return FALSE; pUnit = (ScaleUnit*)m_UnitList.RemoveItem((ListItem*)pUnit); if (pUnit == NULL) { ERROR3("UnitGroup::DeleteUnit - Item not in list"); return FALSE; } if (m_pDefaultUnit == pUnit) // Reset the default unit if this is being deleted m_pDefaultUnit = NULL; // Allow something to be informed that the unit is about to be deleted OnDeleteCompletion(UnitToDelete); return TRUE; }

INT32 UnitGroup::FindIndexFromUnit (  const ScaleUnit &  thisUnit  )  const

Gets a unique index for the given ScaleUnit in the UnitGroup by which it may be referred. Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: thisUnit  = ScaleUnit to look for [INPUTS] Returns: An index for the given ScaleUnit. -1 if not found Definition at line 1306 of file scunit.cpp. { ScaleUnit* pUnit = (ScaleUnit*) m_UnitList.GetHead(); INT32 nIndex = 0; while (pUnit != NULL) { ERROR3IF(!(pUnit->IS_KIND_OF(ScaleUnit)), "UnitGroup contains alien objects"); if (*pUnit == thisUnit) break; pUnit = (ScaleUnit*) m_UnitList.GetNext((ListItem*)pUnit); ++nIndex; } if (pUnit == NULL) nIndex = -1; // not found return nIndex; }

ScaleUnit * UnitGroup::FindUnitFromIndex (  const UINT32  uIndex  )  const

Find a unit by index Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 5/5/94 Parameters: Index  = indexes directly into the unit list (0 = first unit in list) [INPUTS] Returns: Ptr to the unit. NULL is returned if not found. Definition at line 1281 of file scunit.cpp. { ERROR2IF(uIndex >= GetUnitCount(), NULL, "uIndex invalid"); ScaleUnit* pUnit = (ScaleUnit*) m_UnitList.FindItem(LISTPOS(uIndex)); ERROR3IF(!pUnit->IS_KIND_OF(ScaleUnit), "UnitGroup contains alien objects"); return pUnit; }

ScaleUnit * UnitGroup::FindUnitFromQualifier (  const String_32 &  qualifier  )  const

Identifies a ScaleUnit from the given qualifier token, e.g., '', 'd', etc Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: qualifier  : for the unknown unit [INPUTS] Returns: The ScaleUnit represented by the qualifier If no ScaleUnit has the given qualifier, the Default unit is returned (which may be NULL) See also: UnitGroup::SetDefaultUnit() Definition at line 1247 of file scunit.cpp. { ScaleUnit* pUnit = (ScaleUnit*) m_UnitList.GetHead(); while (pUnit != NULL) { ERROR3IF(!(pUnit->IS_KIND_OF(ScaleUnit)), "UnitGroup::FindUnitFromQualifier - UnitGroup contains alien objects"); const Qualifier* pQualifier = pUnit->GetQualifier(); ERROR3IF(!(pQualifier->IS_KIND_OF(Qualifier)), "UnitGroup::FindUnitFromQualifier - Qualifier is not"); if (qualifier == pQualifier->GetToken()) return pUnit; pUnit = (ScaleUnit*) m_UnitList.GetNext((ListItem*)pUnit); } return NULL; }

ScaleUnit * UnitGroup::GetDefaultUnit (   )  const

Provides a pointer to the default unit in the group. (NULL is no default) Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: -  [INPUTS] Returns: A pointer to the default unit Definition at line 1387 of file scunit.cpp. { return m_pDefaultUnit; }

UINT32 UnitGroup::GetUnitCount (   )  const

Provides a check for parameters usually Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Returns: The number of ScaleUnits in the group Definition at line 1335 of file scunit.cpp. { return m_UnitList.GetCount(); }

BOOL UnitGroup::IsValid (   )  [inline]

Definition at line 326 of file scunit.h. {return m_bConstructedOK;}

virtual void UnitGroup::OnDeleteCompletion (  const ScaleUnit &  DeletedUnit  )  [protected, virtual]

virtual void UnitGroup::OnUnitChanged (  const ScaleUnit &  UpdatedUnit  )  [protected, virtual]

BOOL UnitGroup::operator!= (  const UnitGroup &  RhsGroup  )  const [virtual]

Do not use Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Definition at line 1065 of file scunit.cpp. { return !(*this == RhsGroup); }

UnitGroup & UnitGroup::operator= (  const UnitGroup &  GroupToCopy  )  [virtual]

Do not use Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Definition at line 963 of file scunit.cpp. { ERROR3("UnitGroup::operator= - not expected to work"); if (this == &GroupToCopy) return *this; INT32 thisSize = m_UnitRefList.GetCount(); if (thisSize == 0) // no need to copy the units so exit stage left { m_pDefaultUnit = GroupToCopy.m_pDefaultUnit; m_bConstructedOK = TRUE; return *this; } // First bin the old list of units... ScaleUnitReference* pUnitRef; while ((pUnitRef = (ScaleUnitReference*)m_UnitList.RemoveHead()) != NULL) delete pUnitRef; // Create space for all the units in one go... ScaleUnitReference* UnitRefArray = new ScaleUnitReference[thisSize]; if (UnitRefArray == NULL) { m_pDefaultUnit = NULL; m_bConstructedOK = FALSE; return *this; } ScaleUnitReference* pRefToCopy = (ScaleUnitReference*) m_UnitRefList.GetHead(); UINT32 uIndex = 0; while (pRefToCopy != NULL) { ScaleUnitReference* NewRef = &UnitRefArray[uIndex++]; NewRef->SetUnit(pRefToCopy->GetUnit()); m_UnitRefList.AddTail(NewRef); pRefToCopy = (ScaleUnitReference*)m_UnitList.GetNext(pRefToCopy); } m_pDefaultUnit = GroupToCopy.m_pDefaultUnit; m_bConstructedOK = TRUE; return *this; }

BOOL UnitGroup::operator== (  const UnitGroup &  RhsGroup  )  const [virtual]

Do not use Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Definition at line 1017 of file scunit.cpp. { INT32 rhsSize = RhsGroup.m_UnitRefList.GetCount(); INT32 thisSize = m_UnitRefList.GetCount(); if (rhsSize != thisSize) return FALSE; if (rhsSize == 0 && thisSize == 0) return TRUE; ERROR3("UnitGroup::operator== - not expected to work"); // Create a list of references from which we can eliminate duplicates // in the RhsGroup UnitGroup pointerList = *this; // Now scan through the group we are comparing with eliminating duplicates in our // ScaleUnit* pRhsUnit = (ScaleUnit*) RhsGroup.m_UnitList.GetHead(); while (pRhsUnit != NULL) { ScaleUnitReference* pLhsUnit = (ScaleUnitReference*) pointerList.m_UnitRefList.GetHead(); while (pLhsUnit != NULL) { if (*pLhsUnit->GetUnit() == *pRhsUnit) { // Eliminate matching pointer pointerList.m_UnitRefList.RemoveItem((ListItem*)pLhsUnit); break; } pLhsUnit = (ScaleUnitReference*)pointerList.m_UnitRefList.GetNext(pLhsUnit); } pRhsUnit = (ScaleUnit*)RhsGroup.m_UnitList.GetNext((ListItem*)pRhsUnit); } return pointerList.m_UnitRefList.IsEmpty(); }

BOOL UnitGroup::ScaleFromString (  const StringBase &  string, double &  dNumber )  const

Given a string of the form <number>[<qualifier>] | <qualifier><number> this method will produce a number in the range 0 to 1 depending on the qualifier. If no qualifier is given the default for the group is used. If no default is provided FALSE is returned. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: string  : [INPUTS] dNumber  : A scale from 0 - 1 [OUTPUTS] Returns: TRUE : The string was able to be converted to a scale from 0 to 1. FALSE : No can do Errors: - Scope: public See also: Definition at line 1545 of file scunit.cpp. { String_32 qualifier, amount; Qualifier::QUALIFIER_AFFIX affixType; Parser parser(string); parser.PrepareForParse(); Parser::TOKEN tk = parser.GetToken(); if (tk == Parser::TK_QUALIFIER) // expecting prefix qualifier { qualifier = parser.GetSemanticValue(); affixType = Qualifier::PREFIX; tk = parser.GetToken(); if (tk == Parser::TK_NUMBER) { amount = parser.GetSemanticValue(); } else { //ERROR3("UnitGroup::ScaleFromString - no number"); return FALSE; } } else if (tk == Parser::TK_NUMBER) // expecting suffix qualifier { amount = parser.GetSemanticValue(); tk = parser.GetToken(); if (tk == Parser::TK_QUALIFIER) { affixType = Qualifier::SUFFIX; qualifier = parser.GetSemanticValue(); } else if (tk == Parser::TK_EOS) { affixType = Qualifier::NONE; } else { //ERROR3("UnitGroup::ScaleFromString - invalid characters"); return FALSE; } } else { //ERROR3("UnitGroup::ScaleFromString - invalid characters"); return FALSE; } ScaleUnit* pUnit; // We've found a qualifier & amount so check them both pUnit = FindUnitFromQualifier(qualifier); if (pUnit == NULL) // no match so use the default { pUnit = GetDefaultUnit(); } else { //ERROR3IF(pUnit->GetQualifier()->GetAffix() != affixType, "UnitGroup::ScaleFromString - qualifier position incorrect"); } if (pUnit == NULL) // no unit with that qualifier & no default { return FALSE; } ERROR3IF(!pUnit->IS_KIND_OF(ScaleUnit), "UnitGroup::ScaleFromString - pUnit isn't"); Convert::StringToDouble( amount, &dNumber ); return (pUnit->ConvertTo0to1(dNumber)); }

BOOL UnitGroup::SetDefaultUnit (  ScaleUnit *  pUnit  )

To provide a default ScaleUnit to use when no unit is specified for ScaleFromString (& no ScaleUnit has a NULL qualifier) Scope: public. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: pUnit  : A pointer to the ScaleUnit to set as default. NULL is no default [INPUTS] Returns: TRUE : The unit was set FALSE : The unit was not in the UnitGroup Definition at line 1356 of file scunit.cpp. { if (pUnit == NULL) // Set no default { m_pDefaultUnit = NULL; return TRUE; } ERROR2IF(!(pUnit->IS_KIND_OF(ScaleUnit)), FALSE, "pUnit Invalid"); LISTPOS lp = m_UnitList.FindPosition(pUnit); if (lp == NOT_IN_LIST || lp == EMPTY_LIST) return FALSE; m_pDefaultUnit = pUnit; return TRUE; }

ScaleUnit * UnitGroup::UpdateUnit (  const UINT32  uIndex, ScaleUnit &  NewUnit )

Allows you to update a ScaleUnit in a UnitGroup. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 8/7/94 Parameters: uIndex  : Index of ScaleUnit to update (0..GetUnitCount() - 1) [INPUTS] Unit : the ScaleUnit to replace the one at uIndex Returns: A pointer to the old ScaleUnit if updated correctly NULL : Otherwise Errors: ERROR2's for parameter validation Scope: public Definition at line 1176 of file scunit.cpp. { ERROR2IF(uIndex >= GetUnitCount(), FALSE, "uIndex invalid"); ERROR2IF(TRUE, FALSE, "Not tested"); ScaleUnit* pOldUnit = FindUnitFromIndex(uIndex); // Can't change the qualifier?? if (NewUnit.GetQualifier()->GetToken() != pOldUnit->GetQualifier()->GetToken()) return NULL; // *pOldUnit = *pUnit; return pOldUnit; }

---

Member Data Documentation

BOOL UnitGroup::m_bConstructedOK [private]

Definition at line 363 of file scunit.h.

ScaleUnit* UnitGroup::m_pDefaultUnit [protected]

Definition at line 355 of file scunit.h.

List UnitGroup::m_UnitList [protected]

Definition at line 353 of file scunit.h.

List UnitGroup::m_UnitRefList [protected]

Definition at line 354 of file scunit.h.

---

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

• Kernel/scunit.h (r1785/r1282)
• Kernel/scunit.cpp (r1785/r1282)

---