cinosmcmodule.h File Reference

The mcmodule class. More...

#include <inos_1ms.h>
#include <cinosprocessimage.h>
#include <cinosphysicalaxis.h>
#include <cinoscontrol.h>
#include <cinosserialinout.h>
#include <cinostaskex.h>
#include <cinosmcmessage.h>
#include <cinosmcjob.h>
#include <cinosmcscript.h>
#include <cinosmcdata.h>
#include <cinosmccron.h>

Include dependency graph for cinosmcmodule.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CINOSMcModuleRes
class	CINOSMcModule
class	CINOSMcModuleWaitObj
class	CINOSMcModuleWaitVar< T >

Macros
#define	INOS_MCMODULE_STEP_INST(_inst_, _msg_)
#define	INOS_MCMODULE_STEP(_msg_)   INOS_MCMODULE_STEP_INST((*this), _msg_)
#define	DF_INOS_MCMODULE_MAXCOUNT   8
#define	DF_INOS_MCMODULE_MAXAVERAGE   32
#define	DF_INOS_MCMODULE_EMGDELAY   100
#define	INOS_RESOURCE_TYPE(type, id)   ((type&0xF) + ((id&0xfff)<<4))

Typedefs
typedef char	inosResName[128]
using	TINOSMcModuleCondFunc = std::function< bool()>
	callback function that checks if a wait condition is fulfilled
using	TINOSMcModuleCondHandler = std::function< uint32()>

Functions
	IMPLEMENT_DYNAMIC_T (CINOSMcModuleWaitVar, T)

Detailed Description

The mcmodule class.

Author

Ch. Hirzel

Copyright

Copyright © 2016 Indel AG. All rights reserved.

This software is licensed on a non-exclusive basis for use on Indel products only. If the Source Code has been provided by Indel, the software may be modified or further developed, exclusively for the use on Indel's products. For evaluation purposes of the aforementioned development or modification of the software, the software may temporarily be used on third party products. Any further use of this software, its modification or development on non-Indel products is strictly prohibited.

Remarks

project         : INOS
language        : Gnu C++
system          : Power-PC

This class provides the mcmodule functionality

Macro Definition Documentation

INOS_MCMODULE_STEP_INST

#define INOS_MCMODULE_STEP_INST	(		_inst_,
			_msg_
	)

Value:

    if (!(_msg_->GetData() && (_msg_->GetData()->GetFlag()&CINOSMcDataInst::eFlgIgnoreStep)) &&\
        !_msg_->GetTrigger() &&                             \
        !IsDispatcher(_msg_->GetSender()) &&                                    \
        ((_inst_.GetMode() == CINOSMcModule::eModStep) ||                       \
        ((_inst_.GetParent()&&(_inst_.GetParent()->GetMode() == CINOSMcModule::eModStep)) &&\
        ((_inst_.GetParent()&&(!_inst_.GetParent()->GetModule(_msg_->GetSender()->GetName()))))))){\
            char msg[256];                                                      \
            inos_strncpy(msg, _msg_->GetName(), sizeof(msg));                                       \
            uint32 uRes = SendMessage(INOS_MCMSG_TYPE_STEP, INOS_MCMSG_CODE_MODULE_STEP,\
                INOS_MCMSG_FLAG_RESUME|INOS_MCMSG_FLAG_SKIP|                    \
                INOS_MCMSG_FLAG_CANCEL|INOS_MCMSG_FLAG_STOP,                    \
                msg);                                                           \
            if (uRes & INOS_MCMSG_FLAG_CANCEL){                                 \
                _inst_.iStepCanceled(_msg_);                                    \
                return _inst_.MsgDone(_msg_, CINOSTaskEx::eRplCanceled, 0);     \
            }                                                                   \
            if (uRes & INOS_MCMSG_FLAG_STOP){                                   \
                _inst_.iStepStopped(_msg_);                                     \
                return _inst_.MsgDone(_msg_, CINOSTaskEx::eRplStopped, 0);      \
            }                                                                   \
            if (uRes & INOS_MCMSG_FLAG_SKIP){                                   \
                _inst_.iStepSkipped(_msg_);                                     \
                return _inst_.MsgDone(_msg_, CINOSTaskEx::eRplSkipped, 0);      \
            }                                                                   \
    }

Typedef Documentation

TINOSMcModuleCondHandler

using TINOSMcModuleCondHandler = std::function<uint32()>

callback function used to call a hander function that returns an error code or 0 on success