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

Base class for Input Acyclic. More...

Detailed Description

template<class ElementType>
class ConceptRT::InputGenericAcyclic< ElementType >

Base class for Input Acyclic.

Template Parameters
ElementTypeInput type.
+ Inheritance diagram for InputGenericAcyclic< ElementType >:

Public Member Methods

bool SetMapping (IoMappingItem &item)
 Sets the IO mapping. More...
 
 operator ElementType () const
 Implicit converter. More...
 
ElementType GetValue (ElementType simulatedValue) const
 Gets the IO value. More...
 
void Force (ElementType value)
 Force the Input to a value. More...
 
void Release ()
 Release the forced value. More...
 
void Clear ()
 Clear the mapping. 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.
See also
Release() IsForced()
RT Exceptions:
RT_ERROR_IO_NOT_MAPPED
ElementType GetValue ( ElementType  simulatedValue) const
inline

Gets the IO value.

Parameters
simulatedValueThe simulated value to return when the InputOutputSystem simulation flaf is set.
Returns
The value.
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()
operator ElementType ( ) const
inline

Implicit converter.

Returns
The value.
RT Exceptions:
RT_ERROR_IO_NOT_MAPPED
void Release ( )
inline

Release the forced value.

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.