Itasca C++ Interface
Loading...
Searching...
No Matches
itascaxd::IPieceMechanicalData Class Referenceabstract

Public Member Functions

virtual const IThing * getIThing () const =0
 Return the IThing interface.
virtual IThing * getIThing ()=0
virtual TType getType () const =0
virtual bool addGroup (const IGroupID &id)=0
virtual bool removeGroup (const IGroupID &id)=0
virtual uint32 isInGroup (const FArray< IGroupID > &ids, TType type=0, bool only=false) const =0
virtual const IGroup * getGroup (const ISlotID &id=ISlotID((uint32) 0)) const =0
virtual string getGroupName (const ISlotID &id=ISlotID()) const =0
virtual uint32 getGroupList (FArray< IGroupID > *list) const =0
 Return all groups and all slots assigned to the object in a list.
virtual void copyGroups (const IThing *t)=0
 Copies group data from one IThing to this, all original group data is lost.
virtual std::vector< uint32 > getExtraIndices () const =0
 Returns the number of extra FISH extra variables for this object.
virtual const fish::IParameter * getExtra (uint32 index) const =0
virtual void setExtra (uint32 index, const fish::IParameter &p)=0
virtual void clearExtra ()=0

Static Public Attributes

static const TType type_ = 0x50b4d54c
 The base type of an IThing.

Member Function Documentation

◆ addGroup()

virtual bool itascaxd::IPieceMechanicalData::addGroup ( const IGroupID & id)
pure virtual

Adds a group entry to this object. Returns true on success. If no slot is specified, the default slot is assumed.

◆ getExtra()

virtual const fish::IParameter * itascaxd::IPieceMechanicalData::getExtra ( uint32 index) const
pure virtual

Returns an interface to the FISH extra variables for this object. May be null if no extra variables have ever been specified.

◆ getGroup()

virtual const IGroup * itascaxd::IPieceMechanicalData::getGroup ( const ISlotID & id = ISlotID((uint32) 0)) const
pure virtual

Returns the group entry directly in this object at that slot, or null if it does not exist. The group_ and groupName_ parts of id are ignored. If not specified, the default slot is assumed.

◆ getGroupName()

virtual string itascaxd::IPieceMechanicalData::getGroupName ( const ISlotID & id = ISlotID()) const
pure virtual

Returns the group name directly in this object at that slot, or the null name if it does not exist. The group_ and groupName_ parts of id are ignored. If no slot is specified, then returns a contactenation of all groups in all slots.

◆ getIThing()

virtual IThing * itascaxd::IPieceMechanicalData::getIThing ( )
pure virtual

◆ getType()

virtual TType itascaxd::IPieceMechanicalData::getType ( ) const
pure virtual

This function returns a character string indicating the type. It may be compared directly by pointer value (fast), or a string comparison may be given. Used mostly for save/restore – to indicate the object type for polymorphic containers.

◆ isInGroup()

virtual uint32 itascaxd::IPieceMechanicalData::isInGroup ( const FArray< IGroupID > & ids,
TType type = 0,
bool only = false ) const
pure virtual

Returns true if this object is considered to belong to the group. Applied either to this object directly, or possibly to connected objects. (For example, gridpoints in FLAC3D are considered a member of a group if any zones connected to them are in that group). If slot is specified, then only checks that slot, otherwise checks all.

◆ removeGroup()

virtual bool itascaxd::IPieceMechanicalData::removeGroup ( const IGroupID & id)
pure virtual

Removes all entries matching g or name from this object, if not slot is specified. Returns true if one or more entries were removed.

◆ setExtra()

virtual void itascaxd::IPieceMechanicalData::setExtra ( uint32 index,
const fish::IParameter & p )
pure virtual

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