Pair Struct Reference

Pair class definition. More...

#include <Pair.h>

Data Fields
void *	first
boolean	frozen
void *	second
Related Functions
(Note that these are not member functions.)
Pair_ptr	Pair_create (void *first, void *second)
	The Pair class constructor.
void	Pair_destroy (Pair_ptr self)
	The Pair class destructor.
void	Pair_freeze (Pair_ptr self)
	Mark the Pair instance as read-only.
void *	Pair_get_first (const Pair_ptr self)
	Get the first value of the Pair instance.
void *	Pair_get_second (const Pair_ptr self)
	Get the second value of the Pair instance.
unsigned long	Pair_hash (const Pair_ptr self, int size)
	Pair hash function.
void	Pair_init (Pair_ptr self, void *first, void *second)
	The Pair class initializer.
boolean	Pair_is_freezed (const Pair_ptr self)
	Check if the Pair is freezed.
void	Pair_set_first (Pair_ptr self, void *first)
	Sets the first value for the Pair instance.
void	Pair_set_second (Pair_ptr self, void *second)
	Sets the second value for the Pair instance.
void	Pair_set_values (Pair_ptr self, void *first, void *second)
	Sets both the values for the Pair instance.

---

Detailed Description

Pair class definition.

Public interface of class 'Pair'.

Author:

Alessandro Mariotti

Todo:

: Missing description

Definition of the public accessor for class Pair

---

Friends And Related Function Documentation

Pair_ptr Pair_create	(	void *	first,
		void *	second
	)			[related]

The Pair class constructor.

AutomaticStart

The Pair class constructor

See also:

Pair_destroy

void Pair_destroy

(

Pair_ptr

self

)

[related]

The Pair class destructor.

The Pair class destructor

See also:

Pair_create

void Pair_freeze

(

Pair_ptr

self

)

[related]

Mark the Pair instance as read-only.

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

void * Pair_get_first

(

const Pair_ptr

self

)

[related]

Get the first value of the Pair instance.

Get the first value of the Pair instance

void * Pair_get_second

(

const Pair_ptr

self

)

[related]

Get the second value of the Pair instance.

Get the second value of the Pair instance

unsigned long Pair_hash	(	const Pair_ptr	self,
		int	size
	)			[related]

Pair hash function.

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

void Pair_init	(	Pair_ptr	self,
		void *	first,
		void *	second
	)			[related]

The Pair class initializer.

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

See also:

Pair_create

boolean Pair_is_freezed

(

const Pair_ptr

self

)

[related]

Check if the Pair is freezed.

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

void Pair_set_first	(	Pair_ptr	self,
		void *	first
	)			[related]

Sets the first value for the Pair instance.

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

void Pair_set_second	(	Pair_ptr	self,
		void *	second
	)			[related]

Sets the second value for the Pair instance.

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

void Pair_set_values	(	Pair_ptr	self,
		void *	first,
		void *	second
	)			[related]

Sets both the values for the Pair instance.

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

---

Field Documentation

void* Pair::first

boolean Pair::frozen

void* Pair::second

---

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

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