[eman] Framework psudo code

Brad Schoening <brads@coraid.com> Mon, 28 October 2013 02:47 UTC

Return-Path: <brads@coraid.com>
X-Original-To: eman@ietfa.amsl.com
Delivered-To: eman@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 90B9611E8215 for <eman@ietfa.amsl.com>; Sun, 27 Oct 2013 19:47:59 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -0.798
X-Spam-Level:
X-Spam-Status: No, score=-0.798 tagged_above=-999 required=5 tests=[AWL=-1.800, BAYES_50=0.001, EXTRA_MPART_TYPE=1, HTML_MESSAGE=0.001]
Received: from mail.ietf.org ([12.22.58.30]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dV2OuUEj5ynC for <eman@ietfa.amsl.com>; Sun, 27 Oct 2013 19:47:53 -0700 (PDT)
Received: from server506.appriver.com (server506f.appriver.com [50.56.144.36]) by ietfa.amsl.com (Postfix) with ESMTP id 5F1B611E82EB for <eman@ietf.org>; Sun, 27 Oct 2013 19:47:52 -0700 (PDT)
X-Note-AR-ScanTimeLocal: 10/27/2013 9:47:47 PM
X-Policy: GLOBAL - coraid.com
X-Primary: brads@coraid.com
X-Note: This Email was scanned by AppRiver SecureTide
X-Virus-Scan: V-
X-Note: ICH-CT/SI:0-428/SG:1 10/27/2013 9:46:52 PM
X-Note-SnifferID: 0
X-Note: TCH-CT/SI:0-152/SG:8 10/27/2013 9:47:00 PM
X-GBUdb-Analysis: 0, 10.242.229.139, Ugly c=1 p=-0.900842 Source White
X-Signature-Violations: 0-0-0-32767-c
X-Note-419: 0 ms. Fail:0 Chk:1349 of 1349 total
X-Note: SCH-CT/SI:0-1349/SG:1 10/27/2013 9:47:39 PM
X-Note: Spam Tests Failed:
X-Country-Path: UNKNOWN->PRIVATE->UNITED STATES
X-Note-Sending-IP: 10.242.229.139
X-Note-Reverse-DNS: smtp.exg6.exghost.com
X-Note-Return-Path: brads@coraid.com
X-Note: User Rule Hits:
X-Note: Global Rule Hits: G325 G326 G327 G328 G332 G333 G443 G455
X-Note: Encrypt Rule Hits:
X-Note: Mail Class: VALID
X-Note: Headers Injected
Received: from [10.242.229.139] (HELO smtp.exg6.exghost.com) by server506.appriver.com (CommuniGate Pro SMTP 6.0.2) with ESMTPS id 125726832 for eman@ietf.org; Sun, 27 Oct 2013 21:47:47 -0500
Received: from DAGN05C-E6.exg6.exghost.com ([169.254.3.11]) by HT03-E6.exg6.exghost.com ([50.56.144.21]) with mapi id 14.03.0158.001; Sun, 27 Oct 2013 21:47:47 -0500
From: Brad Schoening <brads@coraid.com>
To: "eman@ietf.org" <eman@ietf.org>
Thread-Topic: Framework psudo code
Thread-Index: AQHO04gV7aqBGZSSm0KUJp/zTOMd/Q==
Date: Mon, 28 Oct 2013 02:47:46 +0000
Message-ID: <CE92D013.F2111%brads@coraid.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach: yes
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/14.14.0.111121
x-originating-ip: [50.56.144.246]
x-rerouted-by-exchange:
Content-Type: multipart/related; boundary="_004_CE92D013F2111bradscoraidcom_"; type="multipart/alternative"
MIME-Version: 1.0
Subject: [eman] Framework psudo code
X-BeenThere: eman@ietf.org
X-Mailman-Version: 2.1.12
Precedence: list
List-Id: Discussions about the Energy Management Working Group <eman.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/eman>, <mailto:eman-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/eman>
List-Post: <mailto:eman@ietf.org>
List-Help: <mailto:eman-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/eman>, <mailto:eman-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 28 Oct 2013 02:48:02 -0000

Dear all,

I'm wondering if the pseudo code in the framework could be more clearly represented using a tabular format similar to what the IEC, DMTF and Ecma-400 use for their CIM objects.  Consider an example:

Our pseudo code:


        CLASS Measurement {
              multiplier: enum { -24..24}
              caliber   : enum { actual, estimated, static }
              accuracy  : enum { 0..10000} // hundreds of percent
        }



Re-written in a tabular format:

1.0 Measurement Class
Properties

Description

Type

Get/Set

Requirement

Multiplier

Base 10 exponent

Enum

G

Mandatory

Caliber

Actual, estimate, or static

Enum

G

Optional

Accuracy

Hundredths of percent

Enum

G

Optional


Below is a sample class definition taken from IEC-61850.  Also, note the use of object-oriented class inheritance in the IEC model representation and use of attribute protocols for 'descriptions', 'controls' and 'settings':

[cid:9E19F038-2659-44D7-BCEE-F70117F77C65]