Global RDII Methods

Global RDII methods. More...

Collaboration diagram for Global RDII Methods:

Functions
int	rdii_readRdiiInflow (char *tok[], int ntoks)
	Reads properties of an RDII inflow from a line of input.
void	rdii_deleteRdiiInflow (int nodeIndex)
	Deletes RDII inflow data for a node.
void	rdii_initUnitHyd (int unitHydIndex)
	Initializes properties of a unit hydrograph group.
int	rdii_readUnitHydParams (char *tok[], int ntoks)
	Reads parameters of an RDII unit hydrograph from a line of input.
void	rdii_openRdii (void)
	Opens an exisiting RDII interface file or creates a new one.
void	rdii_closeRdii (void)
	Closes the RDII interface file.
int	rdii_getNumRdiiFlows (DateTime aDate)
	Finds number of RDII inflows at a specified date.
void	rdii_getRdiiFlow (int index, int *nodeIndex, double *q)
	Finds index and current RDII inflow for an RDII node.

Detailed Description

Global RDII methods.

Function Documentation

rdii_closeRdii()

void rdii_closeRdii

(

void

)

Closes the RDII interface file.

Here is the caller graph for this function:

rdii_deleteRdiiInflow()

void rdii_deleteRdiiInflow

(

int

nodeIndex

)

Deletes RDII inflow data for a node.

Parameters

[in]

nodeIndex

Node index

Deletes RDII inflow data for a node.

Implementation arguments

• nodeIndex (in): Valid node index whose rdiiInflow is exclusively owned.

Postcondition

Frees the object when present and sets the node pointer to NULL; repeated calls on the same cleaned node do nothing.

rdii_getNumRdiiFlows()

int rdii_getNumRdiiFlows

(

DateTime

aDate

)

Finds number of RDII inflows at a specified date.

Parameters

[in]

aDate

Current date/time

Returns

Returns 0 if no RDII flow or number of nodes with RDII inflows

Implementation arguments

• aDate (in): Current date/time

Returns

Returns 0 if no RDII flow or number of nodes with RDII inflows

rdii_getRdiiFlow()

void rdii_getRdiiFlow	(	int	index,
		int *	nodeIndex,
		double *	q )

Finds index and current RDII inflow for an RDII node.

Parameters

[in]	index	RDII node index
[out]	nodeIndex	Node index
[out]	q	RDII flow rate

Implementation arguments

• index (in): RDII node index

• nodeIndex (out): Node index
• q (out): RDII flow rate

rdii_initUnitHyd()

void rdii_initUnitHyd

(

int

unitHydIndex

)

Initializes properties of a unit hydrograph group.

Parameters

[in]

unitHydIndex

Unit hydrograph group index

Implementation arguments

• unitHydIndex (in): Unit hydrograph group index

rdii_openRdii()

void rdii_openRdii

(

void

)

Opens an exisiting RDII interface file or creates a new one.

Here is the call graph for this function:

Here is the caller graph for this function:

rdii_readRdiiInflow()

int rdii_readRdiiInflow	(	char *	tok[],
		int	ntoks )

Reads properties of an RDII inflow from a line of input.

Parameters

[in]	tok	Array of string tokens
[in]	ntoks	Number of tokens

Returns

Error code

Implementation arguments

• tok (borrowed/value): Array of string tokens.
• ntoks (in): Number of tokens.

Returns

An error code.

Here is the call graph for this function:

rdii_readUnitHydParams()

int rdii_readUnitHydParams	(	char *	tok[],
		int	ntoks )

Reads parameters of an RDII unit hydrograph from a line of input.

Parameters

[in]	tok	Array of string tokens
[in]	ntoks	Number of tokens

Returns

Error code

Implementation arguments

• tok (borrowed/value): Array of string tokens.
• ntoks (in): Number of tokens.

Returns

An error code.

Here is the call graph for this function: