NTV2Line21AttributePermutations Class Reference

An ordered set of all possible NTV2Line21Attributes permutations (excluding the "flashing" attribute, which is not required for glyph rendering). Call size() to discover how many there are. Call GetPermutation with an index >= 0 and < size() to get a specific attribute permutation. Call GetIndexFromAttribute to find out which permutation index corresponds to the given attribute. More...

#include <ntv2caption608types.h>

Public Member Functions
	NTV2Line21AttributePermutations ()
	My constructor. More...
const NTV2Line21Attrs &	GetPermutation (const size_t inIndex) const
	Returns a const reference to the attribute that corresponds to the given permutation index. More...
ULWord	size (void) const
	Returns my size (the total number of attribute permutations that I have). More...
size_t	GetIndexFromAttribute (const NTV2Line21Attributes &inAttribute) const
	Returns the permutation index that corresponds to the given attribute. More...
const NTV2Line21Attrs &	operator[] (const size_t inIndex) const
	Returns a const reference to the attribute that corresponds to the given permutation index. More...

Detailed Description

An ordered set of all possible NTV2Line21Attributes permutations (excluding the "flashing" attribute, which is not required for glyph rendering). Call size() to discover how many there are. Call GetPermutation with an index >= 0 and < size() to get a specific attribute permutation. Call GetIndexFromAttribute to find out which permutation index corresponds to the given attribute.

Definition at line 882 of file ntv2caption608types.h.

Constructor & Destructor Documentation

NTV2Line21AttributePermutations()

NTV2Line21AttributePermutations::NTV2Line21AttributePermutations

(

)

My constructor.

Member Function Documentation

GetIndexFromAttribute()

size_t NTV2Line21AttributePermutations::GetIndexFromAttribute

(

const NTV2Line21Attributes &

inAttribute

)

const

Returns the permutation index that corresponds to the given attribute.

Parameters

[in]

inAttribute

The display attribute of interest.

Returns

The permutation index that corresponds to the given attribute.

GetPermutation()

const NTV2Line21Attrs& NTV2Line21AttributePermutations::GetPermutation

(

const size_t

inIndex

)

const

Returns a const reference to the attribute that corresponds to the given permutation index.

Parameters

[in]

inIndex

Specifies the permutation index. Must be less than my size().

Returns

The attribute that corresponds to the given permutation index.

operator[]()

const NTV2Line21Attrs& NTV2Line21AttributePermutations::operator[] ( const size_t  inIndex ) const

inline

Returns a const reference to the attribute that corresponds to the given permutation index.

Parameters

[in]

inIndex

Specifies the permutation index. Must be less than my size().

Returns

The attribute that corresponds to the given permutation index.

Definition at line 915 of file ntv2caption608types.h.

size()

ULWord NTV2Line21AttributePermutations::size ( void  ) const

inline

Returns my size (the total number of attribute permutations that I have).

Returns

The total number of attribute permutations that I have.

Definition at line 901 of file ntv2caption608types.h.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajacc/includes/ntv2caption608types.h