Asposecpplib
System::Timers::Timer Class Referencefinal

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

Inherits System::ComponentModel::Component.

Public Member Functions

ASPOSECPP_SHARED_API Timer ()
 RTTI information. More...
 
ASPOSECPP_SHARED_API Timer (double interval)
 Constructs stopped timer with specified interval. More...
 
ASPOSECPP_SHARED_API double get_Interval () const
 Gets timer interval. More...
 
ASPOSECPP_SHARED_API void set_Interval (double ms)
 Sets timer interval. More...
 
ASPOSECPP_SHARED_API bool get_AutoReset () const
 Checks if timer is in auto-reset mode. More...
 
ASPOSECPP_SHARED_API void set_AutoReset (bool autoreset)
 Sets timer into auto-reset mode or out of it. More...
 
ASPOSECPP_SHARED_API bool get_Enabled () const
 Checks if timer is active. More...
 
ASPOSECPP_SHARED_API void set_Enabled (bool value)
 Starts or stops timer. Starting timer doesn't restart time counting if timer is already executing. More...
 
ASPOSECPP_SHARED_API bool get_IsStopped () const
 Checks if timer is stopped. More...
 
ASPOSECPP_SHARED_API void Start ()
 Starts timer. Doesn't restart time counting if timer is already executing. More...
 
ASPOSECPP_SHARED_API void Stop ()
 Stops timer. More...
 
ASPOSECPP_SHARED_API void Close ()
 Stops timer, frees allocated resources. More...
 
ASPOSECPP_SHARED_API void Dispose ()
 Stops timer, frees allocated resources. More...
 
- Public Member Functions inherited from System::ComponentModel::Component
ASPOSECPP_SHARED_API Component ()
 RTTI information. More...
 
ASPOSECPP_SHARED_API void Dispose (bool disposing=false)
 Disposable pattern support; does nothing. More...
 
ASPOSECPP_SHARED_API bool get_DesignMode ()
 Checks if component is in design mode. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 TypeInfoType ()
 Impleemnts 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...
 

Detailed Description

Timer that calls delegate in a loop.

Constructor & Destructor Documentation

◆ Timer() [1/2]

ASPOSECPP_SHARED_API System::Timers::Timer::Timer ( )

RTTI information.

Constructs stopped timer with unspecified interval.

◆ Timer() [2/2]

ASPOSECPP_SHARED_API System::Timers::Timer::Timer ( double  interval)

Constructs stopped timer with specified interval.

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

Member Function Documentation

◆ Close()

ASPOSECPP_SHARED_API void System::Timers::Timer::Close ( )

Stops timer, frees allocated resources.

◆ Dispose()

ASPOSECPP_SHARED_API void System::Timers::Timer::Dispose ( )

Stops timer, frees allocated resources.

◆ get_AutoReset()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API void System::Timers::Timer::set_AutoReset ( bool  autoreset)

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

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

◆ set_Enabled()

ASPOSECPP_SHARED_API 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
valuetrue to start timer, false to stop.

◆ set_Interval()

ASPOSECPP_SHARED_API void System::Timers::Timer::set_Interval ( double  ms)

Sets timer interval.

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

◆ Start()

ASPOSECPP_SHARED_API void System::Timers::Timer::Start ( )

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

◆ Stop()

ASPOSECPP_SHARED_API void System::Timers::Timer::Stop ( )

Stops timer.

Member Data Documentation

◆ Elapsed

ElapsedEventHandler System::Timers::Timer::Elapsed

Callback function to be called by timer.