class XSIL : public xobj

XSIL class is the light-weight container for encoded xsil objects

Inheritance:

Public Methods

XSIL(void)

default constructor.

XSIL(const char* Name, const char* Type=0)

Named structure constructor.

XSIL(const XSIL& x)

Copy constructor.

virtual ~XSIL(void)

Destructor.

virtual xobj* Clone(void) const

Clone a structure.

void Spew(Xwriter& ostr) const

Write XML.

xobj* addObject(const xobj& x)

Add an object.

virtual XSIL* addXSIL(const char* Name, const char* Type=0)

Add an XSIL substructure.

array* addArray(const char* Name, const char* Type=0, const char* Unit=0)

Add an array.

comment* addComment(const char* Text=0)

Add a comment.

param* addParam(const char* Name, const char* Type=0, const char* Unit=0, const char* Value=0)

Add a parameter.

param* addParam(const char* Name, const char* Unit, double Value)

Add a double float parameter.

param* addParam(const char* Name, const char* Unit, int Value)

Add an integer parameter.

table* addTable(const char* Name, const char* Type=0)

Add a table.

time* addTime(const char* Name, const char* Type=0, const char* Value=0)

Add a time.

time* addTime(const char* Name, const Time& t)

Add a time.

void erase(const xobj* x)

Remove an object.

const xobj* find(const char* name, const char* type=0) const

Find an object.

virtual const char* getObjType(void) const

Object type name.

Inherited from xobj:

Public Methods

const char* getName(void) const

const char* getType(void) const

const std::string& refName(void) const

const std::string& refType(void) const

void setName(const char* Name)

void setType(const char* Type)

XSIL(void)

XSil default constructor.

XSIL(const char* Name, const char* Type=0)

XSIL named structure constructor.

Parameters:

Name - Pointer to structure name string.
Type - Pointer to structure type string.

XSIL(const XSIL& x)

XSIL structure copy constructor.

Parameters:

x - Structure definition to be copied.

virtual ~XSIL(void)

Destructor.

virtual xobj* Clone(void) const

Clone a structure.

Returns:

opinter to a new object.

void Spew(Xwriter& ostr) const

Write XML structure to the specified writer.

Parameters:

ostr - XML output stream object.

xobj* addObject(const xobj& x)

Add a generic object.

Returns:

Pointer to the added structure definition.

Parameters:

x - object to be cloned into the xsil structure.

virtual XSIL* addXSIL(const char* Name, const char* Type=0)

Add a named XSIL substructure.

Returns:

Pointer to the added structure definition.

Parameters:

Name - Pointer to structure name string.
Type - Pointer to structure type string.

array* addArray(const char* Name, const char* Type=0, const char* Unit=0)

Add a named XSIL array to the XSil structure.

Returns:

Pointer to the added array definition.

Parameters:

Name - Pointer to structure name string.
Type - Pointer to structure type string.
Unit - Pointer to structure units string.

comment* addComment(const char* Text=0)

Add a comment to the XSil structure.

Returns:

Pointer to the added comment definition.

Parameters:

Text - Pointer to the comment text string.

param* addParam(const char* Name, const char* Type=0, const char* Unit=0, const char* Value=0)

Add a parameter to the XSil structure.

Returns:

Pointer to the added parameter definition.

Parameters:

Name - Pointer to parameter name string.
Type - Pointer to parameter type string.
Unit - Pointer to parameter units string.
Value - Pointer to parameter value string.

param* addParam(const char* Name, const char* Unit, double Value)

Add a double float parameter to the XSil structure.

Returns:

Pointer to the added parameter definition.

Parameters:

Name - Pointer to parameter name string.
Unit - Pointer to parameter units string.
Double - float parameter value.

param* addParam(const char* Name, const char* Unit, int Value)

Add an integer parameter to the XSil structure.

Returns:

Pointer to the added parameter definition.

Parameters:

Name - Pointer to parameter name string.
Unit - Pointer to parameter units string.
Value - Integer parameter value.

table* addTable(const char* Name, const char* Type=0)

Add a table to the XSil structure.

Returns:

Pointer to the added table definition.

Parameters:

Name - Pointer to the table name string.
Type - Pointer to the table type string.

time* addTime(const char* Name, const char* Type=0, const char* Value=0)

Add a time to the XSil structure.

Returns:

Pointer to the added time parameter definition.

Parameters:

Name - Pointer to the time name string.
Type - Pointer to the time type string.
Value - Pointer to the time value string.

time* addTime(const char* Name, const Time& t)

Add a time to the XSil structure.

Returns:

Pointer to the added time parameter definition.

Parameters:

Name - Pointer to the time name string.
time - Time value;

void erase(const xobj* x)

Remove an object from the xsil structure.

Parameters:

x - Pointer to the object to be removed from the xsil structure.

const xobj* find(const char* name, const char* type=0) const

Find an object in the xsil structure. The xsil structure is searched for an object with the specified name. An optional data type may be specified in which case, only object with the specified type will be returned.

Returns:

Pointer to the found object.

Parameters:

name - Name of the object to be found.
type - Type of the object to be found.

virtual const char* getObjType(void) const

Return the object type.

Returns:

Pointer to the object name string.

Direct child classes:

ligolw

alphabetic index hierarchy of classes

generated by doc++