ODeV framework  v2
Data Structures | Functions
IEvent.h File Reference

The root class from which all event state objects shall be derived. More...

#include "systypes.h"
#include "syserror.h"
#include "systp.h"
+ Include dependency graph for IEvent.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _IEvent
 

Functions

sys_error_code_t IEventInit (IEvent *this, const IEventSrc *pSource)
 

Detailed Description

The root class from which all event state objects shall be derived.

Author
STMicroelectronics - ST-Korea - MCD Team
Version
1.2.0
Date
Apr 17, 2017

An event is an object that contains information about something that happened in the system at a given moment. An event object is constructed with a link to the EventSrc that has generated it.

Attention

© COPYRIGHT 2017 STMicroelectronics

Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

   http://www.st.com/software_license_agreement_liberty_v2

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Function Documentation

◆ IEventInit()

SYS_DEFINE_INLINE sys_error_code_t IEventInit ( IEvent this,
const IEventSrc pSource 
)
inline

Initialize an event. An is initialized when it is linked with the IEventSrc that has generated the event.

Parameters
this[IN] specifies an ::IEvent object
pSource[IN] specifies the IEventSrc object that has generated teh event.
Returns
SYS_NO_ERROR_CODE if success, an error code otherwise.