Model Inspection

dsim_model member functions that provide object inspection. More...

Functions
const char *	dsim_model::name () const
	The name given to this object in the setup file.
const char *	dsim_model::path () const
	The full path to this object.
dsim_model *	dsim_model::parent () const
	The parent of this object; NULL if it is a top level object.
unsigned int	dsim_model::child_count () const
	The number of child objects of this object.
dsim_model *	dsim_model::child_at_index (unsigned int index) const
	Retrieve a child model by index.
dsim_model *	dsim_model::child_with_name (const char *name) const
	Retrieve a child model by name.

---

Detailed Description

dsim_model member functions that provide object inspection.

These methods provide access to information about this object. They should not be overridden; they are used by dsim_model to report on how the object is configured within a simulation.

---

Function Documentation

dsim_model * dsim_model::child_at_index

(

unsigned int

index )

const [inherited]

Retrieve a child model by index.

Parameters:

index

The index of the child to retrieve. The index values start at 0 and go to child_count()-1.

Returns:

A pointer to the child at the specified index, or NULL if the index was invalid.

unsigned int dsim_model::child_count

(

)

const [inherited]

The number of child objects of this object.

Returns:

The number of child objects of this object.

dsim_model * dsim_model::child_with_name

(

const char *

name )

const [inherited]

Retrieve a child model by name.

Parameters:

name	The name to look for within the set of children.

Returns:

A pointer to the child with the specified name, or NULL if no child could be found with the provided name.

const char * dsim_model::name

(

)

const [inherited]

The name given to this object in the setup file.

Returns:

The name of the object.

dsim_model * dsim_model::parent

(

)

const [inherited]

The parent of this object; NULL if it is a top level object.

Returns:

A pointer to this object's parent object, or NULL if this object is a top-level object with no parent.

const char * dsim_model::path

(

)

const [inherited]

The full path to this object.

Returns:

The path to the object within the simulation object hierarchy.