Itasca C++ Interface
Loading...
Searching...
No Matches
itascaxd::IUDTensorList Class Referenceabstract
Kernel interface specification

Interface for the list of all IUDTensor (user defined tensor). More...

#include <iudtensorlist.h>

Inheritance diagram for itascaxd::IUDTensorList:
itascaxd::IUDTypeList< IUDTensor >

Public Member Functions

IThing * getIThing () override=0
 returns a IThing pointer
const IThing * getIThing () const override=0
 returns a const IThing pointer
bool importFromFile (const string &filename, const IGroupID &group) override=0
 Imports objects of type T from the file /a filename. All objects created are assigned a group of /a group in slot /a slot (if specified).
bool exportToFile (const string &filename, bool binary, const IRange *filter=0, const string &comment={}) override=0
Public Member Functions inherited from itascaxd::IUDTypeList< IUDTensor >
virtual IContainer * getIContainer ()=0
 Returns a pointer to the container class representing a list of user defined objects.
virtual const IUDTensor * getFirst () const=0
 Returns a const pointer to the first T in the list. Use T::getNext() to iterate through the entire list.
virtual const IUDTensor * lookupWithID (uint64 ul) const=0
 Find a const pointer to the T object with ID ul, or 0 if no match is found.
virtual IUDTensor * create ()=0
 Creates a new T with default values.
virtual uint32 getExtraNotice () const=0
 Returns the NoticeManager Code for extra variables changing.
virtual uint32 getGroupNotice () const=0
 Returns the NoticeManager Code for group assignments changing.
virtual uint32 getPositionNotice () const=0
 Returns the NoticeManager Code for position of object changing.
virtual uint32 getValueNotice () const=0
 Returns the NoticeManager Code for object values changing.
virtual uint32 getHideNotice () const=0
 Returns the NoticeManager Code for hide status changing.
virtual uint32 getSelectNotice () const=0
 Returns the NoticeManager Code for select status changing.
virtual TType getType () const=0
 Returns the type indicator of the objects it contains.
virtual string getLabel () const=0
 Returns a lable indicating the type of object it contains.
virtual IUDTensor * findNear (const DVect &pos, const double &rad=limits< double >::max())=0
 Returns the object whose position is closest to /a pos.
virtual void erase (IUDTensor *pnt)=0
 Removes the object /a pnt, which is assumed to be in the container. /a pnt is destroyed.

Additional Inherited Members

Public Types inherited from itascaxd::IUDTypeList< IUDTensor >
typedef IUDTensor ivalue_type
 The type T that this list contains.

Detailed Description

Interface for the list of all IUDTensor (user defined tensor).

Member Function Documentation

◆ exportToFile()

bool itascaxd::IUDTensorList::exportToFile ( const string & filename,
bool binary,
const IRange * filter = 0,
const string & comment = {} )
overridepure virtual

Exports all objects to the file /a filename. /a binary indicates binary format, text is used otherwise. /a filter (if given) is used to filter which objects are exported. /a comment is place at the start of text output.

Implements itascaxd::IUDTypeList< IUDTensor >.

◆ getIThing()

IThing * itascaxd::IUDTensorList::getIThing ( )
overridepure virtual

returns a IThing pointer

Implements itascaxd::IUDTypeList< IUDTensor >.

◆ importFromFile()

bool itascaxd::IUDTensorList::importFromFile ( const string & filename,
const IGroupID & group )
overridepure virtual

Imports objects of type T from the file /a filename. All objects created are assigned a group of /a group in slot /a slot (if specified).

Implements itascaxd::IUDTypeList< IUDTensor >.

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