1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
use crate::traits::{
SEEvent, SEIdentifiedObject, SEList, SEResource, SERespondableResource,
SERespondableSubscribableIdentifiedObject, SESubscribableIdentifiedObject, SESubscribableList,
SESubscribableResource, Validate,
};
use sep2_common_derive::{
SEEvent, SEIdentifiedObject, SEList, SEResource, SERespondableResource,
SERespondableSubscribableIdentifiedObject, SESubscribableIdentifiedObject, SESubscribableList,
SESubscribableResource,
};
use super::{
identification::ResponseRequired,
links::{ActiveTextMessageListLink, TextMessageListLink},
objects::EventStatus,
primitives::{String20, String32, Uint32},
types::{
DateTimeInterval, LocaleType, MRIDType, PrimacyType, SubscribableType, TimeType,
VersionType,
},
};
use yaserde::{YaDeserialize, YaSerialize};
/// Provides a container for collections of text messages.
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SESubscribableIdentifiedObject,
SEIdentifiedObject,
SESubscribableResource,
SEResource,
)]
#[yaserde(rename = "MessagingProgram")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct MessagingProgram {
#[yaserde(rename = "ActiveTextMessageListLink")]
pub active_text_message_list_link: Option<ActiveTextMessageListLink>,
/// Indicates the language and region of the messages in this collection.
#[yaserde(rename = "locale")]
pub locale: LocaleType,
/// Indicates the relative primacy of the provider of this program.
#[yaserde(rename = "primacy")]
pub primacy: PrimacyType,
#[yaserde(rename = "TextMessageListLink")]
pub text_message_list_link: Option<TextMessageListLink>,
/// The global identifier of the object.
#[yaserde(rename = "mRID")]
pub mrid: MRIDType,
/// The description is a human readable text describing or naming the object.
#[yaserde(rename = "description")]
pub description: Option<String32>,
/// Contains the version number of the object. See the type definition for
/// details.
#[yaserde(rename = "version")]
pub version: Option<VersionType>,
/// Indicates whether or not subscriptions are supported for this resource,
/// and whether or not conditional (thresholds) are supported. If not
/// specified, is "not subscribable" (0).
#[yaserde(attribute, rename = "subscribable")]
pub subscribable: Option<SubscribableType>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl PartialOrd for MessagingProgram {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for MessagingProgram {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - mRID (descending)
self.mrid.cmp(&other.mrid)
}
}
impl Validate for MessagingProgram {}
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SESubscribableList,
SEList,
SESubscribableResource,
SEResource,
)]
#[yaserde(rename = "MessagingProgramList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct MessagingProgramList {
#[yaserde(rename = "MessagingProgram")]
pub messaging_program: Vec<MessagingProgram>,
/// The default polling rate for this function set (this resource and all
/// resources below), in seconds. If not specified, a default of 900 seconds
/// (15 minutes) is used. It is RECOMMENDED a client poll the resources of
/// this function set every pollRate seconds.
#[yaserde(attribute, rename = "pollRate")]
pub poll_rate: Option<Uint32>,
/// The number specifying "all" of the items in the list. Required on GET,
/// ignored otherwise.
#[yaserde(attribute, rename = "all")]
pub all: Uint32,
/// Indicates the number of items in this page of results.
#[yaserde(attribute, rename = "results")]
pub results: Uint32,
/// Indicates whether or not subscriptions are supported for this resource,
/// and whether or not conditional (thresholds) are supported. If not
/// specified, is "not subscribable" (0).
#[yaserde(attribute, rename = "subscribable")]
pub subscribable: Option<SubscribableType>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl Validate for MessagingProgramList {}
#[derive(Default, PartialEq, Eq, Debug, Clone, Copy, YaSerialize, YaDeserialize)]
#[yaserde(rename = "PriorityType")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
#[repr(u8)]
pub enum PriorityType {
#[default]
Low = 0,
Normal = 1,
High = 2,
Critical = 3,
// 4-255 RESERVED
}
impl Validate for PriorityType {}
/// Text message such as a notification.
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SEEvent,
SERespondableSubscribableIdentifiedObject,
SEIdentifiedObject,
SESubscribableResource,
SERespondableResource,
SEResource,
)]
#[yaserde(rename = "TextMessage")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct TextMessage {
/// Indicates the human-readable name of the publisher of the message
#[yaserde(rename = "originator")]
pub originator: Option<String20>,
/// The priority is used to inform the client of the priority of the
/// particular message. Devices with constrained or limited resources for
/// displaying Messages should use this attribute to determine how to handle
/// displaying currently active Messages (e.g. if a device uses a scrolling
/// method with a single Message viewable at a time it MAY want to push a low
/// priority Message to the background and bring a newly received higher
/// priority Message to the foreground).
#[yaserde(rename = "priority")]
pub priority: PriorityType,
/// The textMessage attribute contains the actual UTF-8 encoded text to be
/// displayed in conjunction with the messageLength attribute which contains
/// the overall length of the textMessage attribute. Clients and servers
/// SHALL support a reception of a Message of 100 bytes in length. Messages
/// that exceed the clients display size will be left to the client to choose
/// what method to handle the message (truncation, scrolling, etc.).
#[yaserde(rename = "textMessage")]
pub text_message: String,
/// The time at which the Event was created.
#[yaserde(rename = "creationTime")]
pub creation_time: TimeType,
#[yaserde(rename = "EventStatus")]
pub event_status: EventStatus,
/// The period during which the Event applies.
#[yaserde(rename = "interval")]
pub interval: DateTimeInterval,
/// The global identifier of the object.
#[yaserde(rename = "mRID")]
pub mrid: MRIDType,
/// The description is a human readable text describing or naming the object.
#[yaserde(rename = "description")]
pub description: Option<String32>,
/// Contains the version number of the object. See the type definition for
/// details.
#[yaserde(rename = "version")]
pub version: Option<VersionType>,
/// Indicates whether or not subscriptions are supported for this resource,
/// and whether or not conditional (thresholds) are supported. If not
/// specified, is "not subscribable" (0).
#[yaserde(attribute, rename = "subscribable")]
pub subscribable: Option<SubscribableType>,
/// A reference to the response resource address (URI). Required on a
/// response to a GET if responseRequired is "true".
#[yaserde(attribute, rename = "replyTo")]
pub reply_to: Option<String>,
/// Indicates whether or not a response is required upon receipt, creation or
/// update of this resource. Responses shall be posted to the collection
/// specified in "replyTo".
/// If the resource has a deviceCategory field, devices that match one or
/// more of the device types indicated in deviceCategory SHALL respond
/// according to the rules listed below. If the category does not match, the
/// device SHALL NOT respond. If the resource does not have a deviceCategory
/// field, a device receiving the resource SHALL respond according to the
/// rules listed below.
/// Value encoded as hex according to the following bit assignments, any
/// combination is possible.
/// See Table 27 for the list of appropriate Response status codes to be sent
/// for these purposes.
/// 0 - End device shall indicate that message was received
/// 1 - End device shall indicate specific response.
/// 2 - End user / customer response is required.
/// All other values reserved.
#[yaserde(attribute, rename = "responseRequired")]
pub response_required: Option<ResponseRequired>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl PartialOrd for TextMessage {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for TextMessage {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - mRID (ascending)
match self.interval.start.cmp(&other.interval.start) {
core::cmp::Ordering::Equal => {}
ord => return ord,
}
// Secondary Key - createdDateTime (descending)
match self.creation_time.cmp(&other.creation_time).reverse() {
core::cmp::Ordering::Equal => {}
ord => return ord,
}
// Tertiary Key - mRID (descending)
self.mrid.cmp(&other.mrid).reverse()
}
}
impl Validate for TextMessage {}
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize)]
#[yaserde(rename = "TextMessageList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct TextMessageList {
#[yaserde(rename = "TextMessage")]
pub text_message: Vec<TextMessage>,
/// The number specifying "all" of the items in the list. Required on GET,
/// ignored otherwise.
#[yaserde(attribute, rename = "all")]
pub all: Uint32,
/// Indicates the number of items in this page of results.
#[yaserde(attribute, rename = "results")]
pub results: Uint32,
/// Indicates whether or not subscriptions are supported for this resource,
/// and whether or not conditional (thresholds) are supported. If not
/// specified, is "not subscribable" (0).
#[yaserde(attribute, rename = "subscribable")]
pub subscribable: Option<SubscribableType>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl Validate for TextMessageList {}