tvm::Clock Class Reference

#include <tvm/Clock.h>

Inheritance diagram for tvm::Clock:

Collaboration diagram for tvm::Clock:

Public Member Functions
	Clock (double dt)
uint64_t	ticks () const
double	dt () const
void	advance ()
Public Member Functions inherited from tvm::graph::abstract::Outputs
virtual	~Outputs ()=default
template<typename EnumT >
bool	isOutputEnabled (EnumT e) const
bool	isOutputEnabled (int i) const
virtual bool	isOutputStaticallyEnabled (int) const
virtual bool	isOutputCustomEnabled (int) const

Protected Member Functions
	Clock (const Clock &)=default
Clock &	operator= (const Clock &)=default
	Clock (Clock &&)=default
Clock &	operator= (Clock &&)=default

Friends
class	ControlProblem

Additional Inherited Members
Public Types inherited from tvm::graph::abstract::Outputs
enum class	Output_
using	OutputParent = Outputs
using	OutputBase = Outputs
Static Public Member Functions inherited from tvm::graph::abstract::Outputs
static constexpr const char *	OutputName (Output_)
template<typename EnumT >
static constexpr bool	OutputStaticallyEnabled (EnumT)
Static Public Attributes inherited from tvm::graph::abstract::Outputs
static constexpr unsigned int	OutputSize = 0
static constexpr auto	OutputBaseName = "Outputs"
Protected Attributes inherited from tvm::graph::abstract::Outputs
bool	is_node_ = false

Detailed Description

Represent a clock for the ControlProblem

The current iteration of the problem can be accessed by time-dependent data to trigger computations

Outputs:

• Time is moved along as the iterations go on

Constructor & Destructor Documentation

Clock() [1/3]

tvm::Clock::Clock

(

double

dt

)

Constructor

Parameters

dt	Timestep of the ControlProblem

Clock() [2/3]

tvm::Clock::Clock ( const Clock &  )

protecteddefault

Clock() [3/3]

tvm::Clock::Clock ( Clock &&  )

protecteddefault

Member Function Documentation

advance()

void tvm::Clock::advance

(

)

Advance the clock by one tick

dt()

double tvm::Clock::dt ( ) const

inline

Returns the timestep of the problem

operator=() [1/2]

Clock& tvm::Clock::operator= ( Clock &&  )

protecteddefault

operator=() [2/2]

Clock& tvm::Clock::operator= ( const Clock &  )

protecteddefault

ticks()

uint64_t tvm::Clock::ticks ( ) const

inline

Returns the number of ticks elapsed since the start of the problem

Friends And Related Function Documentation

ControlProblem

friend class ControlProblem

friend

---

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

• include/tvm/Clock.h