cee::vtfx::SetBlock Class Reference

A block for storing sets of elements or nodes. More...

Public Types

enum  ItemType { ELEMENT, UNKNOWN_ITEM_TYPE }
 Item types for SetBlock. More...
 
- Public Types inherited from cee::vtfx::Block
enum  BlockType {
  NODES, ELEMENTS, GEOMETRY, GEOMETRYINFO,
  RESULT, RESULTVALUES, TRANSFORMATIONRESULT, TRANSFORMATIONRESULTVALUES,
  STATEINFO, SET, ILLEGAL
}
 Global block type constants used by Ceetron Export. Normally users do not need these, except for some methods of TransformationResultValuesBlock. More...
 

Public Member Functions

 SetBlock (int blockId, bool itemsByIds)
 Constructs an empty set block. More...
 
int setId () const
 Returns the set id. More...
 
void setSetId (int setId)
 Sets the set id. More...
 
Str setName () const
 Returns the name of the set. More...
 
void setSetName (const Str &name)
 Sets the name to name. More...
 
ItemType itemType () const
 Returns the item type of this set. More...
 
void setItemType (ItemType itemType)
 Sets the item type. More...
 
size_t totalItemCount () const
 Returns the total number of items found in all groups in this set. More...
 
int itemGroupCount () const
 Returns the number of groups in this set. More...
 
SetItemGroupitemGroup (size_t index)
 Returns the groups at index. More...
 
const SetItemGroupitemGroup (size_t index) const
 Returns the groups at index. More...
 
void addItemGroup (SetItemGroup *itemGroup)
 Adds an item group to this set. More...
 
void addItem (int itemIdOrIndex, int itemGroupId)
 Adds an item. More...
 
void addItems (const int *itemIndicesOrIds, size_t itemCount, int itemGroupId)
 Adds items from given array itemIndicesOrIds. More...
 
- Public Member Functions inherited from cee::vtfx::Block
 Block (int blockId)
 Constructs an empty block with given block id. More...
 
int blockId () const
 Returns the block id. More...
 
BlockType blockType () const
 Returns the block type. More...
 
virtual bool checkValidity () const
 Does a weak check for valid block contents just before the block is being written. More...
 
- Public Member Functions inherited from cee::RefCountedObject
void addRef () const
 Increments the reference count for this object. More...
 
void release () const
 Decrements the reference count for this object. More...
 
int refCount () const
 Returns the reference count for this object. More...
 
void setRefCountZero () const
 Sets the ref count to zero, but DOES NOT delete the object. More...
 
Inheritance diagram for cee::vtfx::SetBlock:
cee::vtfx::Block cee::RefCountedObject

Detailed Description

A block for storing sets of elements or nodes.

Currently only ELEMENTS are supported

Member Enumeration Documentation

Item types for SetBlock.

Enumerator
ELEMENT 

Element item type.

UNKNOWN_ITEM_TYPE 

Unknown item type.

Constructor & Destructor Documentation

cee::vtfx::SetBlock::SetBlock ( int  blockId,
bool  itemsByIds 
)

Constructs an empty set block.

blockId must be >= 0 and unique for all node blocks within a database. itemsByIds specifies if set items will be supplied by their or not.

Member Function Documentation

void cee::vtfx::SetBlock::addItem ( int  itemIdOrIndex,
int  itemGroupId 
)

Adds an item.

void cee::vtfx::SetBlock::addItemGroup ( SetItemGroup itemGroup)

Adds an item group to this set.

void cee::vtfx::SetBlock::addItems ( const int *  itemIndicesOrIds,
size_t  itemCount,
int  itemGroupId 
)

Adds items from given array itemIndicesOrIds.

SetItemGroup * cee::vtfx::SetBlock::itemGroup ( size_t  index)

Returns the groups at index.

const SetItemGroup * cee::vtfx::SetBlock::itemGroup ( size_t  index) const

Returns the groups at index.

int cee::vtfx::SetBlock::itemGroupCount ( ) const

Returns the number of groups in this set.

SetBlock::ItemType cee::vtfx::SetBlock::itemType ( ) const

Returns the item type of this set.

int cee::vtfx::SetBlock::setId ( ) const

Returns the set id.

void cee::vtfx::SetBlock::setItemType ( ItemType  itemType)

Sets the item type.

Str cee::vtfx::SetBlock::setName ( ) const

Returns the name of the set.

void cee::vtfx::SetBlock::setSetId ( int  setId)

Sets the set id.

void cee::vtfx::SetBlock::setSetName ( const Str name)

Sets the name to name.

size_t cee::vtfx::SetBlock::totalItemCount ( ) const

Returns the total number of items found in all groups in this set.