cs_time_control_t Class Reference

#include <cs_time_control.h>

Collaboration diagram for cs_time_control_t:

Public Member Functions
	cs_time_control_t ()
	cs_time_control_t (int nt_start, int nt_end, int nt_interval, bool at_start_=true, bool at_end_=true, bool at_first_=false)
	cs_time_control_t (double t_start, double t_end, double t_interval, bool at_start_=true, bool at_end_=true, bool at_first_=false)
	cs_time_control_t (cs_time_control_func_t *control_func_, void *input_, bool at_start_=true, bool at_end_=true, bool at_first_=false)
bool	is_active (const cs_time_step_t *ts)
void	get_description (char *desc, size_t desc_size) const

Public Attributes
cs_time_control_type_t	type
bool	at_start
bool	at_first
bool	at_end
union {
int   start_nt
double   start_t
};
union {
int   end_nt
double   end_t
};
union {
int   interval_nt
double   interval_t
};
cs_time_control_func_t *	control_func
void *	control_input
bool	current_state
int	current_time_step
int	last_nt
double	last_t

Constructor & Destructor Documentation

cs_time_control_t() [1/4]

cs_time_control_t

(

)

cs_time_control_t() [2/4]

cs_time_control_t	(	int	nt_start,
		int	nt_end,
		int	nt_interval,
		bool	at_start_ = true,
		bool	at_end_ = true,
		bool	at_first_ = false
	)

cs_time_control_t() [3/4]

cs_time_control_t	(	double	t_start,
		double	t_end,
		double	t_interval,
		bool	at_start_ = true,
		bool	at_end_ = true,
		bool	at_first_ = false
	)

cs_time_control_t() [4/4]

cs_time_control_t	(	cs_time_control_func_t *	control_func_,
		void *	input_,
		bool	at_start_ = true,
		bool	at_end_ = true,
		bool	at_first_ = false
	)

Member Function Documentation

get_description()

void get_description	(	char *	desc,
		size_t	desc_size
	)		const

is_active()

bool is_active

(

const cs_time_step_t *

ts

)

Member Data Documentation

union { ... } @5

union { ... } @7

union { ... } @9

at_end

bool at_end

at_first

bool at_first

at_start

bool at_start

control_func

cs_time_control_func_t* control_func

control_input

void* control_input

current_state

bool current_state

current_time_step

int current_time_step

end_nt

int end_nt

end_t

double end_t

interval_nt

int interval_nt

interval_t

double interval_t

last_nt

int last_nt

last_t

double last_t

start_nt

int start_nt

start_t

double start_t

type

cs_time_control_type_t type

---

The documentation for this class was generated from the following files:

• src/base/cs_time_control.h
• src/base/cs_time_control.cpp