CpgNetworkDeserializer

CpgNetworkDeserializer — XML to Network deserializer

Synopsis

#define             CPG_NETWORK_DESERIALIZER_CONST      (obj)
struct              CpgNetworkDeserializer;
struct              CpgNetworkDeserializerClass;
CpgNetworkDeserializer * cpg_network_deserializer_new   (CpgNetwork *network,
                                                         CpgGroup *root);
gboolean            cpg_network_deserializer_deserialize
                                                        (CpgNetworkDeserializer *deserializer,
                                                         GFile *file,
                                                         GInputStream *stream,
                                                         GError **error);
gboolean            cpg_network_deserializer_deserialize_path
                                                        (CpgNetworkDeserializer *deserializer,
                                                         const gchar *path,
                                                         GError **error);
                    CpgNetworkDeserializerPrivate;

Object Hierarchy

  GObject
   +----CpgNetworkDeserializer

Properties

  "network"                  CpgNetwork*           : Read / Write / Construct Only
  "root"                     CpgGroup*             : Read / Write / Construct Only

Description

Use this to deserialize an XML description of a network to a CpgNetwork.

Details

CPG_NETWORK_DESERIALIZER_CONST()

#define CPG_NETWORK_DESERIALIZER_CONST(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), CPG_TYPE_NETWORK_DESERIALIZER, CpgNetworkDeserializer const))


struct CpgNetworkDeserializer

struct CpgNetworkDeserializer;


struct CpgNetworkDeserializerClass

struct CpgNetworkDeserializerClass {
};


cpg_network_deserializer_new ()

CpgNetworkDeserializer * cpg_network_deserializer_new   (CpgNetwork *network,
                                                         CpgGroup *root);

Create a new deserializer for a given network. When calling cpg_network_deserializer_deserialize, objects will be deserialized into root. If root is NULL, the objects will be deserialized in the root of the network.

network :

A CpgNetwork

root :

A CpgGroup

Returns :

A CpgNetworkDeserializer

cpg_network_deserializer_deserialize ()

gboolean            cpg_network_deserializer_deserialize
                                                        (CpgNetworkDeserializer *deserializer,
                                                         GFile *file,
                                                         GInputStream *stream,
                                                         GError **error);

Deserialize a network from an input stream.

deserializer :

A CpgNetworkDeserializer

stream :

A GInputStream

error :

A GError

Returns :

TRUE if the deserialization was successful, FALSE otherwise.

cpg_network_deserializer_deserialize_path ()

gboolean            cpg_network_deserializer_deserialize_path
                                                        (CpgNetworkDeserializer *deserializer,
                                                         const gchar *path,
                                                         GError **error);

Convenience function to deserialize a network from a file path.

deserializer :

A CpgNetworkDeserializer

path :

The file path

error :

A GError

Returns :

TRUE if the deserialization was successful, FALSE otherwise

CpgNetworkDeserializerPrivate

typedef struct _CpgNetworkDeserializerPrivate CpgNetworkDeserializerPrivate;

Property Details

The "network" property

  "network"                  CpgNetwork*           : Read / Write / Construct Only

Network.


The "root" property

  "root"                     CpgGroup*             : Read / Write / Construct Only

Root.