CoreRules::ICharacterIndex Class Reference

#include <ICharacterIndex.h>

Public Types
using	record_type = ICharacterMiniOb

Public Member Functions
virtual	~ICharacterIndex ()=default
virtual int	GetSize () const =0
virtual ICharacterMiniOb *	GetAt (int index)=0
virtual ICharacterMiniOb *	Find (const char *name)=0
virtual ICharacterMiniOb *	Load (const char *name)=0
virtual bool	Add (ICharacterMiniOb *obj)=0
virtual bool	Remove (int index)=0
virtual bool	Remove (const char *name)=0
virtual bool	IsDirty () const =0
virtual int	GetExtensionCount () const =0
	Number of CCharacter_Extension instances live in memory across the store + the loaded heavy records.
virtual long	GetExtensionCharacterId (int index) const =0
	The m_character_id of the i-th extension (any order).
virtual ICharacterMiniOb *	FindByCharacterId (long character_id)=0
	Find the MiniOb whose extension carries this id.

Member Typedef Documentation

record_type

using CoreRules::ICharacterIndex::record_type = ICharacterMiniOb

Constructor & Destructor Documentation

~ICharacterIndex()

virtual CoreRules::ICharacterIndex::~ICharacterIndex ( )

virtualdefault

Member Function Documentation

Add()

virtual bool CoreRules::ICharacterIndex::Add ( ICharacterMiniOb * obj )

pure virtual

Find()

virtual ICharacterMiniOb * CoreRules::ICharacterIndex::Find ( const char * name )

pure virtual

FindByCharacterId()

virtual ICharacterMiniOb * CoreRules::ICharacterIndex::FindByCharacterId ( long character_id )

pure virtual

Find the MiniOb whose extension carries this id.

Returns

The MiniOb if a character with that id is in the roster, or nullptr if no character claims this id (= orphan extension).

GetAt()

virtual ICharacterMiniOb * CoreRules::ICharacterIndex::GetAt ( int index )

pure virtual

GetExtensionCharacterId()

virtual long CoreRules::ICharacterIndex::GetExtensionCharacterId ( int index ) const

pure virtual

The m_character_id of the i-th extension (any order).

Pair with FindByCharacterId to detect orphans.

GetExtensionCount()

virtual int CoreRules::ICharacterIndex::GetExtensionCount ( ) const

pure virtual

Number of CCharacter_Extension instances live in memory across the store + the loaded heavy records.

Includes orphans (extensions whose character_id has no MiniOb).

GetSize()

virtual int CoreRules::ICharacterIndex::GetSize ( ) const

pure virtual

IsDirty()

virtual bool CoreRules::ICharacterIndex::IsDirty ( ) const

pure virtual

Load()

virtual ICharacterMiniOb * CoreRules::ICharacterIndex::Load ( const char * name )

pure virtual

Remove() [1/2]

virtual bool CoreRules::ICharacterIndex::Remove ( const char * name )

pure virtual

Remove() [2/2]

virtual bool CoreRules::ICharacterIndex::Remove ( int index )

pure virtual

---

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

• CoreRules/include/CoreRules/ICharacterIndex.h