Embedded Multicore Building Blocks V1.0.0
Public Member Functions | List of all members
embb::mtapi::ActionAttributes Class Reference

Contains attributes of an Action. More...

#include <action_attributes.h>

Public Member Functions

 ActionAttributes ()
 Constructs an ActionAttributes object. More...
 
ActionAttributesSetGlobal (bool state)
 Sets the global property of an Action. More...
 
ActionAttributesSetAffinity (Affinity const &affinity)
 Sets the affinity of an Action. More...
 
ActionAttributesSetDomainShared (bool state)
 Sets the domain shared property of an Action. More...
 
mtapi_action_attributes_t const & GetInternal () const
 Returns the internal representation of this object. More...
 

Detailed Description

Contains attributes of an Action.

Constructor & Destructor Documentation

embb::mtapi::ActionAttributes::ActionAttributes ( )

Constructs an ActionAttributes object.

Concurrency
Thread-safe and wait-free

Member Function Documentation

ActionAttributes& embb::mtapi::ActionAttributes::SetGlobal ( bool  state)

Sets the global property of an Action.

This determines whether the object will be visible across nodes.

Returns
Reference to this object.
Concurrency
Thread-safe and wait-free
Parameters
stateThe state to set
ActionAttributes& embb::mtapi::ActionAttributes::SetAffinity ( Affinity const &  affinity)

Sets the affinity of an Action.

Returns
Reference to this object.
Concurrency
Thread-safe and wait-free
Parameters
affinityThe Affinity to set.
ActionAttributes& embb::mtapi::ActionAttributes::SetDomainShared ( bool  state)

Sets the domain shared property of an Action.

This determines whether the object will be visible across domains.

Returns
Reference to this object.
Concurrency
Thread-safe and wait-free
Parameters
stateThe state to set
mtapi_action_attributes_t const& embb::mtapi::ActionAttributes::GetInternal ( ) const

Returns the internal representation of this object.

Allows for interoperability with the C interface.

Returns
A reference to the internal mtapi_action_attributes_t structure.
Concurrency
Thread-safe and wait-free