API Guides > ConceptRT 3.x
OutputGenericAcyclic< ElementType > Class Template Reference

Base class for Output Acyclic. More...

Detailed Description

template<class ElementType>
class ConceptRT::OutputGenericAcyclic< ElementType >

Base class for Output Acyclic.

Template Parameters
ElementTypeOutput type.
+ Inheritance diagram for OutputGenericAcyclic< ElementType >:

Public Member Methods

bool SetMapping (IoMappingItem &item)
 Sets the IO mapping. More...
 
void Clear ()
 Clear the mapping. More...
 
 operator ElementType () const
 Implicite converter. More...
 
ElementType GetValue () const
 Gets the IO value. More...
 
void SetValue (ElementType value)
 Sets the IO value. More...
 
void Force (ElementType value)
 Force the Input to a value. More...
 
void Release ()
 Release the forced value. More...
 
bool IsForced () const
 Query if the IO is forced. 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 ( )
inlinevirtual

Clear the mapping.

Implements InputOutput.

void Force ( ElementType  value)
inline

Force the Input to a value.

Parameters
valueThe value to force.
Warning
Non-Deterministic: Will block the caller until the acylic value is forced. Can take time. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.
See also
Release()
RT Exceptions:
RT_ERROR_IO_NOT_MAPPED
ElementType GetValue ( ) const
inline

Gets the IO value.

Returns
The value.
Warning
Non-Deterministic: Will block the caller until the acylic value is retrieved. Can take time. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.
RT Exceptions:
RT_ERROR_IO_NOT_MAPPED
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 IsForced ( ) const
inline

Query if the IO is forced.

Returns
True if forced, false if not.
See also
Force() Release() IsForced()
operator ElementType ( ) const
inline

Implicite converter.

Returns
The value.
Warning
Non-Deterministic: Will block the caller until the acylic value is retrieved. Can take time. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.
RT Exceptions:
RT_ERROR_IO_NOT_MAPPED
void Release ( )
inline

Release the forced value.

Warning
Non-Deterministic: Will block the caller until the acylic value is released. Can take time. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.
See also
Force() IsForced()
RT Exceptions:
RT_ERROR_IO_NOT_MAPPED
bool SetMapping ( IoMappingItem item)
inlinevirtual

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.

void SetValue ( ElementType  value)
inline

Sets the IO value.

Parameters
valueThe value.
Warning
Non-Deterministic: Will block the caller until the acylic value is set. Can take time. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.
RT Exceptions:
RT_ERROR_IO_NOT_MAPPED