Functions for Topography
Function List
- InterfaceTopoInit
- Initialise topography structure of Interface
- InterfaceTopoAlloc
- Memory allocation for topography structure of Interface
- InterfaceTopoCopy
- Copy topography structure of Interface
- InterfaceTopoFree
- Free topography structure of Interface
- InterfaceTopoWriteASCII
- Write topography database to ASCII *.asc file in grid format.
- InterfaceTopoWriteASCIILine
- Write topography database to ASCII *.asc file in line format.
Function Details
- void InterfaceTopoInit(TOPOGRAPHY * topo)
Description
Initialise topography structure of InterfaceParameters
- TOPOGRAPHY * topo
- Topography data.
Returns None
- int InterfaceTopoAlloc(int nbrColumns, int nbrLines, TOPOGRAPHY * topo)
Description
Memory allocation for topography structure of InterfaceParameters
- int nbrColumns
- Number of columns.
- int nbrLines
- Number of lines.
- TOPOGRAPHY * topo
- Topography data structure.
Returns An integer: 0 = success, failure otherwise.
- int InterfaceTopoCopy(TOPOGRAPHY * copy, const TOPOGRAPHY * source)
Description
Copy topography structure of InterfaceParameters
- TOPOGRAPHY * copy
- Copy of topography data.
- const TOPOGRAPHY * source
- Source topography data.
Returns An integer: 0 = success, failure otherwise.
- void InterfaceTopoFree(TOPOGRAPHY * topo)
Description
Free topography structure of InterfaceParameters
- TOPOGRAPHY * topo
- Topography data to be freed.
Returns None
- int InterfaceTopoWriteASCII(TOPOGRAPHY * topo, const char * databaseName)
Description
Write topography database to ASCII *.asc file in grid format.Parameters
- TOPOGRAPHY * topo
- Non-null, the topography structure.
- const char * databaseName
- Filepath for output file.
Returns An int - 0 on success, !0 on failure.
- int InterfaceTopoWriteASCIILine(TOPOGRAPHY * topo, const char * databaseName)
Description
Write topography database to ASCII *.asc file in line format.Parameters
- TOPOGRAPHY * topo
- Non-null, the topography structure.
- const char * databaseName
- Filepath for output file.
Returns An int - 0 on success, !0 on failure.
The documentation was generated from the following file:
- source/Public/Interface/Topo.h