CASI - ChannelArchiver Scripting Interface

[ Module : casi, Package : casi ]

---

Contents

• 1. Accessing an Archive
  • 1.1. class archive
• 2. Channel Information
  • 2.1. class channel
• 3. Value Information
  • 3.1. class value
• 4. Misc.
• 5. Questions, comments?

This scriping interface is meant to mimic the behaviour of the C++ LibIO API to the ChannelArchiver as close as possible. Therefore you might consider crosschecking with that documentation. Most functions can generate a RuntimeError or an UnknownError.

$casi_version = 1.0

[ Constant: char * ]

---

1. Accessing an Archive

1.1. class archive

[ created from class archive ]

new();

[ Constructor: returns archive * ]

DESTROY

[ Destructor ]

open(name);

[ Member : returns bool ]

findFirstChannel(channel);

[ Member : returns bool ]

findChannelByName(name,channel);

[ Member : returns bool ]

findChannelByPattern(pattern,channel);

[ Member : returns bool ]

name();

[ Member : returns char * ]

write(name,hours_per_file);

[ Member : returns bool ]

addChannel(name,channel);

[ Member : returns bool ]

nextFileTime(current_time);

[ Member : returns char * ]

---

2. Channel Information

2.1. class channel

[ created from class channel ]

new();

[ Constructor: returns channel * ]

DESTROY

[ Destructor ]

valid();

[ Member : returns bool ]

name();

[ Member : returns char * ]

next();

[ Member : returns bool ]

getFirstTime();

[ Member : returns char * ]

getLastTime();

[ Member : returns char * ]

getFirstValue(value);

[ Member : returns bool ]

getLastValue(value);

[ Member : returns bool ]

getValueAfterTime(time,value);

[ Member : returns bool ]

getValueBeforeTime(time,value);

[ Member : returns bool ]

getValueNearTime(time,value);

[ Member : returns bool ]

lockBuffer(value);

[ Member : returns int ]

addBuffer(value,value_count);

[ Member : returns void ]

addValue(value);

[ Member : returns bool ]

releaseBuffer();

[ Member : returns void ]

---

3. Value Information

3.1. class value

[ created from class value ]

new();

[ Constructor: returns value * ]

DESTROY

[ Destructor ]

valid();

[ Member : returns bool ]

isInfo();

[ Member : returns bool ]

type();

[ Member : returns char * ]

count();

[ Member : returns int ]

get();

[ Member : returns double ]

getidx(index);

[ Member : returns double ]

text();

[ Member : returns char * ]

time();

[ Member : returns char * ]

getDoubleTime();

[ Member : returns double ]

status();

[ Member : returns char * ]

next();

[ Member : returns bool ]

prev();

[ Member : returns bool ]

determineChunk(until);

[ Member : returns int ]

---

4. Misc.

$HOURS_PER_MONTH = 24*31

[ Constant: int ]
depends on month, ... this is a magic number

---

5. Questions, comments?

Let me know: Kay-Uwe Kasemir, kasemir@lanl.gov