NuSMVEnv Struct Reference

Public interface of class 'NuSMVEnv'. More...

#include <NuSMVEnv.h>

Related Functions
(Note that these are not member functions.)
NuSMVEnv_ptr	NuSMVEnv_create (void)
	The NuSMVEnv class constructor.
void	NuSMVEnv_destroy (NuSMVEnv_ptr self)
	The NuSMVEnv class destructor.
boolean	NuSMVEnv_get_flag (NuSMVEnv_ptr self, const char *flag)
	Getter for flag values.
st_table *	NuSMVEnv_get_handled_hash_ptr (NuSMVEnv_ptr self, const char *key)
	Retrieves a special hash_ptr instance handled by the env.
void *	NuSMVEnv_get_value (const NuSMVEnv_ptr self, const char *key)
	Getter for the custom instances.
boolean	NuSMVEnv_has_flag (NuSMVEnv_ptr self, const char *flag)
	Checks whether the given flag exists in the environment.
boolean	NuSMVEnv_has_value (const NuSMVEnv_ptr self, const char *key)
	Checks whether the given key exists in the environment.
boolean	NuSMVEnv_remove_flag (NuSMVEnv_ptr self, const char *flag)
	Remover for flags.
void *	NuSMVEnv_remove_value (NuSMVEnv_ptr self, const char *key)
	Remover for custom instances.
void	NuSMVEnv_set_flag (NuSMVEnv_ptr self, const char *flag, boolean value)
	Setter for flag values.
void *	NuSMVEnv_set_or_replace_value (NuSMVEnv_ptr self, const char *key, void *value)
	Setter for custom instances.
void	NuSMVEnv_set_value (NuSMVEnv_ptr self, const char *key, void *value)
	Setter for custom instances.

---

Detailed Description

Public interface of class 'NuSMVEnv'.

Author:

Alessandro Mariotti

Todo:

: Missing description

Definition of the public accessor for class NuSMVEnv

---

Friends And Related Function Documentation

NuSMVEnv_ptr NuSMVEnv_create

(

void

)

[related]

The NuSMVEnv class constructor.

AutomaticStart

The NuSMVEnv class constructor

See also:

NuSMVEnv_destroy

void NuSMVEnv_destroy

(

NuSMVEnv_ptr

self

)

[related]

The NuSMVEnv class destructor.

The NuSMVEnv class destructor

See also:

NuSMVEnv_create

boolean NuSMVEnv_get_flag	(	NuSMVEnv_ptr	self,
		const char *	flag
	)			[related]

Getter for flag values.

Getter for flag values. Returns false if the flag does not exist, and the value of the flag otherwise

st_table * NuSMVEnv_get_handled_hash_ptr	(	NuSMVEnv_ptr	self,
		const char *	key
	)			[related]

Retrieves a special hash_ptr instance handled by the env.

Retrieves a special hash_ptr instance handled by the env. If the given hash already exists in the NuSMVEnv, then that instance is returned. Otherwise, a new one is created and added in the environment. If the given key already exists in the environment before the first call of this function with the given key, the behavior of this function is not predictable. The returned hash_ptr will be freed by the environment, however, entries in such hash must be freed by the caller. Do not remove the given key from the environment using NuSMVEnv_remove_value

void * NuSMVEnv_get_value	(	const NuSMVEnv_ptr	self,
		const char *	key
	)			[related]

Getter for the custom instances.

Getter for the custom instances. The key is expected to exist and have a non NULL value associated, otherwise an assertion is thrown.

If the key starts with characted '+', the key will be considered a "fast-key". This means that the second character of the string is used as an index to an array. Using fast-keys is quite faster than using normal keys, however, fast-keys can be at most 222 (255 ASCII characters minus the firsts 33). Have a look to NuSMVEnv.h for checking out which ASCII characters have been already used for fast-keys.

See also:

NuSMVEnv_set_value

boolean NuSMVEnv_has_flag	(	NuSMVEnv_ptr	self,
		const char *	flag
	)			[related]

Checks whether the given flag exists in the environment.

Checks whether the given flag exists in the environment

See also:

NuSMVEnv_create

boolean NuSMVEnv_has_value	(	const NuSMVEnv_ptr	self,
		const char *	key
	)			[related]

Checks whether the given key exists in the environment.

Checks whether the given key exists in the environment

See also:

NuSMVEnv_create

boolean NuSMVEnv_remove_flag	(	NuSMVEnv_ptr	self,
		const char *	flag
	)			[related]

Remover for flags.

Remover for flags. Returns the value of the flag. If the flag does not exist, returns false

void * NuSMVEnv_remove_value	(	NuSMVEnv_ptr	self,
		const char *	key
	)			[related]

Remover for custom instances.

Remover for custom instances. Should be used only by deinitialization functions. The key is expected to exist in the given environment, an assertion is thrown otherwise

void NuSMVEnv_set_flag	(	NuSMVEnv_ptr	self,
		const char *	flag,
		boolean	value
	)			[related]

Setter for flag values.

Setter for flag values

void * NuSMVEnv_set_or_replace_value	(	NuSMVEnv_ptr	self,
		const char *	key,
		void *	value
	)			[related]

Setter for custom instances.

Setter for custom instances. Should be used only by initialization functions. The string key must be unique: adding an existing key will replace the old value. The instance argument must not be NULL

If the key starts with characted '+', the key will be considered a "fast-key". This means that the second character of the string is used as an index to an array. Using fast-keys is quite faster than using normal keys, however, fast-keys can be at most 222 (255 ASCII characters minus the firsts 33). Have a look to NuSMVEnv.h for checking out which ASCII characters have been already used for fast-keys.

void NuSMVEnv_set_value	(	NuSMVEnv_ptr	self,
		const char *	key,
		void *	value
	)			[related]

Setter for custom instances.

Setter for custom instances. Should be used only by initialization functions. The string key must be unique: adding an existing key will result in an assertion. The value must be not NULL

If the key starts with characted '+', the key will be considered a "fast-key". This means that the second character of the string is used as an index to an array. Using fast-keys is quite faster than using normal keys, however, fast-keys can be at most 222 (255 ASCII characters minus the firsts 33). Have a look to NuSMVEnv.h for checking out which ASCII characters have been already used for fast-keys.

---

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

• NuSMV/code/nusmv/core/cinit/NuSMVEnv.h