System::Timers::Timer Class Reference

Timer that calls delegate in a loop. More...

#include <timer.h>

Inherits System::ComponentModel::Component.

Public Member Functions
	Timer ()
	RTTI information. More...
	Timer (double interval)
	Constructs stopped timer with specified interval. More...
double	get_Interval () const
	Gets timer interval. More...
void	set_Interval (double ms)
	Sets timer interval. More...
bool	get_AutoReset () const
	Checks if timer is in auto-reset mode. More...
void	set_AutoReset (bool autoreset)
	Sets timer into auto-reset mode or out of it. More...
bool	get_Enabled () const
	Checks if timer is active. More...
void	set_Enabled (bool value)
	Starts or stops timer. Starting timer doesn't restart time counting if timer is already executing. More...
bool	get_IsStopped () const
	Checks if timer is stopped. More...
void	Start ()
	Starts timer. Doesn't restart time counting if timer is already executing. More...
void	Stop ()
	Stops timer. More...
void	Close ()
	Stops timer, frees allocated resources. More...
void	Dispose ()
	Stops timer, frees allocated resources. More...
Public Member Functions inherited from System::ComponentModel::Component
	Component ()
	RTTI information. More...
void	Dispose (bool disposing=false)
	Disposable pattern support; does nothing. More...
bool	get_DesignMode ()
	Checks if component is in design mode. More...
Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...
virtual	~Object ()
	Destroys object. Frees all internal data structures. More...
	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...
Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...
int	SharedCount () const
	Gets current value of shared reference counter. More...
void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...
virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...
virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...
template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...
template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Public Attributes
ElapsedEventHandler	Elapsed
	Callback function to be called by timer. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...
Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...
static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...
template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
Protected Member Functions inherited from System::MarshalByRefObject
	MarshalByRefObject ()
	Constructs an instance. More...

Detailed Description

Timer that calls delegate in a loop.

Constructor & Destructor Documentation

Timer() [1/2]

System::Timers::Timer::Timer

(

)

RTTI information.

Constructs stopped timer with unspecified interval.

Timer() [2/2]

System::Timers::Timer::Timer

(

double

interval

)

Constructs stopped timer with specified interval.

Parameters

interval

Interval between consequental timer invocations or between timer start and first invocation, in miliseconds.

Member Function Documentation

Close()

void System::Timers::Timer::Close

(

)

Stops timer, frees allocated resources.

Dispose()

void System::Timers::Timer::Dispose

(

)

Stops timer, frees allocated resources.

get_AutoReset()

bool System::Timers::Timer::get_AutoReset

(

)

const

Checks if timer is in auto-reset mode.

Returns

true if timer invokes in a loop, false if it stops after first invocation.

get_Enabled()

bool System::Timers::Timer::get_Enabled

(

)

const

Checks if timer is active.

Returns

true if timer is executing, false if it is stopped.

get_Interval()

double System::Timers::Timer::get_Interval

(

)

const

Gets timer interval.

Returns

Interval between consequental timer invocations or between timer start and first invocation, in miliseconds.

get_IsStopped()

bool System::Timers::Timer::get_IsStopped

(

)

const

Checks if timer is stopped.

Returns

true if timer is stopped, false if it is executing.

set_AutoReset()

void System::Timers::Timer::set_AutoReset

(

bool

autoreset

)

Sets timer into auto-reset mode or out of it.

Parameters

autoreset

true to make timer invoke in a loop, false to stop it after first invocation.

set_Enabled()

void System::Timers::Timer::set_Enabled

(

bool

value

)

Starts or stops timer. Starting timer doesn't restart time counting if timer is already executing.

Parameters

value

true to start timer, false to stop.

set_Interval()

void System::Timers::Timer::set_Interval

(

double

ms

)

Sets timer interval.

Parameters

ms	Interval between consequental timer invocations or between timer start and first invocation, in miliseconds.

Start()

void System::Timers::Timer::Start

(

)

Starts timer. Doesn't restart time counting if timer is already executing.

Stop()

void System::Timers::Timer::Stop

(

)

Stops timer.

Member Data Documentation

Elapsed

ElapsedEventHandler System::Timers::Timer::Elapsed

Callback function to be called by timer.