Tuple5 Struct Reference

Tuple5 class definition. More...

#include <Tuple5.h>

Data Fields
void *	fifth
void *	first
void *	forth
boolean	frozen
void *	second
void *	third
Related Functions
(Note that these are not member functions.)
Tuple5_ptr	Tuple5_create (void *first, void *second, void *third, void *forth, void *fifth)
	The Tuple5 class constructor.
void	Tuple5_destroy (Tuple5_ptr self)
	The Tuple5 class destructor.
void	Tuple5_freeze (Tuple5_ptr self)
	Mark the Tuple5 instance as read-only.
void *	Tuple5_get_fifth (const Tuple5_ptr self)
	Get the fifth value of the Tuple5 instance.
void *	Tuple5_get_first (const Tuple5_ptr self)
	Get the first value of the Tuple5 instance.
void *	Tuple5_get_forth (const Tuple5_ptr self)
	Get the forth value of the Tuple5 instance.
void *	Tuple5_get_second (const Tuple5_ptr self)
	Get the second value of the Tuple5 instance.
void *	Tuple5_get_third (const Tuple5_ptr self)
	Get the third value of the Tuple5 instance.
unsigned long	Tuple5_hash (const Tuple5_ptr self, int size)
	Tuple5 hash function.
void	Tuple5_init (Tuple5_ptr self, void *first, void *second, void *third, void *forth, void *fifth)
	The Tuple5 class initializer.
boolean	Tuple5_is_freezed (const Tuple5_ptr self)
	Check if the Tuple5 is freezed.
void	Tuple5_set_fifth (Tuple5_ptr self, void *fifth)
	Sets the fifth value for the Tuple5 instance.
void	Tuple5_set_first (Tuple5_ptr self, void *first)
	Sets the first value for the Tuple5 instance.
void	Tuple5_set_forth (Tuple5_ptr self, void *forth)
	Sets the forth value for the Tuple5 instance.
void	Tuple5_set_second (Tuple5_ptr self, void *second)
	Sets the second value for the Tuple5 instance.
void	Tuple5_set_third (Tuple5_ptr self, void *third)
	Sets the third value for the Tuple5 instance.
void	Tuple5_set_values (Tuple5_ptr self, void *first, void *second, void *third, void *forth, void *fifth)
	Sets both the values for the Tuple5 instance.

---

Detailed Description

Tuple5 class definition.

Public interface of class 'Tuple5'.

Author:

Alessandro Mariotti

Todo:

: Missing description

Definition of the public accessor for class Tuple5

---

Friends And Related Function Documentation

Tuple5_ptr Tuple5_create	(	void *	first,
		void *	second,
		void *	third,
		void *	forth,
		void *	fifth
	)			[related]

The Tuple5 class constructor.

AutomaticStart

The Tuple5 class constructor

See also:

Tuple5_destroy

void Tuple5_destroy

(

Tuple5_ptr

self

)

[related]

The Tuple5 class destructor.

The Tuple5 class destructor

See also:

Tuple5_create

void Tuple5_freeze

(

Tuple5_ptr

self

)

[related]

Mark the Tuple5 instance as read-only.

Mark the Tuple5 instance as read-only. This is useful when debugging, and using a Tuple5 instance as key of an hash table, for example

void * Tuple5_get_fifth

(

const Tuple5_ptr

self

)

[related]

Get the fifth value of the Tuple5 instance.

Get the fifth value of the Tuple5 instance

void * Tuple5_get_first

(

const Tuple5_ptr

self

)

[related]

Get the first value of the Tuple5 instance.

Get the first value of the Tuple5 instance

void * Tuple5_get_forth

(

const Tuple5_ptr

self

)

[related]

Get the forth value of the Tuple5 instance.

Get the forth value of the Tuple5 instance

void * Tuple5_get_second

(

const Tuple5_ptr

self

)

[related]

Get the second value of the Tuple5 instance.

Get the second value of the Tuple5 instance

void * Tuple5_get_third

(

const Tuple5_ptr

self

)

[related]

Get the third value of the Tuple5 instance.

Get the third value of the Tuple5 instance

unsigned long Tuple5_hash	(	const Tuple5_ptr	self,
		int	size
	)			[related]

Tuple5 hash function.

Tuple5 hash function. No distinction between frozen / unfrozen instances is made. Can be casted to ST_PFICPI

void Tuple5_init	(	Tuple5_ptr	self,
		void *	first,
		void *	second,
		void *	third,
		void *	forth,
		void *	fifth
	)			[related]

The Tuple5 class initializer.

The Tuple5 class initializer. Use this function if declaring a Tuple5 in the stack

See also:

Tuple5_create

boolean Tuple5_is_freezed

(

const Tuple5_ptr

self

)

[related]

Check if the Tuple5 is freezed.

Check if the Tuple5 is freezed (i.e. it is read-only)

void Tuple5_set_fifth	(	Tuple5_ptr	self,
		void *	fifth
	)			[related]

Sets the fifth value for the Tuple5 instance.

Sets the fifth value for the Tuple5 instance. The Tuple5 must not be frozen

void Tuple5_set_first	(	Tuple5_ptr	self,
		void *	first
	)			[related]

Sets the first value for the Tuple5 instance.

Sets the first value for the Tuple5 instance. The Tuple5 must not be frozen

void Tuple5_set_forth	(	Tuple5_ptr	self,
		void *	forth
	)			[related]

Sets the forth value for the Tuple5 instance.

Sets the forth value for the Tuple5 instance. The Tuple5 must not be frozen

void Tuple5_set_second	(	Tuple5_ptr	self,
		void *	second
	)			[related]

Sets the second value for the Tuple5 instance.

Sets the second value for the Tuple5 instance. The Tuple5 must not be frozen

void Tuple5_set_third	(	Tuple5_ptr	self,
		void *	third
	)			[related]

Sets the third value for the Tuple5 instance.

Sets the third value for the Tuple5 instance. The Tuple5 must not be frozen

void Tuple5_set_values	(	Tuple5_ptr	self,
		void *	first,
		void *	second,
		void *	third,
		void *	forth,
		void *	fifth
	)			[related]

Sets both the values for the Tuple5 instance.

Sets both the values for the Tuple5 instance. The Tuple5 must not be frozen

---

Field Documentation

void* Tuple5::fifth

void* Tuple5::first

void* Tuple5::forth

boolean Tuple5::frozen

void* Tuple5::second

void* Tuple5::third

---

The documentation for this struct was generated from the following file:

• NuSMV/code/nusmv/core/utils/Tuple5.h