org.javaseis.properties
Class SeisTraceProperty

java.lang.Object
  org.javaseis.properties.SeisTraceProperty

public class SeisTraceProperty
extends java.lang.Object

Title: JavaSeis Property Description

Description: Defines basic description for trace properties

Copyright: Copyright (c) 2005

Company: JavaSeis.org

Version:

1.0

Author:

Chuck Mosher

Field Summary

(package private) java.lang.String	_description
(package private) int	_length
(package private) java.lang.String	_name
(package private) int	_nvals
(package private) int	_offset
(package private) SeisPropertyType	_type

Constructor Summary

SeisTraceProperty()
Construct a trace property description

SeisTraceProperty(SeisTraceProperty prop)

SeisTraceProperty(java.lang.String name, java.lang.String s)
Construct a trace property description from a string

SeisTraceProperty(java.lang.String name, java.lang.String description, SeisPropertyType type, int nvals, int offset)

Method Summary

SeisTraceProperty	clone()
java.lang.String	getDescription()
int	getLength()
java.lang.String	getName()
int	getNvals()
int	getOffset()
SeisPropertyType	getType()
void	set(java.lang.String name, java.lang.String s)
void	set(java.lang.String name, java.lang.String description, SeisPropertyType type, int nvals, int offset)
void	setOffset(int offset)
java.lang.String	toPropString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_description

java.lang.String _description

_length

int _length

_name

java.lang.String _name

_nvals

int _nvals

_offset

int _offset

_type

SeisPropertyType _type

Constructor Detail

SeisTraceProperty

public SeisTraceProperty()

Construct a trace property description

Parameters:

name - Name for the trace property

description - Description of this property

type - Property type, selected from Enumerated Type SeisPropertyType

nvals - Number of values for this property (if an array), or number of characters (if a string)

offset - Offset in trace header template of this property

SeisTraceProperty

public SeisTraceProperty(SeisTraceProperty prop)

SeisTraceProperty

public SeisTraceProperty(java.lang.String name,
                         java.lang.String s)
                  throws SeisException

Construct a trace property description from a string

Parameters:

name - String defining the name of this property

s - String containing description, type, nvals, offset in same format as defined by toString.

Throws:

SeisException - if invalid string or type cannot be matched

SeisTraceProperty

public SeisTraceProperty(java.lang.String name,
                         java.lang.String description,
                         SeisPropertyType type,
                         int nvals,
                         int offset)

Method Detail

clone

public SeisTraceProperty clone()

Overrides:

clone in class java.lang.Object

getDescription

public java.lang.String getDescription()

getLength

public int getLength()

getName

public java.lang.String getName()

getNvals

public int getNvals()

getOffset

public int getOffset()

getType

public SeisPropertyType getType()

set

public void set(java.lang.String name,
                java.lang.String s)
         throws SeisException

Throws:

SeisException

set

public void set(java.lang.String name,
                java.lang.String description,
                SeisPropertyType type,
                int nvals,
                int offset)

setOffset

public void setOffset(int offset)

toPropString

public java.lang.String toPropString()