Itasca C++ Interface
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | List of all members
zone::IAttachPoint Class Referenceabstract

Interface to a attachment object. More...

#include <iattach.h>

Public Types

enum class  ClassType { Gp = 1 , Face }
 The specific types of attach conditions that can be derived from an attach point. More...
 
using IFacePair = IZone::IFacePair
 

Public Member Functions

virtual const IThinggetIThing () const =0
 returns a const IThing pointer
 
virtual IThinggetIThing ()=0
 returns a IThing pointer
 
virtual const IAttachPointgetNext () const =0
 
virtual DVect3 getLocation () const =0
 returns the attachment point DVect3 location
 
virtual DVect getDVectLocation () const =0
 returns the attachment point DVect location
 
virtual bool isNull () const =0
 returns true if the Gridpoint was 'nulled'
 
virtual const IGpgetFollower () const =0
 returns a const pointer to the follower gridpoint.
 
virtual ClassType classType () const =0
 Returns the type of attach this class represents. gp-gp, gp-edge, or gp-face.
 
virtual const IGpgetLeader1 () const =0
 
virtual const IGpgetLeader2 () const =0
 
virtual IFacePair getFace () const =0
 
virtual double getWeight () const =0
 
virtual void setWeight (double w)=0
 sets the weight for a gridpoint to edge attachments

 
virtual const IFaceWeightgetFaceWeight () const =0
 
virtual IFaceWeightgetFaceWeight ()=0
 Returns a IFaceWeight pointer to a gridpoint to face attachment
 
virtual bool getSnap () const =0
 returns true if gridpoints are "snapped"
 
virtual void setSnap (bool s)=0
 set condition to "snap" gridpoints
 

Static Public Attributes

static const TType type_ = 0x4c815a1d
 The type identification number for this class, for use in convert_cast() and convert_getcast().
 

Detailed Description

Interface to a attachment object.

Attachments can occur between 2 grid points, a grid pont and an edge or a gridpoint and a face.

Member Enumeration Documentation

◆ ClassType

enum class zone::IAttachPoint::ClassType
strong

The specific types of attach conditions that can be derived from an attach point.

Enumerator
Gp 

Direct Gp to Gp attachment.

Face 

Gp attached to a face of a zone.

Member Function Documentation

◆ getFace()

virtual IFacePair zone::IAttachPoint::getFace ( ) const
pure virtual

Returns 0 for a gridpoint to gridpoint attachment
Returns 0 for a gridpoint to edge attachment
Returns a const pointer to a IFace object for a gridpoint to face attachment

◆ getFaceWeight()

virtual const IFaceWeight * zone::IAttachPoint::getFaceWeight ( ) const
pure virtual

Returns 0 for a gridpoint to gridpoint attachment
Returns 0 for a gridpoint to edge attachment
Returns a IFaceWeight const pointer to a gridpoint to face attachment

◆ getLeader1()

virtual const IGp * zone::IAttachPoint::getLeader1 ( ) const
pure virtual

Returns a const pointer to the leader gridpoint in a gridpoint to gridpoint attachment
Returns a const pointer to one of the grid points of a gridpoint to edge attachment
Returns 0 for a gridpoint to face attachment

◆ getLeader2()

virtual const IGp * zone::IAttachPoint::getLeader2 ( ) const
pure virtual

Returns 0 for a gridpoint to gridpoint attachment
Returns a const pointer to the other gridpoint of a gridpoint to edge attachment
Returns 0 for a gridpoint to face attachment

◆ getNext()

virtual const IAttachPoint * zone::IAttachPoint::getNext ( ) const
pure virtual

returns a const pointer to the next attachement object, IAttachPoint, in the global attachment list, or 0 to indicate the end of the list.
See IAttachList::getFirst().

◆ getWeight()

virtual double zone::IAttachPoint::getWeight ( ) const
pure virtual

Returns 0.0 for a gridpoint to gridpoint attachment
Returns the weight for a gridpoint to edge attachment
Returns 0.0 for a gridpoint to face attachment


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