WSF
Classes | Enumerations | Functions
wsf::comm::medium Namespace Reference

Classes

class  Mode
class  ScriptMediumModeClass
 The base Medium Mode script class. More...
class  Medium
class  ScriptMediumClass
class  Container
class  ContainerComponent
class  ContainerFactory
 A template class for common medium component factory registration. More...
class  FactoryInterface
class  Factory
class  FactoryManager
class  ModeGuided
 A mode implementation for common guided legacy usage. More...
class  ScriptMediumModeGuidedClass
 The guided mode script class. More...
class  Guided
class  MessageStatus
class  ScriptMediumMessageStatusClass
struct  Role
struct  cMEDIUM_ROLE
class  Types
class  ModeUnguided
 A mode implementation for common legacy unguided usage. More...
class  ScriptMediumModeUnguidedClass
 The unguided mode script class. More...
class  Unguided

Enumerations

enum class  TransmissionResult : size_t {
  cFAILURE_UNSPECIFIED , cSUCCESS , cFAILURE_CHANNEL_LIMIT_REACHED , cFAILURE_NONEXISTENT_RECEIVER ,
  cFAILURE_UNCONNECTED_RECEIVER , cFAILURE_EM_INTERACTION
}
enum  TypeIdentifier : int { cNONE = 0 , cGUIDED , cUNGUIDED }

Functions

 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeClass, Mode, GetName, 0, "string", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, ModeCount, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, CurrentModeIndex, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, CurrentModeName, 0, "string", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, GetCurrentMode, 0, "WsfCommMediumMode", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, GetMode_1, 1, "WsfCommMediumMode", "int")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, GetMode_2, 1, "WsfCommMediumMode", "string")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, ChannelCount, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, TransmissionCount, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, MessageStatusCount, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, GetMessageStatus, 3, "WsfCommMediumMessageStatus", "int, WsfAddress, WsfAddress")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, GetMessageStatusByIndex, 1, "WsfCommMediumMessageStatus", "int")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, IsShared, 0, "bool", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, SetMode_1, 1, "bool", "int")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumClass, Medium, SetMode_2, 1, "bool", "string")
WSF_EXPORT WsfStringId GetContainerComponentName ()
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeGuidedClass, ModeGuided, GetPropagationSpeed, 0, "WsfRandomVariable", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeGuidedClass, ModeGuided, GetTransferRate, 0, "WsfRandomVariable", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeGuidedClass, ModeGuided, GetPacketLossTime, 0, "WsfRandomVariable", "")
 WSF_COMM_MEDIUM_DECLARE_ROLE_TYPE (Guided, cGUIDED)
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumMessageStatusClass, MessageStatus, GetMessage, 0, "WsfCommMessage", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumMessageStatusClass, MessageStatus, IsTransmitting, 0, "bool", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumMessageStatusClass, MessageStatus, GetTimeStart, 0, "double", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumMessageStatusClass, MessageStatus, GetTimeTransmissionEnd, 0, "double", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumMessageStatusClass, MessageStatus, GetTimeDelivery, 0, "double", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumMessageStatusClass, MessageStatus, GetDeliveryFailure, 0, "bool", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumMessageStatusClass, MessageStatus, SetDeliveryFailure, 0, "bool", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeUnguidedClass, ModeUnguided, GetUseXferRateTable, 0, "bool", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeUnguidedClass, ModeUnguided, GetBitErrorProbability, 0, "double", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeUnguidedClass, ModeUnguided, GetErrorCorrection, 0, "double", "")
 UT_DEFINE_SCRIPT_METHOD (ScriptMediumModeUnguidedClass, ModeUnguided, GetUseBER_EbNoTable, 0, "bool", "")
 WSF_COMM_MEDIUM_DECLARE_ROLE_TYPE (Unguided, cUNGUIDED)

Enumeration Type Documentation

◆ TransmissionResult

enum class wsf::comm::medium::TransmissionResult : size_t
strong

A simple enum class used as a return value from some public API calls to provide more information on result of a transmission attempt using a medium.

Enumerator
cFAILURE_UNSPECIFIED 
cSUCCESS 
cFAILURE_CHANNEL_LIMIT_REACHED 
cFAILURE_NONEXISTENT_RECEIVER 
cFAILURE_UNCONNECTED_RECEIVER 
cFAILURE_EM_INTERACTION 

◆ TypeIdentifier

enum wsf::comm::medium::TypeIdentifier : int
Enumerator
cNONE 
cGUIDED 
cUNGUIDED 

