Open CASCADE Technology 6.6.0
|
Defines resources for an "Undefined Entity" : such an Entity
is used to describe an Entity which complies with the Norm,
but of an Unknown Type : hence it is kept under a literal
form (avoiding to loose data). UndefinedContent offers a way
to store a list of Parameters, as literals or references to
other Entities
Each Interface must provide one "UndefinedEntity", which must
have same basic description as all its types of entities :
the best way would be double inheritance : on the Entity Root
of the Norm and on an general "UndefinedEntity"
While it is not possible to do so, the UndefinedEntity of each
Interface can define its own UndefinedEntity by INCLUDING
(in a field) this UndefinedContent
Hence, for that UndefinedEntity, define a Constructor which
creates this UndefinedContent, plus access methods to it
(or to its data, calling methods defined here).
Finally, the Protocols of each norm have to Create and
Recognize Unknown Entities of this norm
#include <Interface_UndefinedContent.hxx>
Public Member Functions | |
Interface_UndefinedContent () | |
Defines an empty UndefinedContent | |
Standard_Integer | NbParams () const |
Gives count of recorded parameters | |
Standard_Integer | NbLiterals () const |
Gives count of Literal Parameters | |
Standard_Boolean | ParamData (const Standard_Integer num, Interface_ParamType &ptype, Handle< Standard_Transient > &ent, Handle< TCollection_HAsciiString > &val) const |
Returns data of a Parameter : its type, and the entity if it designates en entity ("ent") or its literal value else ("str") Returned value (Boolean) : True if it is an Entity, False else | |
Interface_ParamType | ParamType (const Standard_Integer num) const |
Returns the ParamType of a Param, given its rank Error if num is not between 1 and NbParams | |
Standard_Boolean | IsParamEntity (const Standard_Integer num) const |
Returns True if a Parameter is recorded as an entity Error if num is not between 1 and NbParams | |
Handle_Standard_Transient | ParamEntity (const Standard_Integer num) const |
Returns Entity corresponding to a Param, given its rank | |
Handle_TCollection_HAsciiString | ParamValue (const Standard_Integer num) const |
Returns litteral value of a Parameter, given its rank | |
void | Reservate (const Standard_Integer nb, const Standard_Integer nblit) |
Manages reservation for parameters (internal use) (nb : total count of parameters, nblit : count of literals) | |
void | AddLiteral (const Interface_ParamType ptype, const Handle< TCollection_HAsciiString > &val) |
Adds a literal Parameter to the list | |
void | AddEntity (const Interface_ParamType ptype, const Handle< Standard_Transient > &ent) |
Adds a Parameter which references an Entity | |
void | RemoveParam (const Standard_Integer num) |
Removes a Parameter given its rank | |
void | SetLiteral (const Standard_Integer num, const Interface_ParamType ptype, const Handle< TCollection_HAsciiString > &val) |
Sets a new value for the Parameter <num>, to a literal value (if it referenced formerly an Entity, this Entity is removed) | |
void | SetEntity (const Standard_Integer num, const Interface_ParamType ptype, const Handle< Standard_Transient > &ent) |
Sets a new value for the Parameter <num>, to reference an Entity. To simply change the Entity, see the variant below | |
void | SetEntity (const Standard_Integer num, const Handle< Standard_Transient > &ent) |
Changes the Entity referenced by the Parameter <num> (with same ParamType) | |
Interface_EntityList | EntityList () const |
Returns globally the list of param entities. Note that it can be used as shared entity list for the UndefinedEntity | |
void | GetFromAnother (const Handle< Interface_UndefinedContent > &other, Interface_CopyTool &TC) |
Copies contents of undefined entities; deigned to be called by GetFromAnother method from Undefined entity of each Interface (the basic operation is the same regardless the norm) |
Interface_UndefinedContent::Interface_UndefinedContent | ( | ) |
void Interface_UndefinedContent::AddEntity | ( | const Interface_ParamType | ptype, |
const Handle< Standard_Transient > & | ent | ||
) |
void Interface_UndefinedContent::AddLiteral | ( | const Interface_ParamType | ptype, |
const Handle< TCollection_HAsciiString > & | val | ||
) |
Interface_EntityList Interface_UndefinedContent::EntityList | ( | ) | const |
void Interface_UndefinedContent::GetFromAnother | ( | const Handle< Interface_UndefinedContent > & | other, |
Interface_CopyTool & | TC | ||
) |
Standard_Boolean Interface_UndefinedContent::IsParamEntity | ( | const Standard_Integer | num | ) | const |
Standard_Integer Interface_UndefinedContent::NbLiterals | ( | ) | const |
Standard_Integer Interface_UndefinedContent::NbParams | ( | ) | const |
Standard_Boolean Interface_UndefinedContent::ParamData | ( | const Standard_Integer | num, |
Interface_ParamType & | ptype, | ||
Handle< Standard_Transient > & | ent, | ||
Handle< TCollection_HAsciiString > & | val | ||
) | const |
Handle_Standard_Transient Interface_UndefinedContent::ParamEntity | ( | const Standard_Integer | num | ) | const |
Interface_ParamType Interface_UndefinedContent::ParamType | ( | const Standard_Integer | num | ) | const |
Handle_TCollection_HAsciiString Interface_UndefinedContent::ParamValue | ( | const Standard_Integer | num | ) | const |
void Interface_UndefinedContent::RemoveParam | ( | const Standard_Integer | num | ) |
void Interface_UndefinedContent::Reservate | ( | const Standard_Integer | nb, |
const Standard_Integer | nblit | ||
) |
void Interface_UndefinedContent::SetEntity | ( | const Standard_Integer | num, |
const Handle< Standard_Transient > & | ent | ||
) |
void Interface_UndefinedContent::SetEntity | ( | const Standard_Integer | num, |
const Interface_ParamType | ptype, | ||
const Handle< Standard_Transient > & | ent | ||
) |
void Interface_UndefinedContent::SetLiteral | ( | const Standard_Integer | num, |
const Interface_ParamType | ptype, | ||
const Handle< TCollection_HAsciiString > & | val | ||
) |