programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions
cs_c_bindings::time_moment_field_id Interface Reference

Get field id associated with a given moment. More...

Collaboration diagram for cs_c_bindings::time_moment_field_id:
Collaboration graph

Public Member Functions

integer(c_int) function time_moment_field_id (m_num)
 

Detailed Description

Get field id associated with a given moment.

For moments not defined by the user, but defined automatically so as to allow computation of higher order moments (i.e. variances), no field is associated, so the returned value is -1.

Parameters
[in]m_nummoment number (based on moment creation order, 1 to n numbering)
Returns
f_id associated field id, or -1

Constructor & Destructor Documentation

integer(c_int) function time_moment_field_id ( integer(c_int)  m_num)

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