#include <adskDataIndexPair.h>

Class Description

Index type which uses a pair of IndexCount values for the index mapping.

adsk::Data::Stream objects contain a list of data elements. Each element has to be accessed by Index. This is one of the more general index types, a pair of IndexCount values. An adsk::Data::IndexPair element is used to lookup the physical location of a data element, either directly in an array using the dense mode or indirectly through a mapping in the sparse, or mapping, mode.

Inheritance diagram for IndexPair:

Public Member Functions
	IndexPair (IndexCount firstValue, IndexCount secondValue)
	Conversion constructor. More...

	IndexPair (const IndexPair &rhs)
	Copy constructor, simplest level. More...

	IndexPair (const std::string &value)
	Construct an IndexPair from a string containing the two values. More...

virtual	~IndexPair ()
	Default destructor, nothing to do.

IndexPair &	operator= (const IndexPair &rhs)
	Class assignment operator. More...

void	getIndexPair (IndexCount &first, IndexCount &second) const
	Get the two values comprising this index pair. More...

virtual std::string	asString () const
	Get the IndexPair in string form. More...

virtual bool	supportsDenseMode () const
	Notifies users that this index type can be packed densely. More...

virtual IndexCount	denseSpaceBetween (const IndexType &rhs) const
	Calculate the dense space occupied between two index pairs. More...

virtual bool	operator== (const IndexType &rhs) const
	Equality operator, checks if this IndexPair is the same as another Objects of different types are defined as not equal. More...

virtual bool	operator!= (const IndexType &rhs) const
	Inequality operator, checks if this IndexPair is not the same as another Objects of different types are defined as not equal. More...

virtual bool	operator< (const IndexType &rhs) const
	Less-than operator, checks if this IndexPair is less than another Operator sorts by typeid if the object passed in is not an IndexPair. More...

virtual bool	operator<= (const IndexType &rhs) const
	Less-or-equal operator, checks if this IndexPair is <= another Operator sorts by typeid if the object passed in is not an IndexPair. More...

virtual bool	operator> (const IndexType &rhs) const
	Greater-than operator, checks if this IndexPair is greater than another Operator sorts by typeid if the object passed in is not an IndexPair. More...

virtual bool	operator>= (const IndexType &rhs) const
	Greater-or-equal operator, checks if this IndexPair is >= another Operator sorts by typeid if the object passed in is not an IndexPair. More...

virtual bool	operator== (const IndexPair &rhs) const
	Equality operator, checks if this IndexPair is the same as another. More...

virtual bool	operator!= (const IndexPair &rhs) const
	Inequality operator, checks if this IndexPair is not the same as another. More...

virtual bool	operator< (const IndexPair &rhs) const
	Less-than operator, checks if this IndexPair is less than another. More...

virtual bool	operator<= (const IndexPair &rhs) const
	Less-or-equal operator, checks if this IndexPair is <= another. More...

virtual bool	operator> (const IndexPair &rhs) const
	Greater-than operator, checks if this IndexPair is greater than another. More...

virtual bool	operator>= (const IndexPair &rhs) const
	Greater-or-equal operator, checks if this IndexPair is >= another. More...

Public Member Functions inherited from IndexType
	IndexType (const IndexType &rhs)
	Copy constructor, simplest level. More...

Static Public Member Functions
static bool	Debug (const IndexPair *me, adsk::Debug::Print &request)
	Answer a Print request for the IndexPair type. More...

static bool	Debug (const IndexPair *me, adsk::Debug::Footprint &request)
	Answer a footprint request for the IndexPair type. More...

Static Public Member Functions inherited from RefCounted
static bool	Debug (const RefCounted *me, Debug::Print &request)
	Answer a Print request for a RefCounted object. More...

static bool	Debug (const RefCounted *me, Debug::Footprint &request)
	Answer a footprint request for a RefCounted object. More...

Protected Member Functions
	IndexPair ()
	Default constructor, should never be used.

Protected Member Functions inherited from IndexType
virtual	~IndexType ()
	Default destructor, nothing to do.

	IndexType ()
	Default constructor, should never be used.

Protected Member Functions inherited from RefCounted
	RefCounted ()
	RefCounted default ctor.

	RefCounted (const RefCounted &)
	RefCounted copy ctor.

virtual	~RefCounted ()
	RefCounted dtor.

Protected Attributes
IndexCount	fSecondIndex
	First index used for mapping.

Static Protected Attributes
static std::string	myTypeName = "pair"
	Name used to identify this type.

static IndexRegistration	myRegistration
	Name used to identify this type.

Friends
class	CRTP_IndexType< IndexPair >
	Second index used for mapping.

Constructor & Destructor Documentation

IndexPair	(	IndexCount	firstIndex,
		IndexCount	secondIndex
	)

Conversion constructor.

Parameters

[in]	firstIndex	One of the IndexCounts
[in]	secondIndex	The other of the IndexCounts

IndexPair ( const IndexPair & rhs )

Copy constructor, simplest level.

Parameters

[in] rhs IndexPair data to be copied

IndexPair ( const std::string & value )

Construct an IndexPair from a string containing the two values.

Parameters

