ldas-tools-al  2.6.7
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
anonymous_namespace{FileType.cc}::timed_filetype Class Reference
Inheritance diagram for anonymous_namespace{FileType.cc}::timed_filetype:
Inheritance graph
[legend]
Collaboration diagram for anonymous_namespace{FileType.cc}::timed_filetype:
Collaboration graph
[legend]

Public Types

typedef boost::shared_ptr< char > name_type
 
typedef boost::shared_ptr< char > name_type
 
typedef boost::shared_ptr< char > name_type
 
typedef Thread::cancel_type cancel_method
 
typedef Thread::cancel_type cancel_method
 
typedef Thread::cancel_type cancel_method
 
typedef Thread::signal_type signal_type
 Data class for passing signal information. More...
 
typedef Thread::signal_type signal_type
 Data class for passing signal information. More...
 
typedef Thread::signal_type signal_type
 Data class for passing signal information. More...
 

Public Member Functions

 timed_filetype (const std::string &File)
 
virtual void operator() ()
 Action to perform. More...
 
MutexLock::baton_type Baton () const
 Retrieve baton to gain exclusive access. More...
 
MutexLock::baton_type Baton () const
 Retrieve baton to gain exclusive access. More...
 
MutexLock::baton_type Baton () const
 Retrieve baton to gain exclusive access. More...
 
cancel_method CancelMethod () const
 Retrieve method to use for terminating the task. More...
 
cancel_method CancelMethod () const
 Retrieve method to use for terminating the task. More...
 
cancel_method CancelMethod () const
 Retrieve method to use for terminating the task. More...
 
signal_type CancelSignal () const
 Retrieve signal to use for terminating the task. More...
 
signal_type CancelSignal () const
 Retrieve signal to use for terminating the task. More...
 
signal_type CancelSignal () const
 Retrieve signal to use for terminating the task. More...
 
bool DeleteOnCompletion () const
 Retrieve state information concearning deletion. More...
 
bool DeleteOnCompletion () const
 Retrieve state information concearning deletion. More...
 
bool DeleteOnCompletion () const
 Retrieve state information concearning deletion. More...
 
virtual void OnCompletion (int TaskThreadState)
 Action to be done when task completes. More...
 
virtual void OnCompletion (int TaskThreadState)
 Action to be done when task completes. More...
 
virtual void OnCompletion (int TaskThreadState)
 Action to be done when task completes. More...
 
name_type TaskName () const
 Get the name of the current task. More...
 
name_type TaskName () const
 Get the name of the current task. More...
 
name_type TaskName () const
 Get the name of the current task. More...
 

Protected Member Functions

void taskName (const std::string &Name)
 
void taskName (const std::string &Name)
 
void taskName (const std::string &Name)
 
void delete_on_completion (bool Value)
 
void delete_on_completion (bool Value)
 
void delete_on_completion (bool Value)
 

Private Attributes

const std::string m_file
 
std::string m_file_type
 

Member Typedef Documentation

◆ cancel_method [1/3]

typedef Thread::cancel_type LDASTools::AL::Task::cancel_method
inherited

◆ cancel_method [2/3]

typedef Thread::cancel_type LDASTools::AL::Task::cancel_method
inherited

◆ cancel_method [3/3]

typedef Thread::cancel_type LDASTools::AL::Task::cancel_method
inherited

◆ name_type [1/3]

typedef boost::shared_ptr< char > LDASTools::AL::Task::name_type
inherited

◆ name_type [2/3]

typedef boost::shared_ptr< char > LDASTools::AL::Task::name_type
inherited

◆ name_type [3/3]

typedef boost::shared_ptr< char > LDASTools::AL::Task::name_type
inherited

◆ signal_type [1/3]

typedef Thread::signal_type LDASTools::AL::Task::signal_type
inherited

Data class for passing signal information.

◆ signal_type [2/3]

typedef Thread::signal_type LDASTools::AL::Task::signal_type
inherited

Data class for passing signal information.

◆ signal_type [3/3]

typedef Thread::signal_type LDASTools::AL::Task::signal_type
inherited

Data class for passing signal information.

Constructor & Destructor Documentation

◆ timed_filetype()

anonymous_namespace{FileType.cc}::timed_filetype::timed_filetype ( const std::string &  File)
inline

Member Function Documentation

◆ Baton() [1/3]

MutexLock::baton_type LDASTools::AL::Task::Baton ( ) const
inherited

Retrieve baton to gain exclusive access.

◆ Baton() [2/3]