Function Documentation

◆ GetContainerComponentName()

WSF_EXPORT WsfStringId wsf::comm::medium::GetContainerComponentName ( )

References GetContainerComponentName(), and WSF_EXPORT.

Referenced by wsf::comm::medium::ContainerComponent< PARENT >::GetComponentName(), and GetContainerComponentName().

◆ UT_DEFINE_SCRIPT_METHOD() [1/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
ChannelCount ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [2/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
CurrentModeIndex ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [3/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
CurrentModeName ,
0 ,
"string" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [4/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
GetCurrentMode ,
0 ,
"WsfCommMediumMode" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [5/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
GetMessageStatus ,
3 ,
"WsfCommMediumMessageStatus" ,
" int ,
WsfAddress ,
WsfAddress"  )

References wsf::comm::Message::Identifier::SetDestination(), wsf::comm::Message::Identifier::SetSerialNumber(), and wsf::comm::Message::Identifier::SetSource().

◆ UT_DEFINE_SCRIPT_METHOD() [6/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
GetMessageStatusByIndex ,
1 ,
"WsfCommMediumMessageStatus" ,
"int"  )

◆ UT_DEFINE_SCRIPT_METHOD() [7/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
GetMode_1 ,
1 ,
"WsfCommMediumMode" ,
"int"  )

◆ UT_DEFINE_SCRIPT_METHOD() [8/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
GetMode_2 ,
1 ,
"WsfCommMediumMode" ,
"string"  )

◆ UT_DEFINE_SCRIPT_METHOD() [9/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
IsShared ,
0 ,
"bool" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [10/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
MessageStatusCount ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [11/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
ModeCount ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [12/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
SetMode_1 ,
1 ,
"bool" ,
"int"  )

◆ UT_DEFINE_SCRIPT_METHOD() [13/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
SetMode_2 ,
1 ,
"bool" ,
"string"  )

◆ UT_DEFINE_SCRIPT_METHOD() [14/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumClass ,
Medium ,
TransmissionCount ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [15/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumMessageStatusClass ,
MessageStatus ,
GetDeliveryFailure ,
0 ,
"bool" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [16/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumMessageStatusClass ,
MessageStatus ,
GetMessage ,
0 ,
"WsfCommMessage" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [17/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumMessageStatusClass ,
MessageStatus ,
GetTimeDelivery ,
0 ,
"double" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [18/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumMessageStatusClass ,
MessageStatus ,
GetTimeStart ,
0 ,
"double" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [19/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumMessageStatusClass ,
MessageStatus ,
GetTimeTransmissionEnd ,
0 ,
"double" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [20/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumMessageStatusClass ,
MessageStatus ,
IsTransmitting ,
0 ,
"bool" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [21/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumMessageStatusClass ,
MessageStatus ,
SetDeliveryFailure ,
0 ,
"bool" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [22/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeClass ,
Mode ,
GetName ,
0 ,
"string" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [23/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeGuidedClass ,
ModeGuided ,
GetPacketLossTime ,
0 ,
"WsfRandomVariable" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [24/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeGuidedClass ,
ModeGuided ,
GetPropagationSpeed ,
0 ,
"WsfRandomVariable" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [25/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeGuidedClass ,
ModeGuided ,
GetTransferRate ,
0 ,
"WsfRandomVariable" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [26/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeUnguidedClass ,
ModeUnguided ,
GetBitErrorProbability ,
0 ,
"double" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [27/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeUnguidedClass ,
ModeUnguided ,
GetErrorCorrection ,
0 ,
"double" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [28/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeUnguidedClass ,
ModeUnguided ,
GetUseBER_EbNoTable ,
0 ,
"bool" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD() [29/29]

wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD ( ScriptMediumModeUnguidedClass ,
ModeUnguided ,
GetUseXferRateTable ,
0 ,
"bool" ,
""  )

◆ WSF_COMM_MEDIUM_DECLARE_ROLE_TYPE() [1/2]

wsf::comm::medium::WSF_COMM_MEDIUM_DECLARE_ROLE_TYPE ( Guided ,
cGUIDED  )

References cGUIDED.

◆ WSF_COMM_MEDIUM_DECLARE_ROLE_TYPE() [2/2]

wsf::comm::medium::WSF_COMM_MEDIUM_DECLARE_ROLE_TYPE ( Unguided ,
cUNGUIDED  )

References cUNGUIDED.

Copyrights Multiple, All Rights Reserved