Scippy

UG

Ubiquity Generator framework

TaskId Class Reference

TaskId class. More...

#include <paraTask.h>

Public Member Functions

 TaskId ()
 default constructor More...
 
 TaskId (const TaskId &taskId)
 copy constructor More...
 
 TaskId (SubtaskId inSubtreeId, int inSeqNum)
 constructor More...
 
 ~TaskId ()
 destructor More...
 
TaskIdoperator= (const UG::TaskId &taskId)
 = operator definition More...
 
bool operator== (const TaskId &inNid) const
 == operator definition More...
 
bool operator!= (const TaskId &inNid) const
 != operator definition More...
 
bool operator< (const TaskId &inNid) const
 < operator definition More...
 
SubtaskId getSubtaskId () const
 getter of subtask id More...
 
long long getSeqNum () const
 getter of sequence number More...
 
std::string toString ()
 stringfy task id More...
 

Public Attributes

SubtaskId subtaskId
 subtree id More...
 
long long seqNum
 sequential number in the subtree More...
 

Detailed Description

TaskId class.

Definition at line 222 of file paraTask.h.

Constructor & Destructor Documentation

◆ TaskId() [1/3]

TaskId ( )

default constructor

Definition at line 233 of file paraTask.h.

◆ TaskId() [2/3]

TaskId ( const TaskId taskId)

copy constructor

Definition at line 243 of file paraTask.h.

References TaskId::seqNum, and TaskId::subtaskId.

◆ TaskId() [3/3]

TaskId ( SubtaskId  inSubtreeId,
int  inSeqNum 
)

constructor

Parameters
inSubtreeIdsubtree id
inSeqNumsequential number in the subtree

Definition at line 254 of file paraTask.h.

◆ ~TaskId()

~TaskId ( )

destructor

Definition at line 266 of file paraTask.h.

Member Function Documentation

◆ getSeqNum()

long long getSeqNum ( ) const

getter of sequence number

Returns
the sequence number

Definition at line 343 of file paraTask.h.

References TaskId::seqNum.

◆ getSubtaskId()

SubtaskId getSubtaskId ( ) const

getter of subtask id

Returns
the subtask id

Definition at line 333 of file paraTask.h.

References TaskId::subtaskId.

◆ operator!=()

bool operator!= ( const TaskId inNid) const

!= operator definition

Returns
true if task id is not equal to that given by argument

Definition at line 303 of file paraTask.h.

References TaskId::seqNum, and TaskId::subtaskId.

◆ operator<()

bool operator< ( const TaskId inNid) const

< operator definition

Returns
true if task is less than that given by argument

Definition at line 318 of file paraTask.h.

References TaskId::seqNum, and TaskId::subtaskId.

◆ operator=()

TaskId & operator= ( const UG::TaskId taskId)

= operator definition

Returns
reference to TaskId

Definition at line 275 of file paraTask.h.

References TaskId::seqNum, and TaskId::subtaskId.

◆ operator==()

bool operator== ( const TaskId inNid) const

== operator definition

Returns
true if task id is equal to that given by argument
Parameters
inNidtask id

Definition at line 288 of file paraTask.h.

References TaskId::seqNum, and TaskId::subtaskId.

◆ toString()

std::string toString ( )

Member Data Documentation

◆ seqNum

◆ subtaskId