API Guides > ConceptRT 3.x
InputOutputCycleSync Class Reference

Io for Synchronization with the field-bus. More...

Detailed Description

Io for Synchronization with the field-bus.

+ Inheritance diagram for InputOutputCycleSync:

Public Member Methods

bool SetMapping (IoMappingItem &item)
 Sets the IO mapping. More...
 
void Clear ()
 Clear the mapping. More...
 
bool WaitIoCycle (TimeSpan timeOut=TimeInfinite)
 Wait on the next cycle. More...
 
bool WaitIoCycle (Int32 &cycle, TimeSpan timeOut=TimeInfinite)
 Wait on the next cycle. More...
 
void Invoke (const DynamicInvocationRequest &request, DynamicInvocationResult &result)
 Invokes the object fields and methods. More...
 
- Public Member Methods inherited from InputOutput
 InputOutput ()
 Default constructor. More...
 
void SetLogicalName (PCChar8 logicalName)
 Sets the IO logical name. More...
 
const BaseStaticStringGetLogicalName () const
 Gets the IO logical name. More...
 
Int32 GetInputOutputIdentifier () const
 Gets the IO auto identifier. More...
 

Methods Documentation

void Clear ( )
virtual

Clear the mapping.

Implements InputOutput.

void Invoke ( const DynamicInvocationRequest request,
DynamicInvocationResult result 
)
inlinevirtual

Invokes the object fields and methods.

Parameters
requestThe request.
result[in,out] The result.

Dynamic Invocation on IInvocable objects enables us to have remote access on published fields and methods.

Implements IInvocable.

bool SetMapping ( IoMappingItem item)
virtual

Sets the IO mapping.

Parameters
itemThe mapping item.

Used by the InpoutOutputSystem at Map time.

Returns
True if the mapping is compatible, false if not.

Implements InputOutput.

bool WaitIoCycle ( TimeSpan  timeOut = TimeInfinite)

Wait on the next cycle.

Parameters
timeOutthe timeout. Default = TimeInfinite.
Returns
true if cycle occurs, false if timeout occurs.
RT Exceptions:

RT_ERROR_IO_NOT_MAPPED

RT_ERROR_INTERNAL_SIMULATION_TIMER_NOT_CREATED

bool WaitIoCycle ( Int32 cycle,
TimeSpan  timeOut = TimeInfinite 
)

Wait on the next cycle.

Parameters
cycle[out] Cylce counter.
timeOutThe timeout. Default = TimeInfinite.
Returns
true if cycle occurs, false if timeout occurs.
RT Exceptions:

RT_ERROR_IO_NOT_MAPPED

RT_ERROR_INTERNAL_SIMULATION_TIMER_NOT_CREATED