Foo Class Reference

Class Foo brief description. More...

#include <header.h>

Public Member Functions
void	Foo_ctor (Foo *const me, uint32_t const x)
	Constructor of class Foo brief description.
bool	Foo_verify_ (Foo const *const me)
	Verify operation to check the class invariant.
void	Foo_update_ (Foo *const me)
	Update operation to update the class invariant.

Public Attributes
uint32_t	x
	Attribute x of class Foo brief description.
Foo	Foo_inst
	Foo instance brief description (singleton).

Private Attributes
uint32_t	x_dis
	Duplicate Inverse Storage for attribute Foo::x.

Detailed Description

Class Foo brief description.

Details

Class Foo longer description.

Backward Traceability

• [SRS_EXA_REQ_10] My project shall provide a class Foo.

Forward Traceability

• [Foo_ctor()] Constructor of class Foo brief description
  • [TUN_PRJ_Foo_ctor_01] constructor test
• [Foo_verify_()] Verify operation to check the class invariant
  • [TUN_PRJ_Foo_verify_00] verify positive test
  • [TUN_PRJ_Foo_verify_01] verify negative test
  • [Foo::x_dis] Duplicate Inverse Storage for attribute Foo::x
• [Foo_update_()] Update operation to update the class invariant
• [Foo_inst] Foo instance brief description (singleton)

Definition at line 18 of file header.h.

Member Function Documentation

Foo_ctor()

void Foo_ctor	(	Foo *const	me,
		uint32_t const	x )

Constructor of class Foo brief description.

Details

Constructor of class Foo longer description.

Parameters

[in]	me	- the instance pointer (OOP in C)
[in]	x	- the initial value for me->x

Backward Traceability

• [SRS_EXA_REQ_12] Class Foo shall provide a constructor.
• [Foo] Class Foo brief description

Forward Traceability

• [TUN_PRJ_Foo_ctor_01] constructor test

Definition at line 14 of file source.c.

Foo_verify_()

bool Foo_verify_

(

Foo const *const

me

)

Verify operation to check the class invariant.

Details

Operation verify_() of class Foo longer description.

Parameters

[in]

me

- the instance pointer (OOP in C)

Returns

'true' when the Foo instance verification succeeds, 'false' otherwise.

Backward Traceability

• [SRS_EXA_REQ_13] Class Foo shall provide a verify operation.
• [Foo] Class Foo brief description

Forward Traceability

• [TUN_PRJ_Foo_verify_00] verify positive test
• [TUN_PRJ_Foo_verify_01] verify negative test
• [Foo::x_dis] Duplicate Inverse Storage for attribute Foo::x

Definition at line 23 of file source.c.

Foo_update_()

void Foo_update_

(

Foo *const

me

)

Update operation to update the class invariant.

Details

Constructor of class Foo longer description.

Parameters

[in]

me

- the instance pointer (OOP in C)

Backward Traceability

• [SRS_EXA_REQ_14] Class Foo shall provide an update operation.
• [Foo] Class Foo brief description

Forward Traceability

Definition at line 19 of file source.c.

Member Data Documentation

x

uint32_t x

Attribute x of class Foo brief description.

Details

Attribute x of class Foo: longer description.

Backward Traceability

• [SRS_EXA_REQ_11] Class Foo shall provide a public attribute x.

Definition at line 19 of file header.h.

x_dis

uint32_t x_dis

private

Duplicate Inverse Storage for attribute Foo::x.

Details

Duplicate Inverse Storage (DIS) for attribute Foo::x: longer description.

Backward Traceability

• [Foo::x] Attribute x of class Foo brief description
• [Foo_verify_()] Verify operation to check the class invariant

Definition at line 20 of file header.h.

Foo_inst

Foo Foo_inst

Foo instance brief description (singleton).

Details

Foo instance longer description.

Backward Traceability

• [SRS_EXA_REQ_15] Class Foo shall be a singleton.
• [Foo] Class Foo brief description

Forward Traceability

Definition at line 33 of file header.h.