include/ecrt.h
changeset 1891 dd7879e2e72b
parent 1861 5b285964b4e7
child 1913 cbef34ba142b
equal deleted inserted replaced
1890:b64e3791075d 1891:dd7879e2e72b
  1126         size_t size /**< Data size to reserve. */
  1126         size_t size /**< Data size to reserve. */
  1127         );
  1127         );
  1128 
  1128 
  1129 /** Outputs the state of the slave configuration.
  1129 /** Outputs the state of the slave configuration.
  1130  *
  1130  *
  1131  * Stores the state information in the given \a state structure.
  1131  * Stores the state information in the given \a state structure. The state
       
  1132  * information is updated by the master state machine, so it may take a few
       
  1133  * cycles, until it changes.
       
  1134  *
       
  1135  * \attention If the state of process data exchange shall be monitored in
       
  1136  * realtime, ecrt_domain_state() should be used.
  1132  */
  1137  */
  1133 void ecrt_slave_config_state(
  1138 void ecrt_slave_config_state(
  1134         const ec_slave_config_t *sc, /**< Slave configuration */
  1139         const ec_slave_config_t *sc, /**< Slave configuration */
  1135         ec_slave_config_state_t *state /**< State object to write to. */
  1140         ec_slave_config_state_t *state /**< State object to write to. */
  1136         );
  1141         );
  1242         );
  1247         );
  1243 
  1248 
  1244 /** Reads the state of a domain.
  1249 /** Reads the state of a domain.
  1245  *
  1250  *
  1246  * Stores the domain state in the given \a state structure.
  1251  * Stores the domain state in the given \a state structure.
       
  1252  *
       
  1253  * Using this method, the process data exchange can be monitored in realtime.
  1247  */
  1254  */
  1248 void ecrt_domain_state(
  1255 void ecrt_domain_state(
  1249         const ec_domain_t *domain, /**< Domain. */
  1256         const ec_domain_t *domain, /**< Domain. */
  1250         ec_domain_state_t *state /**< Pointer to a state object to store the
  1257         ec_domain_state_t *state /**< Pointer to a state object to store the
  1251                                    information. */
  1258                                    information. */