block::IFlowPlaneThing Class Reference

Public Member Functions
virtual const itasca::IThing *	getIThing () const =0
	Returns a const IThing pointer.
virtual itasca::IThing *	getIThing ()=0
	Returns a IThing pointer.
virtual FInt	getFortranOffset () const =0
	Return flow plane fortran offset.
virtual double	getArea () const =0
	Return the plane area.
virtual const IContactThing *	getContact () const =0
	Return the contact associated with the flow plane.
virtual uint64	getContactID () const =0
	Return the id of the contact associated with the flow plane.
virtual DVect3	getLocalX () const =0
	Return local coordinate system x-axis in global system.
virtual DVect3	getLocalY () const =0
	Return local coordinate system y-axis in global system.
virtual FArray< const IFlowZoneThing * >	getFlowZones () const =0
	Return flow zones associated with the flow plane.
virtual FArray< const IFlowPlaneVertexThing * >	getFlowPlaneVertices () const =0
	Return flow vertices associated with the flow plane.
virtual uint32	getPropertyIndex (const string &sc) const =0
virtual string	getProperties () const =0
	Return property names as a single string with names separated by commas.
virtual string	getPropertyName (uint32 index) const =0
virtual StringList	getPropertyNames () const =0
	returns a list of all the valid properties assigned to this flowplane
virtual base::Property	getProperty (uint32 index) const =0
virtual base::Property	getProperty (const string &propName) const =0
virtual bool	setProperty (string sprop, const base::Property value)=0
	Set property corresponding to sprop equal to value.
virtual bool	setProperty (uint32 index, const base::Property value)=0
	Set property corresponding to index equal to value.
virtual DVect3	getLocation () const =0
	Return the flow plane location.

Static Public Attributes
static const TType	type_ = 0x52d800d8
	type used in IThing typing system

Member Function Documentation

getProperty() [1/2]

virtual base::Property block::IFlowPlaneThing::getProperty ( const string & propName ) const

pure virtual

Returns value of flowplane property corresponding to propName
Returns 0 if propName is not recognized

getProperty() [2/2]

virtual base::Property block::IFlowPlaneThing::getProperty ( uint32 index ) const

pure virtual

Returns value of flowplane property corresponding to index
Returns 0 if index is not valid

getPropertyIndex()

virtual uint32 block::IFlowPlaneThing::getPropertyIndex ( const string & sc ) const

pure virtual

Given a property name, returns the index of the property assigned to this flowplane.

Note

Base 1, returns 0 if name is not found.

getPropertyName()

virtual string block::IFlowPlaneThing::getPropertyName ( uint32 index ) const

pure virtual

Given an index, returns the name of the property assigned to this flowplane.

Note

Base 1, returns string() if index is less then 1 or greater than the number of properties.

---

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

• C:/Source/itasca-suite/3dec/block/interface/iflowplanething.h