FCMeasureNumberRegions Class Reference

Collection class for FCMeasureNumberRegion class objects. More...

#include <ff_othercollection.h>

Inheritance diagram for FCMeasureNumberRegions:

Public Member Functions
	FCMeasureNumberRegions ()
	The constructor.
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
FCMeasureNumberRegion *	FindMeasure (int measure)
	Returns the first region in the collection that contains the measure number.
FCMeasureNumberRegion *	FindByID (int theID)
	Returns the region that matches a specific ID.
int	CalcStringFromNumber (int measure, FCString *pString)
	Formats the printed measure number for a specific measure in the document.
int	CalcNumberFromString (const FCString &value)
	Returns the 1-based number based on the supplied printed string.
bool	IsMeasureIncluded (int measure)
	Returns true if the measure is included in any of the measure number regions.
bool	IsStringUnique (const FCString &value)
	Returns true if the "printed" measure number string has no ambiguity among the measure number regions.
int	CountRegionsForMeasure (int measure)
	Returns the number of regions that the 1-based measure number is part of.
FCMeasureNumberRegion *	GetItemAt (int index) const
	Overridden version of GetItemAt().
Public Member Functions inherited from __FCCollectionNoInciOther
__FCNoInciOther *	FindItemNo (CMPER cmper)
	Returns the (first) item in the collection that has the indicated item number (CMPER).
Public Member Functions inherited from __FCCollectionData
	__FCCollectionData ()
	The constructor.
virtual int	LoadAll ()
	Loads all available data into the collection.
virtual bool	SaveAll ()
	Saves all data in the collection.
void	SetCustomTag (EXTAG tag)
	Sets a custom Enigma tag for the elements of the collection.
Public Member Functions inherited from __FCCollection
	__FCCollection ()
	The constructor.
virtual	~__FCCollection ()
	The virtual destructor, which deallocates the array and also all its elements.
int	GetCount () const
	Returns the number of elements of the collection.
void	Add (__FCBase *pNewItem)
	Adds an element to the end of the collection.
bool	UniqueAdd (__FCBase *pNewItem)
	Adds an element to the end of the collection, but only if it doesn't exist in the collection before.
void	InsertItemAt (__FCBase *pNewItem, int index)
	Inserts an item into the collection.
bool	ElementExists (__FCBase *pQueryItem)
	Returns true if the element is found in the collection, otherwise false.
void	ClearAll ()
	Destroys all the objects in the collection and empties the collection.
void	DetachAll ()
	Removes all the objects from the collection, without freeing/destroying the objects.
__FCBase *	GetItemAt (int index) const
	Returns the object at the index position. Index is 0-based.
__FCBase *	GetLastItem () const
	Returns the last item in the collection.
__FCBase *	operator[] (int index) const
	Identical to the GetItemAt method.
int	GetIndexOf (__FCBase *pObject) const
	Returns the 0-based order index for the object within the collection.
__FCBase *	DetachItemAt (int index)
	Removes the object at the index position. Index is 0-based.
bool	ClearItemAt (int index)
	Deletes the object at the index position and disposes the object. Index is 0-based.
int	ToEndFrom (int index, FCIteratorHandler *pIterator)
	Processes one element after another and iterates from one specific index to the end of the collection.
int	ForEach (FCIteratorHandler *pIterator) override
	Processes all elements in the collection (starting with item 0), or until the iterator Iterate() returns false.
virtual int	ForEachIndex (FCIteratorHandler *pIterator)
	Same as ForEach, but the IterateIndex callback of the iterator handler is used instead.
__FCBase *	FindFirst (FCIteratorHandler *pIterator) override
	Process elements until a match is found.
__FCBase *	FindUserData (void *data_to_find)
	Returns the first element in the collection that has the indicated userdata.
bool	Sort (FCIteratorHandler *pIterator)
	Sorts the elements of.
bool	Swap (int index1, int index2)
	Swaps to items in the collection.
bool	IsEmpty () const
	Returns true if the collection contains no elements.
int	MoveFrom (__FCCollection *pOtherCollection, bool unique=false)
	Moves elements from another collection into this collection. The other will be empty after the operation.
