A chunk's iterator.
More...
#include <ChunkIt.h>
◆ anonymous enum
Enumerator |
---|
InvalidSubjectIndex | Invalid subject index.
|
◆ FChunkIt() [1/2]
Initialize the chunk iterator.
◆ FChunkIt() [2/2]
FChunkIt::FChunkIt |
( |
const FChunkIt & |
Iterator | ) |
|
|
inline |
Initialize the chunk iterator as a copy of another iterator.
- Note
- Locks the chunk appropriately, if it's available in the original.
◆ ~FChunkIt()
Destroy the chunk iterator.
- Note
- Unlocks the chunk, if it has been locked.
◆ Advance()
EApparatusStatus FChunkIt::Advance |
( |
| ) |
|
|
inline |
Move iterator to the next place (if available).
- Returns
- The status of the operation.
◆ FastGetTraitAt()
EApparatusStatus FChunkIt::FastGetTraitAt |
( |
const int32 |
TraitIndex, |
|
|
void *const |
OutTraitData, |
|
|
const bool |
bTraitDataInitialized |
|
) |
| |
|
inline |
Get a trait at index from a currently iterated subject fast.
Gets a trait from a currently iterated subject by its index, relative to the current chunk-locking filter's traitmark. Fast version runtime checks minimized.
- Parameters
-
TraitIndex | The index of the trait to get. |
OutTraitData | The trait data receiver. |
bTraitDataInitialized | Is the OutTraitData buffer actually initialized? |
- Returns
- The status of the operation.
◆ GetChunk()
UChunk* FChunkIt::GetChunk |
( |
| ) |
const |
|
inline |
Get the chunk of the iterator.
When an iterator comes to an end of a chunk it still persists this state value, unless cleared.
◆ GetFingerprint()
Get the subject fingerprint from the chunk iterator.
Gets the fingerprint of the subject that is currently pointed by the chunk iterator.
- Returns
- The fingerprint of the current subject.
◆ GetSubject() [1/2]
Get a subject from the chunk iterator.
Get a subject that is currently pointed by the chunk iterator.
- Returns
- The subject handle of the current iteration.
◆ GetSubject() [2/2]
EApparatusStatus FChunkIt::GetSubject |
( |
struct FSubjectHandle & |
Subject | ) |
const |
|
inline |
Get a subject from the chunk iterator.
Get a subject that is currently pointed by the chunk iterator.
- Parameters
-
Subject | The subject handle receiver. |
- Returns
- The status of the operation.
◆ GetTraitAt()
EApparatusStatus FChunkIt::GetTraitAt |
( |
const int32 |
TraitIndex, |
|
|
void *const |
OutTraitData, |
|
|
const bool |
bTraitDataInitialized = true |
|
) |
| |
|
inline |
Get a trait at index from a currently iterated subject.
Gets a trait from a currently iterated subject by its index, relative to the current chunk-locking filter's traitmark.
- Parameters
-
TraitIndex | The index of the trait to get. |
OutTraitData | The trait data receiver. |
bTraitDataInitialized | Is the OutTraitData buffer actually initialized? |
- Returns
- The status of the operation.
◆ HasLocked()
bool FChunkIt::HasLocked |
( |
| ) |
const |
|
inline |
Check whether the iterator has locked its chunk.
◆ IsViable()
bool FChunkIt::IsViable |
( |
| ) |
const |
|
inline |
Check if the iterator is valid and is not at the end of the chunk.
- Returns
- The state of examination.
◆ operator bool()
FChunkIt::operator bool |
( |
| ) |
const |
|
inline |
Check if the iterator is valid and is not at the end of the chunk.
- Returns
- The state of examination.
◆ operator=()
Set iterator equal to another iterator.
◆ Reset()
Clear the iterator to a null-state.
◆ UChunk
The documentation for this struct was generated from the following files:
- D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/ChunkIt.h
- D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/Chunk.h
- D:/ApparatusMark/Plugins/Apparatus/Source/ApparatusRuntime/Public/Machine.h