SG++
python.data.DataSpecification.DataSpecification Class Reference

The class encapsulates the description of the data set, like names of dimensions and source file. More...

Inheritance diagram for python.data.DataSpecification.DataSpecification:

Public Member Functions

def __init__ (self)
 Constructor. More...
 
def addAttribute (self, attributeName, attributeValue)
 Adds an attribute to the attribute collection. More...
 
def cleanAttributes (self)
 Deletes all data from attributes collection. More...
 
def createNumericAttributes (self, dim)
 Fills data specification with a number of numeric attributes with names x0, x1, x2... More...
 
def generateFilename (self)
 Generates a new random file name. More...
 
def getAttributes (self)
 Returns the collection of attributes stored in the specification. More...
 
def getFilename (self)
 Returns the file name. More...
 
def isSaved (self)
 Checks if the data set was already saved as a file. More...
 
def setFilename (self, filename)
 Sets the file name. More...
 
def setSaved (self)
 Marks the data set as saved. More...
 
def toString (self)
 Returns a string that represents the object. More...
 

Static Public Attributes

 attributes = None
 Dictionary of attributes. More...
 
 filename = None
 The file name. More...
 

Detailed Description

The class encapsulates the description of the data set, like names of dimensions and source file.

Constructor & Destructor Documentation

Member Function Documentation

def python.data.DataSpecification.DataSpecification.addAttribute (   self,
  attributeName,
  attributeValue 
)

Adds an attribute to the attribute collection.

Parameters
attributeNameattribute name
attributeValueattribute value

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.createNumericAttributes().

def python.data.DataSpecification.DataSpecification.cleanAttributes (   self)
def python.data.DataSpecification.DataSpecification.createNumericAttributes (   self,
  dim 
)

Fills data specification with a number of numeric attributes with names x0, x1, x2...

Parameters
dimthe number of attributes

References json::DictNode.addAttribute(), python.data.DataSpecification.DataSpecification.addAttribute(), json::Node.addAttribute(), and python.data.DataSpecification.DataSpecification.cleanAttributes().

def python.data.DataSpecification.DataSpecification.generateFilename (   self)

Generates a new random file name.

Returns
: new random file name

Referenced by python.data.DataSpecification.DataSpecification.getFilename().

def python.data.DataSpecification.DataSpecification.getAttributes (   self)

Returns the collection of attributes stored in the specification.

Returns
: collection of attributes

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.toString().

def python.data.DataSpecification.DataSpecification.isSaved (   self)

Checks if the data set was already saved as a file.

Returns
: True, if data set was saved, otherwise: False

References python.data.DataSpecification.DataSpecification.__isSaved.

def python.data.DataSpecification.DataSpecification.setFilename (   self,
  filename 
)
def python.data.DataSpecification.DataSpecification.setSaved (   self)

Marks the data set as saved.

References python.data.DataSpecification.DataSpecification.__isSaved.

def python.data.DataSpecification.DataSpecification.toString (   self)

Member Data Documentation


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