bool	IsIdentical (const __FCBase *pCompareObject) const override
	Returns true if two collections are considered to be identical.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCIteratorBase
	__FCIteratorBase ()
	The constructor.
Public Member Functions inherited from __FCBase
virtual const PDKFRAMEWORK_CLASSID	GetClassID () const
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes.
virtual void	DebugDataByteArrayDump ()
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID {   FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,   FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,   FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,   FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,   FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,   FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,   FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,   FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,   FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,   FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,   FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,   FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,   FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,   FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,   FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,   FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,   FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,   FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,   FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,   FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,   FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,   FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,   FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,   FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,   FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,   FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,   FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,   FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,   FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,   FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,   FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,   FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...
enum	MEASUREMENTUNITS {   MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,   MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

Detailed Description

Collection class for FCMeasureNumberRegion class objects.

Supports <close> in Lua 5.4 (__FCCollection::ClearAll).

Constructor & Destructor Documentation

FCMeasureNumberRegions()

FCMeasureNumberRegions::FCMeasureNumberRegions ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

CalcNumberFromString()

int FCMeasureNumberRegions::CalcNumberFromString

(

const FCString &

value

)

Returns the 1-based number based on the supplied printed string.

This method supports the following input syntax:

• Measure number reference (such as "10" or "B")
• Absolute number reference (such as #1 or #21)

• Region references (such as "1:10" or "2:B")

  Lua-supported.

Parameters

[in]

value

A reference to the FCString object that contains the printed measure number string.

Returns

-1 on error. Otherwise, the 1-based measure number.

CalcStringFromNumber()

int FCMeasureNumberRegions::CalcStringFromNumber	(	int	measure,
		FCString *	pString )

Formats the printed measure number for a specific measure in the document.

Lua-supported.

Parameters

[in]	measure	The 1-based actual measure number.
[out]	pString	Pointer to the buffer that should contain the text for the displayed measure number. If the return value is -1, this text contains the absolute 1-based measure number.

Returns

0-base index for the region that's used for the text information. -1 if a matching region couldn't be found in the collection.

ClassName()

const char * FCMeasureNumberRegions::ClassName ( ) const

inlineoverridevirtual

Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

Lua-supported.

Reimplemented from __FCCollectionNoInciOther.

CountRegionsForMeasure()

int FCMeasureNumberRegions::CountRegionsForMeasure

(

int

measure

)

Returns the number of regions that the 1-based measure number is part of.

Lua-supported.

Parameters

[in]

measure

The 1-based measure number to check.

Returns

The number of measure number regions in the collection that included the measure.

FindByID()

FCMeasureNumberRegion * FCMeasureNumberRegions::FindByID

(

int

theID

)

Returns the region that matches a specific ID.

Lua-supported.

Parameters

theID

The unique ID (which is 1-based) for the region.

Returns

NULL if not found. Otherwise, a pointer to a FCMeasureNumberRegion object for the found item.

FindMeasure()

FCMeasureNumberRegion * FCMeasureNumberRegions::FindMeasure

(

int

measure

)

Returns the first region in the collection that contains the measure number.

Lua-supported.

Parameters

measure

1-based measure number.

Returns

NULL if not found. Otherwise, a pointer to a FCMeasureNumberRegion object.

GetItemAt()

FCMeasureNumberRegion * FCMeasureNumberRegions::GetItemAt ( int index ) const

inline

Overridden version of GetItemAt().

Lua-supported.

IsMeasureIncluded()

bool FCMeasureNumberRegions::IsMeasureIncluded

(

int

measure

)

Returns true if the measure is included in any of the measure number regions.

This method calls the FCMeasureNumberRegion::IsMeasureIncluded() method for all the measure number regions, until a match is found.

Lua-supported.

Parameters

[in]

measure

The 1-based measure number.

Returns

True if the measure number was included in any of the measure number regions.

IsStringUnique()

bool FCMeasureNumberRegions::IsStringUnique

(

const FCString &

value

)

Returns true if the "printed" measure number string has no ambiguity among the measure number regions.

Lua-supported.

Parameters

[in]

value

The FCString object containing the "printed" measure number string.

Returns

True if the string can only be referenced in one single measure number region, or if it references an absolute number (using the '#' prefix). False if the string appears in multiple regions, or if it doesn't appear in any region, or if the string is NULL.