WSF
WsfTaskControlMessage.hpp
Go to the documentation of this file.
1// ****************************************************************************
2// CUI
3//
4// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
5//
6// Copyright 2003-2015 The Boeing Company. All rights reserved.
7//
8// The use, dissemination or disclosure of data in this file is subject to
9// limitation or restriction. See accompanying README and LICENSE for details.
10// ****************************************************************************
11
12#ifndef WSFTASKCONTROLMESSAGE_HPP
13#define WSFTASKCONTROLMESSAGE_HPP
14
15#include "wsf_export.h"
16
17#include <memory>
18#include <string>
19
20class UtScriptClass;
21class UtScriptTypes;
22#include "WsfMessage.hpp"
23class WsfPlatform;
24class WsfProcessor;
25#include "WsfStringId.hpp"
26
36{
37public:
38 WsfTaskControlMessage(); // For XIO (de)serialization.
40
41 static std::unique_ptr<UtScriptClass> CreateScriptClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);
42
43 WsfMessage* Clone() const override;
44
45 const char* GetScriptClassName() const override;
46
47 static WsfStringId GetTypeId();
48
50
51 WsfPlatform* GetAssigner() const;
52
55
57 void SetAssignerPlatformIndex(size_t aIndex) { mAssignerPlatformIndex = aIndex; }
58
61
64
66
68
69 WsfPlatform* GetAssignee() const;
70
73
75 void SetAssigneePlatformIndex(size_t aIndex) { mAssigneePlatformIndex = aIndex; }
76
79
83
85
86
87 WsfStringId GetName() const { return mName; }
88
90 void SetName(WsfStringId aName) { mName = aName; }
91
93 void SetName(const std::string& aName) { mName = aName; }
95
97
98
99 int GetLevel() const { return mLevel; }
100
101 void SetLevel(int aLevel) { mLevel = aLevel; }
103
105 template<typename T>
112
113protected:
114 // Using the default copy constructor.
115 // WsfTaskControlMessage(const WsfTaskControlMessage& aSrc);
116
119
122
125
128
131
134
137
140};
141
142#endif
UtStringId WsfStringId
WsfStringId – the same thing as UtStringId.
Definition WsfStringId.hpp:23
#define WSF_EXPORT
Definition WsfXIO_Export.hpp:35
WsfMessage(WsfStringId aType)
Constructor for XIO (de)serialization.
Definition WsfMessage.cpp:25
void Serialize(T &aBuff)
(De)serializer for XIO
Definition WsfMessage.hpp:207
const char * GetScriptClassName() const override
Definition WsfMessage.cpp:235
static WsfStringId GetTypeId()
Definition WsfMessage.cpp:159
virtual WsfMessage * Clone() const
Definition WsfMessage.cpp:150
Platforms represent a entity within the simulation.
Definition WsfPlatform.hpp:115
Definition WsfProcessor.hpp:39
WsfStringId mAssigneePlatformName
The name of the assignee.
Definition WsfTaskControlMessage.hpp:130
void Serialize(T &aBuff)
For XIO (de)serialization.
Definition WsfTaskControlMessage.hpp:106
size_t mAssignerPlatformIndex
The platform index of the assigner.
Definition WsfTaskControlMessage.hpp:118
WsfStringId mAssignerProcessorName
The name of the processor on the assigner.
Definition WsfTaskControlMessage.hpp:124
void SetAssignerPlatformIndex(size_t aIndex)
Set the platform index of the assigner.
Definition WsfTaskControlMessage.hpp:57
void SetLevel(int aLevel)
Definition WsfTaskControlMessage.hpp:101
int GetLevel() const
Get the operating level.
Definition WsfTaskControlMessage.hpp:99
WsfStringId GetAssignerProcessorName() const
Get the name of the processor on the assigner.
Definition WsfTaskControlMessage.hpp:63
WsfStringId GetAssigneePlatformName() const
Get the name of the assignee.
Definition WsfTaskControlMessage.hpp:78
void SetName(WsfStringId aName)
Set the name of the operating condition or status whose level is being changed (ID form).
Definition WsfTaskControlMessage.hpp:90
WsfPlatform * GetAssigner() const
Definition WsfTaskControlMessage.cpp:79
WsfStringId mName
The name of the condition or status whose operating level is being changed.
Definition WsfTaskControlMessage.hpp:136
size_t GetAssignerPlatformIndex() const
Get the platform index of the assigner.
Definition WsfTaskControlMessage.hpp:54
WsfStringId GetName() const
Get the name of the operating condition or status whose level is being changed.
Definition WsfTaskControlMessage.hpp:87
size_t mAssigneePlatformIndex
The platform index of the assignee.
Definition WsfTaskControlMessage.hpp:127
WsfStringId GetAssignerPlatformName() const
Get the name of the assigner.
Definition WsfTaskControlMessage.hpp:60
size_t GetAssigneePlatformIndex() const
Get the platform index of the assignee.
Definition WsfTaskControlMessage.hpp:72
WsfStringId mAssigneeProcessorName
The name of the processor on the assignee.
Definition WsfTaskControlMessage.hpp:133
int mLevel
The level to which the condition or status is being changed.
Definition WsfTaskControlMessage.hpp:139
static std::unique_ptr< UtScriptClass > CreateScriptClass(const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
Definition WsfTaskControlMessage.cpp:102
WsfTaskControlMessage()
Constructor, for XIO (de)serialization.
Definition WsfTaskControlMessage.cpp:25
WsfStringId GetAssigneeProcessorName() const
Get the name of the processor on the assignee.
Definition WsfTaskControlMessage.hpp:81
void SetAssigneePlatformIndex(size_t aIndex)
Set the platform index of the assignee.
Definition WsfTaskControlMessage.hpp:75
void SetName(const std::string &aName)
Set the name of the operating condition or status whose level is being changed (string form).
Definition WsfTaskControlMessage.hpp:93
WsfStringId mAssignerPlatformName
The name of the assigner.
Definition WsfTaskControlMessage.hpp:121
Copyrights Multiple, All Rights Reserved