[in] value String with format "### ###" containing the two index values

Exceptions

Index::kBadSyntax	Non-numeric values, or less than 2 numbers
Index::kExcessData	More than 2 numbers in the string

Member Function Documentation

IndexPair & operator= ( const IndexPair & rhs )

Class assignment operator.

Parameters

[in] rhs IndexPair data to be copied

void getIndexPair	(	IndexCount &	first,
		IndexCount &	second
	)		const

Get the two values comprising this index pair.

Parameters

[out]	first	First index value of the pair
[out]	second	Second index value of the pair

std::string asString ( ) const

virtual

Get the IndexPair in string form.

Returns: String representing the index value (in the same form expected by the creator functions)

Implements IndexType.

bool supportsDenseMode ( ) const

virtual

Notifies users that this index type can be packed densely.

Returns: true, indicating that this index type can be used in dense mode

Implements IndexType.

IndexCount denseSpaceBetween ( const IndexType & rhs ) const

virtual

Calculate the dense space occupied between two index pairs.

An index pair can be thought of as a matrix so the space occupied by densely packing that matrix [a,b] - [c,d] equals the integral area of a subsection of the infinite matrix at those coordinates

Parameters

[in] rhs The other object from whom packing space is to be calculated

Returns: Size of that sub-matrix occupied between the pairs, including the rows and columns occupied by the endpoints. Returns 0 if the dense packing cannot be supported.

Implements IndexType.

bool operator== ( const IndexType & rhs ) const

virtual

Equality operator, checks if this IndexPair is the same as another Objects of different types are defined as not equal.

Parameters

[in] rhs IndexPair to be compared

Returns: true if the two IndexPair objects have the same underlying IndexCounts

Implements IndexType.

bool operator!= ( const IndexType & rhs ) const

virtual

Inequality operator, checks if this IndexPair is not the same as another Objects of different types are defined as not equal.

Parameters

[in] rhs IndexPair to be compared

Returns: true if the two IndexPair objects have a different underlying IndexCount

Implements IndexType.

bool operator< ( const IndexType & rhs ) const

virtual

Less-than operator, checks if this IndexPair is less than another Operator sorts by typeid if the object passed in is not an IndexPair.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair's counter is less than rhs's

Implements IndexType.

bool operator<= ( const IndexType & rhs ) const

virtual

Less-or-equal operator, checks if this IndexPair is <= another Operator sorts by typeid if the object passed in is not an IndexPair.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair's counter is less than or equal to rhs's

Implements IndexType.

bool operator> ( const IndexType & rhs ) const

virtual

Greater-than operator, checks if this IndexPair is greater than another Operator sorts by typeid if the object passed in is not an IndexPair.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair's counter is greater than rhs's

Implements IndexType.

bool operator>= ( const IndexType & rhs ) const

virtual

Greater-or-equal operator, checks if this IndexPair is >= another Operator sorts by typeid if the object passed in is not an IndexPair.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair's counter is greater than or equal to rhs's

Implements IndexType.

bool operator== ( const IndexPair & rhs ) const

virtual

Equality operator, checks if this IndexPair is the same as another.

Parameters

[in] rhs IndexPair to be compared

Returns: true if the two IndexPair objects have the same underlying IndexCounts

bool operator!= ( const IndexPair & rhs ) const

virtual

Inequality operator, checks if this IndexPair is not the same as another.

Parameters

[in] rhs IndexPair to be compared

Returns: true if the two IndexPair objects have different underlying IndexCounts

bool operator< ( const IndexPair & rhs ) const

virtual

Less-than operator, checks if this IndexPair is less than another.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair is less than rhs's

bool operator<= ( const IndexPair & rhs ) const

virtual

Less-or-equal operator, checks if this IndexPair is <= another.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair is less than or equal to rhs's

bool operator> ( const IndexPair & rhs ) const

virtual

Greater-than operator, checks if this IndexPair is greater than another.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair is greater than rhs's

bool operator>= ( const IndexPair & rhs ) const

virtual

Greater-or-equal operator, checks if this IndexPair is >= another.

Parameters

[in] rhs IndexPair to be compared

Returns: true if this IndexPair is greater than or equal to rhs's

bool Debug	(	const IndexPair *	me,
		adsk::Debug::Print &	request
	)

static

Answer a Print request for the IndexPair type.

Use the request object to dump all information on the "me" IndexPair, or all static IndexPair information if "me" is NULL.

Parameters

[in]	me	Pointer to object to debug, NULL means class static
[out]	request	Print request object

Returns: True if the request was successfully processed.

bool Debug	(	const IndexPair *	me,
		adsk::Debug::Footprint &	request
	)

static

Answer a footprint request for the IndexPair type.

Populate the Footprint request with the information on all data stored within this class if "me" is NULL, otherwise the information stored in the IndexPair object pointed at by "me".

Parameters

[in]	me	Pointer to object to footprint, NULL means class static
[out]	request	Footprint object to populate

Returns: True if the request was successfully processed. The Footprint object will have all information added to it.

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

adskDataIndexPair.h
adskDataIndexPair.cpp

IndexPair Class Reference

Class Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation