Jpp 19.3.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
JNET::JSubscription Class Reference

ControlHost subscription. More...

#include <JControlHost.hh>

Inheritance diagram for JNET::JSubscription:
JNET::JTag JNET::JSubscriptionAll JNET::JSubscriptionAny

Public Member Functions

 JSubscription (const JSubscription_t sub, const JTag &tag)
 Constructor.
 
JSubscription_t getSubscription () const
 Get subscription type.
 
std::string toString () const
 Convert subscription to string.
 
const JTaggetTag () const
 Get tag.
 
JTaggetTag ()
 Get tag.
 
void setTag (const JTag &tag)
 Set tag.
 
void setTag (const std::string &tag)
 Set tag.
 
void setTag (const JTag_t id)
 Set tag.
 
JTag_t getID () const
 Get identifier.
 
 operator std::string () const
 Type conversion operators.
 
const char * c_str () const
 C-string.
 
const char operator[] (int i) const
 Get character.
 

Protected Attributes

JSubscription_t subscription
 
JTag_t id
 

Detailed Description

ControlHost subscription.

Definition at line 50 of file JControlHost.hh.

Constructor & Destructor Documentation

◆ JSubscription()

JNET::JSubscription::JSubscription ( const JSubscription_t sub,
const JTag & tag )
inline

Constructor.

Parameters
subsubscription
tagtag

Definition at line 60 of file JControlHost.hh.

61 :
62 JTag (tag),
63 subscription(sub)
64 {}
JSubscription_t subscription
JTag()
Default constructor.
Definition JTag.hh:43

Member Function Documentation

◆ getSubscription()

JSubscription_t JNET::JSubscription::getSubscription ( ) const
inline

Get subscription type.

Returns
subscription

Definition at line 72 of file JControlHost.hh.

73 {
74 return subscription;
75 }

◆ toString()

std::string JNET::JSubscription::toString ( ) const
inline

Convert subscription to string.

Returns
subscription

Definition at line 83 of file JControlHost.hh.

84 {
85 return std::string(1, (char) subscription) + " " + JTag::toString();
86 }
std::string toString() const
Convert tag to string.
Definition JTag.hh:171

◆ getTag() [1/2]

const JTag & JNET::JTag::getTag ( ) const
inlineinherited

Get tag.

Returns
tag

Definition at line 86 of file JTag.hh.

87 {
88 return static_cast<const JTag&>(*this);
89 }

◆ getTag() [2/2]

JTag & JNET::JTag::getTag ( )
inlineinherited

Get tag.

Returns
tag

Definition at line 97 of file JTag.hh.

98 {
99 return static_cast<JTag&>(*this);
100 }

◆ setTag() [1/3]

void JNET::JTag::setTag ( const JTag & tag)
inlineinherited

Set tag.

Parameters
tagtag

Definition at line 108 of file JTag.hh.

109 {
110 id = tag.getID();
111 }

◆ setTag() [2/3]

void JNET::JTag::setTag ( const std::string & tag)
inlineinherited

Set tag.

This method may throw an exception.

Parameters
tagtag

Definition at line 121 of file JTag.hh.

122 {
123 if (!tag.empty() && tag.size() <= TAGSIZE) {
124
125 char* __p = (char*) &(this->id);
126
127 size_t i = 0;
128
129 for ( ; i != tag.size(); ++i) {
130 __p[i] = tag[i];
131 }
132
133 for ( ; i != TAGSIZE; ++i) {
134 __p[i] = '\0';
135 }
136
137 } else {
138
139 THROW(JControlHostException, "Invalid tag length <" << tag << "> " << tag.size());
140 }
141 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
static const size_t TAGSIZE
Size of ControlHost tag.
Definition JTag.hh:32

◆ setTag() [3/3]

void JNET::JTag::setTag ( const JTag_t id)
inlineinherited

Set tag.

Parameters
ididentifier

Definition at line 149 of file JTag.hh.

150 {
151 this->id = id;
152 }
JTag_t id
Definition JTag.hh:254

◆ getID()

JTag_t JNET::JTag::getID ( ) const
inlineinherited

Get identifier.

Returns
identifier

Definition at line 160 of file JTag.hh.

161 {
162 return id;
163 }

◆ operator std::string()

JNET::JTag::operator std::string ( ) const
inlineinherited

Type conversion operators.

Returns
tag

Definition at line 190 of file JTag.hh.

191 {
192 return toString();
193 }

◆ c_str()

const char * JNET::JTag::c_str ( ) const
inlineinherited

C-string.

Returns
tag

Definition at line 201 of file JTag.hh.

202 {
203 return (const char*) &(this->id);
204 }

◆ operator[]()

const char JNET::JTag::operator[] ( int i) const
inlineinherited

Get character.

Parameters
iindex
Returns
character at index

Definition at line 213 of file JTag.hh.

214 {
215 const char* __p = (const char*) &(this->id);
216
217 return __p[i];
218 }

Member Data Documentation

◆ subscription

JSubscription_t JNET::JSubscription::subscription
protected

Definition at line 90 of file JControlHost.hh.

◆ id

JTag_t JNET::JTag::id
protectedinherited

Definition at line 254 of file JTag.hh.


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