MutexLock::baton_type LDASTools::AL::Task::Baton ( ) const
inherited

Retrieve baton to gain exclusive access.

◆ Baton() [3/3]

MutexLock::baton_type LDASTools::AL::Task::Baton ( ) const
inherited

Retrieve baton to gain exclusive access.

◆ CancelMethod() [1/3]

Task::cancel_method LDASTools::AL::Task::CancelMethod ( ) const
inherited

Retrieve method to use for terminating the task.

Returns
The method to be used to terminate the task.

◆ CancelMethod() [2/3]

cancel_method LDASTools::AL::Task::CancelMethod ( ) const
inherited

Retrieve method to use for terminating the task.

Returns
The method to be used to terminate the task.

◆ CancelMethod() [3/3]

cancel_method LDASTools::AL::Task::CancelMethod ( ) const
inherited

Retrieve method to use for terminating the task.

Returns
The method to be used to terminate the task.

◆ CancelSignal() [1/3]

Task::signal_type LDASTools::AL::Task::CancelSignal ( ) const
inherited

Retrieve signal to use for terminating the task.

Returns
The signal to be used to terminate the task.

◆ CancelSignal() [2/3]

signal_type LDASTools::AL::Task::CancelSignal ( ) const
inherited

Retrieve signal to use for terminating the task.

Returns
The signal to be used to terminate the task.

◆ CancelSignal() [3/3]

signal_type LDASTools::AL::Task::CancelSignal ( ) const
inherited

Retrieve signal to use for terminating the task.

Returns
The signal to be used to terminate the task.

◆ delete_on_completion() [1/3]

void LDASTools::AL::Task::delete_on_completion ( bool  Value)
protectedinherited

◆ delete_on_completion() [2/3]

void LDASTools::AL::Task::delete_on_completion ( bool  Value)
protectedinherited

◆ delete_on_completion() [3/3]

void LDASTools::AL::Task::delete_on_completion ( bool  Value)
protectedinherited

◆ DeleteOnCompletion() [1/3]

bool LDASTools::AL::Task::DeleteOnCompletion ( ) const
inherited

Retrieve state information concearning deletion.

Returns
True if the task should be deleted once terminated.

◆ DeleteOnCompletion() [2/3]

bool LDASTools::AL::Task::DeleteOnCompletion ( ) const
inherited

Retrieve state information concearning deletion.

Returns
True if the task should be deleted once terminated.

◆ DeleteOnCompletion() [3/3]

bool LDASTools::AL::Task::DeleteOnCompletion ( ) const
inherited

Retrieve state information concearning deletion.

Returns
True if the task should be deleted once terminated.

◆ OnCompletion() [1/3]

virtual void LDASTools::AL::Task::OnCompletion ( int  TaskThreadState)
virtualinherited

Action to be done when task completes.

◆ OnCompletion() [2/3]

virtual void LDASTools::AL::Task::OnCompletion ( int  TaskThreadState)
virtualinherited

Action to be done when task completes.

◆ OnCompletion() [3/3]

void LDASTools::AL::Task::OnCompletion ( int  TaskThreadState)
virtualinherited

Action to be done when task completes.

This function is called regardless of why the task was terminated. It allows for any special cleanup or other action that needs to happen at the end of a task regardless of why the task terminated.

◆ operator()()

virtual void anonymous_namespace{FileType.cc}::timed_filetype::operator() ( )
inlinevirtual

Action to perform.

Implements LDASTools::AL::Task.

◆ TaskName() [1/3]

name_type LDASTools::AL::Task::TaskName ( ) const
inherited

Get the name of the current task.

◆ TaskName() [2/3]

Task::name_type LDASTools::AL::Task::TaskName ( ) const
inlineinherited

Get the name of the current task.

◆ TaskName() [3/3]

name_type LDASTools::AL::Task::TaskName ( ) const
inherited

Get the name of the current task.

◆ taskName() [1/3]

void LDASTools::AL::Task::taskName ( const std::string &  Name)
protectedinherited

◆ taskName() [2/3]

void LDASTools::AL::Task::taskName ( const std::string &  Name)
inlineprotectedinherited

◆ taskName() [3/3]

void LDASTools::AL::Task::taskName ( const std::string &  Name)
protectedinherited

Member Data Documentation

◆ m_file

const std::string anonymous_namespace{FileType.cc}::timed_filetype::m_file
private

◆ m_file_type

std::string anonymous_namespace{FileType.cc}::timed_filetype::m_file_type
private

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