oaViaDefArrayValue Class Reference

Inheritance diagram for oaViaDefArrayValue:

oaValue oaObject


Public Methods

void get (oaViaDefArray &value) const
void getNames (oaViaDefNameArray &names) const
void set (const oaViaDefArray &value)

Static Public Methods

oaViaDefArrayValue * create (oaObject *database, const oaViaDefArray &value)
oaViaDefArrayValue * create (oaObject *database, oaViaDefArray &value)

Detailed Description

The oaViaDefArrayValue represents a value object that contains an array of viaDefs.

See oaValue for a discussion of the usage of all of the oaValue subclasses.


Member Function Documentation

oaViaDefArrayValue * oaViaDefArrayValue::create oaObject *    database,
oaViaDefArray &    value
[static]
 

This function is deprecated and is retained to ensure compatibility with previous versions of OpenAccess. Use the create function overload that takes a const oaViaDefArray reference instead.

This function creates a viaDef array value in the database specified.

Parameters:
database The database in which to create the value
value The viaDef array
Exceptions:
oacInvalidDatabase 
oacInvalidObjForValue 
oacEmptyArrayValue 
oacViaDefNotInReferencedTech 
oacConflictingViaDefNamesInTech 

oaViaDefArrayValue * oaViaDefArrayValue::create oaObject *    database,
const oaViaDefArray &    value
[static]
 

This function creates an ViaDef array value in the specified database.

Parameters:
database The database in which to create the value
value The viaDef array
Exceptions:
oacInvalidDatabase 
oacInvalidObjForValue 
oacEmptyArrayValue 
oacViaDefNotInReferencedTech 
oacConflictingViaDefNamesInTech 

void oaViaDefArrayValue::get oaViaDefArray &    value const
 

This function returns the viaDef array associated with this value.

Note: The returned value array may contain null object pointers if the associated viaDef cannot be bound, such as when it has been deleted or cannot be accessed. The names of unbound viaDefs are accessed with the oaViaDefArrayValue::getNames function.

void oaViaDefArrayValue::getNames oaViaDefNameArray &    names const
 

This function returns an array containing the names of the viaDefs associated with this value.

Parameters:
names The returned value

void oaViaDefArrayValue::set const oaViaDefArray &    value
 

This function sets the viaDef array for this value to the specified array.

Parameters:
value The viaDef array to set.


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

Return to top of page