Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATHvacDesignUseItf Interface CATIHvaFlexibleDuctReference

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIHvaFlexibleDuctReference

Method Index

o GetAlgorithmMode(CATFlexibleDuctAlgorithmMode&): Gets the algorithm mode of flexible Duct.
o GetBendRadius(double&): Gets the bend radius of flexible Duct.
o GetBuildMode(CATFlexibleDuctBuildMode&): Gets the build mode of flexible Duct.
o GetCoordinateofNode(CATLISTP(CATMathPoint)&,CATBaseUnknown*): Gets the coordinate of Node.
o GetEnds(CATIHvaHvacPortRef*&,CATIHvaHvacPortRef*&): Gets the two end of Flexible Duct.
o GetFlexibleInformation(int&,int&,double&,double&): Gets the Flexible parameters in term of Accuracy, Flexibility, Temperature and pressure.
o GetLength(double&): Gets the length of flexible Duct.
o GetNumberOfNode(int&): Gets the number of node in Duct.
o GetSlack(double&): Gets the slack of flexible Duct.

o CATFlexibleDuctAlgorithmMode: Flexible Duct Algorithm Mode.
o CATFlexibleDuctBuildMode: Flexible Duct Build Mode.

Methods

o GetAlgorithmMode

public virtual GetAlgorithmMode( oeAlgorithmMode)

Gets the algorithm mode of flexible Duct.

Parameters:

oeAlgorithmMode: This method returns the mode “Standard” or “Flexible” to build the Flexible Duct. “Flexible” mode is the realistic algorithm that use the physical property to build the shape of Duct. Licence “FLX” is request to have this mode. [out, CATFlexibleDuctAlgorithmMode]

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: Failed to find the Flexible Curve inside the Flexible Duct
E_FAIL: operation failed

o GetBendRadius

public virtual GetBendRadius( oBendRadius)

Gets the bend radius of flexible Duct.

Parameters:

oBendRadius: Value of the bend radius. [out, Double]

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: Failed to find the Flexible Curve inside the Flexible Duct
E_FAIL: operation failed

o GetBuildMode

public virtual GetBuildMode( oeBuildMode)

Gets the build mode of flexible Duct.

Parameters:

oeBuildMode: This method returns the build mode of Flexible Duct that can be Slack, Bend or Length mode. [out, CATFlexibleDuctBuildMode]

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: Failed to find the Flexible Curve inside the Flexible Duct
E_FAIL: operation failed

o GetCoordinateofNode

public virtual GetCoordinateofNode(		`oListPofCoordinateNode`,
		`ipIUnkOccToFindRoot`	`= NULL` )

Gets the coordinate of Node.

Parameters:

oListPofCoordinateNode: (out, caller needs to delete the elements) This method returns a list of CATMathPoint pointers that is the coordinate of Node in context of Root product of the session in milimeters (mm). Root product will be found using the input ipIUnkOccToFindRoot. The size of this list is equal to oNumberOfNode from GetNumberOfNode. [out, CATLISTP(CATMathPoint)].
ipIUnkOccToFindRoot: Occurrence used to find the Root Product in which context the coordinates of the nodes will be given out. If this input is NULL, then co-ordinates of the node will be in the context of the Reference of Duct. [in, CATBaseUnknown].

Returns:

An HRESULT value.
Legal values:

E_INVALIDARG: Input is invalid - output list is not empty
S_OK: operation is successful, even if there is Zero node to define this Duct
E_FAIL: operation failed

o GetEnds

public virtual GetEnds(		`opIEndDuctOne`,
		`opIEndDuctTwo`)

Gets the two end of Flexible Duct.

Parameters:

opIEndDuctOne: [out, CATIHvaHvacPortRef #Release]. Duct end one.
opIEndDuctTwo: [out, CATIHvaHvacPortRef #Release]. Duct end two.

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_FAIL: operation failed

o GetFlexibleInformation

public virtual GetFlexibleInformation(		`oAccuracy`,
		`oFlexibility`,
		`oTemperature`,
		`oPressure`)

Gets the Flexible parameters in term of Accuracy, Flexibility, Temperature and pressure.

Parameters:

oAccuracy: Value of the Accuracy between 1 to 10 [out, integer] Balance between the Performance (1) and Accurary (10)
oFlexibility: Value of the Flexibility between 1 to 6 [out, integer] Default material: from very stiff (1) to very flexible (6), if no material object is attach to flexible Duct
oTemperature: Value of temperature in Kelvin [out, double]
oPressure: Value of pressure in N/m2 [out, double]

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_FAIL: operation failed

o GetLength

public virtual GetLength( oLength)

Gets the length of flexible Duct.

Parameters:

oLength: Value of the actual total geometric length of Flexible Duct [out, double] whatever may be the build mode of the Flexible Duct. Note that this value might be different than the value set as input length for 'Length Build Mode' of the Flexible Duct.

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: Failed to find the Flexible Curve inside the Flexible Duct
E_FAIL: operation failed

o GetNumberOfNode

public virtual GetNumberOfNode( oNumberOfNode)

Gets the number of node in Duct.

Parameters:

oNumberOfNode: Give the number of node that defines the flexible Duct curve. Include: Directional point, passing point (which is or not an external reference), point which is External reference that come from Support or Hvac Part with Hole Port. The point of 1 point Part Port or 2 points Part port is also included. [out, Integer].

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful, even if there is Zero node to define this Duct
E_FAIL: operation failed

o GetSlack

public virtual GetSlack( oSlackValue)

Gets the slack of flexible Duct.

Parameters:

oSlackValue: Value of the Slack [out, double].

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: Failed to find the Flexible Curve inside the Flexible Duct
E_FAIL: operation failed

Enumerated Types

o CATFlexibleDuctAlgorithmMode

enum CATFlexibleDuctAlgorithmMode {
  CatStandard,
  CatFlexible
}

Flexible Duct Algorithm Mode.

Parameters:

CatStandard: Standard mode computation.
CatFlexible: Flexible mode computation.

o CATFlexibleDuctBuildMode

enum CATFlexibleDuctBuildMode {
  CATDuctSlack,
  CATDuctBend,
  CATDuctLength
}

Flexible Duct Build Mode.

Parameters:

CATDuctSlack: Slack build mode.
CATDuctBend: Bend build mode.
CATDuctLength: Length build mode.

This object is included in the file: CATIHvaFlexibleDuctReference.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf

CATHvacDesignUseItf Interface CATIHvaFlexibleDuctReference

Method Index

Enumerated Type Index

Methods

Enumerated Types